winsock_event.h

Go to the documentation of this file.

/*
 * util/winsock_event.h - unbound event handling for winsock on windows
 *
 * Copyright (c) 2008, NLnet Labs. All rights reserved.
 *
 * This software is open source.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * 
 * 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.
 * 
 * Neither the name of the NLNET LABS nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE COPYRIGHT
 * HOLDER 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.
 */

 
#ifndef UTIL_WINSOCK_EVENT_H
#define UTIL_WINSOCK_EVENT_H
 
#ifdef USE_WINSOCK
 
#ifndef HAVE_EVENT_BASE_FREE
#define HAVE_EVENT_BASE_FREE
#endif
 
/* redefine the calls to different names so that there is no name
 * collision with other code that uses libevent names. (that uses libunbound)*/
#define event_init winsockevent_init
#define event_get_version winsockevent_get_version
#define event_get_method winsockevent_get_method
#define event_base_dispatch winsockevent_base_dispatch
#define event_base_loopexit winsockevent_base_loopexit
#define event_base_free winsockevent_base_free
#define event_set winsockevent_set
#define event_base_set winsockevent_base_set
#define event_add winsockevent_add
#define event_del winsockevent_del
#define signal_add winsocksignal_add
#define signal_del winsocksignal_del

#define EV_TIMEOUT      0x01
#define EV_READ         0x02
#define EV_WRITE        0x04
#define EV_SIGNAL       0x08
#define EV_PERSIST      0x10
 
/* needs our redblack tree */
#include "rbtree.h"

#define MAX_SIG 32

#define WSK_MAX_ITEMS 64

struct event_base
{
    rbtree_type* times;
    struct event** items;
    int max;
    int cap;
        struct event** signals;
    int need_to_exit;
    time_t* time_secs;
    struct timeval* time_tv;
    int tcp_stickies;
    int tcp_reinvigorated;
    WSAEVENT waitfor[WSK_MAX_ITEMS];
};

struct event {
        rbnode_type node;
        int added;

        struct event_base *ev_base;
        int ev_fd;
        short ev_events;
        struct timeval ev_timeout;

        void (*ev_callback)(int, short, void *);
        void *ev_arg;
 
    /* ----- nonpublic part, for winsock_event only ----- */
    int idx;
    WSAEVENT hEvent;
    int is_tcp;
    short old_events;
    int stick_events;

    int is_signal;
    int just_checked;
};

void *event_init(time_t* time_secs, struct timeval* time_tv);
const char *event_get_version(void);
const char *event_get_method(void);
int event_base_dispatch(struct event_base *);
int event_base_loopexit(struct event_base *, struct timeval *);
void event_base_free(struct event_base *);
void event_set(struct event *, int, short, void (*)(int, short, void *), void *);

int event_base_set(struct event_base *, struct event *);
int event_add(struct event *, struct timeval *);
int event_del(struct event *);
 
#define evtimer_add(ev, tv)             event_add(ev, tv)
#define evtimer_del(ev)                 event_del(ev)
 
/* uses different implementation. Cannot mix fd/timeouts and signals inside
 * the same struct event. create several event structs for that.  */
int signal_add(struct event *, struct timeval *);
#define signal_set(ev, x, cb, arg)      \
        event_set(ev, x, EV_SIGNAL|EV_PERSIST, cb, arg)
int signal_del(struct event *);

int mini_ev_cmp(const void* a, const void* b);

void winsock_tcp_wouldblock(struct event* ev, int eventbit);

int winsock_register_wsaevent(struct event_base* base, struct event* ev,
    WSAEVENT wsaevent, void (*cb)(int, short, void*), void* arg);

void winsock_unregister_wsaevent(struct event* ev);
 
#endif /* USE_WINSOCK */
#endif /* UTIL_WINSOCK_EVENT_H */