michael@0: /*
michael@0:  * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
michael@0:  *
michael@0:  * Redistribution and use in source and binary forms, with or without
michael@0:  * modification, are permitted provided that the following conditions
michael@0:  * are met:
michael@0:  * 1. Redistributions of source code must retain the above copyright
michael@0:  *    notice, this list of conditions and the following disclaimer.
michael@0:  * 2. Redistributions in binary form must reproduce the above copyright
michael@0:  *    notice, this list of conditions and the following disclaimer in the
michael@0:  *    documentation and/or other materials provided with the distribution.
michael@0:  * 3. The name of the author may not be used to endorse or promote products
michael@0:  *    derived from this software without specific prior written permission.
michael@0:  *
michael@0:  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
michael@0:  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
michael@0:  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
michael@0:  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
michael@0:  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
michael@0:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
michael@0:  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0:  */
michael@0: #ifndef _EVMAP_H_
michael@0: #define _EVMAP_H_
michael@0: 
michael@0: /** @file evmap-internal.h
michael@0:  *
michael@0:  * An event_map is a utility structure to map each fd or signal to zero or
michael@0:  * more events.  Functions to manipulate event_maps should only be used from
michael@0:  * inside libevent.  They generally need to hold the lock on the corresponding
michael@0:  * event_base.
michael@0:  **/
michael@0: 
michael@0: struct event_base;
michael@0: struct event;
michael@0: 
michael@0: /** Initialize an event_map for use.
michael@0:  */
michael@0: void evmap_io_initmap(struct event_io_map* ctx);
michael@0: void evmap_signal_initmap(struct event_signal_map* ctx);
michael@0: 
michael@0: /** Remove all entries from an event_map.
michael@0: 
michael@0: 	@param ctx the map to clear.
michael@0:  */
michael@0: void evmap_io_clear(struct event_io_map* ctx);
michael@0: void evmap_signal_clear(struct event_signal_map* ctx);
michael@0: 
michael@0: /** Add an IO event (some combination of EV_READ or EV_WRITE) to an
michael@0:     event_base's list of events on a given file descriptor, and tell the
michael@0:     underlying eventops about the fd if its state has changed.
michael@0: 
michael@0:     Requires that ev is not already added.
michael@0: 
michael@0:     @param base the event_base to operate on.
michael@0:     @param fd the file descriptor corresponding to ev.
michael@0:     @param ev the event to add.
michael@0: */
michael@0: int evmap_io_add(struct event_base *base, evutil_socket_t fd, struct event *ev);
michael@0: /** Remove an IO event (some combination of EV_READ or EV_WRITE) to an
michael@0:     event_base's list of events on a given file descriptor, and tell the
michael@0:     underlying eventops about the fd if its state has changed.
michael@0: 
michael@0:     @param base the event_base to operate on.
michael@0:     @param fd the file descriptor corresponding to ev.
michael@0:     @param ev the event to remove.
michael@0:  */
michael@0: int evmap_io_del(struct event_base *base, evutil_socket_t fd, struct event *ev);
michael@0: /** Active the set of events waiting on an event_base for a given fd.
michael@0: 
michael@0:     @param base the event_base to operate on.
michael@0:     @param fd the file descriptor that has become active.
michael@0:     @param events a bitmask of EV_READ|EV_WRITE|EV_ET.
michael@0: */
michael@0: void evmap_io_active(struct event_base *base, evutil_socket_t fd, short events);
michael@0: 
michael@0: 
michael@0: /* These functions behave in the same way as evmap_io_*, except they work on
michael@0:  * signals rather than fds.  signals use a linear map everywhere; fds use
michael@0:  * either a linear map or a hashtable. */
michael@0: int evmap_signal_add(struct event_base *base, int signum, struct event *ev);
michael@0: int evmap_signal_del(struct event_base *base, int signum, struct event *ev);
michael@0: void evmap_signal_active(struct event_base *base, evutil_socket_t signum, int ncalls);
michael@0: 
michael@0: void *evmap_io_get_fdinfo(struct event_io_map *ctx, evutil_socket_t fd);
michael@0: 
michael@0: void evmap_check_integrity(struct event_base *base);
michael@0: 
michael@0: #endif /* _EVMAP_H_ */