| Current Path : /proc/thread-self/root/proc/self/root/usr/include/varnish/waiter/ |
| Current File : //proc/thread-self/root/proc/self/root/usr/include/varnish/waiter/waiter.h |
/*-
* Copyright (c) 2006 Verdens Gang AS
* Copyright (c) 2006-2019 Varnish Software AS
* All rights reserved.
*
* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* Waiters are herders of connections: They monitor a large number of
* connections and react if data arrives, the connection is closed or
* if nothing happens for a specified timeout period.
*
* The "poll" waiter should be portable to just about anything, but it
* is not very efficient because it has to setup state on each call to
* poll(2). Almost all kernels have made better facilities for that
* reason, needless to say, each with its own NIH-controlled API:
*
* - kqueue on FreeBSD
* - epoll on Linux
* - ports on Solaris
*
* Public interfaces
*/
struct waited;
struct waiter;
enum wait_event {
WAITER_REMCLOSE,
WAITER_TIMEOUT,
WAITER_ACTION,
WAITER_CLOSE
};
typedef void waiter_handle_f(struct waited *, enum wait_event, vtim_real now);
struct waited {
unsigned magic;
#define WAITED_MAGIC 0x1743992d
int fd;
unsigned idx;
void *priv1;
uintptr_t priv2;
waiter_handle_f *func;
vtim_dur tmo;
vtim_real idle;
};
/* cache_waiter.c */
int Wait_Enter(const struct waiter *, struct waited *);
struct waiter *Waiter_New(void);
void Waiter_Destroy(struct waiter **);
const char *Waiter_GetName(void);