unbound-event.h

Go to the documentation of this file.

/*
 * unbound-event.h - unbound validating resolver public API with events
 *
 * Copyright (c) 2007, 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 _UB_UNBOUND_EVENT_H
#define _UB_UNBOUND_EVENT_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ub_ctx;
struct ub_result;
struct event_base;

#define UB_EV_TIMEOUT      0x01
#define UB_EV_READ         0x02
#define UB_EV_WRITE        0x04
#define UB_EV_SIGNAL       0x08
#define UB_EV_PERSIST      0x10

#define UB_EVENT_MAGIC     0x44d74d78
 
struct ub_event;
struct ub_event_base;
struct timeval;

struct ub_event_base_vmt {
    void (*free)(struct ub_event_base*);
    int (*dispatch)(struct ub_event_base*);
    int (*loopexit)(struct ub_event_base*, struct timeval*);
    struct ub_event* (*new_event)(struct ub_event_base*,
        int fd, short bits, void (*cb)(int, short, void*), void* arg);
    struct ub_event* (*new_signal)(struct ub_event_base*, int fd,
        void (*cb)(int, short, void*), void* arg);
    struct ub_event* (*winsock_register_wsaevent)(struct ub_event_base*,
        void* wsaevent, void (*cb)(int, short, void*), void* arg);
};

struct ub_event_base {
    unsigned long magic;
    struct ub_event_base_vmt* vmt;
};

struct ub_event_vmt {
    void (*add_bits)(struct ub_event*, short);
    void (*del_bits)(struct ub_event*, short);
    void (*set_fd)(struct ub_event*, int);
    void (*free)(struct ub_event*);
    int (*add)(struct ub_event*, struct timeval*);
    int (*del)(struct ub_event*);
    int (*add_timer)(struct ub_event*, struct ub_event_base*,
        void (*cb)(int, short, void*), void* arg, struct timeval*);
    int (*del_timer)(struct ub_event*);
    int (*add_signal)(struct ub_event*, struct timeval*);
    int (*del_signal)(struct ub_event*);
    void (*winsock_unregister_wsaevent)(struct ub_event* ev);
    void (*winsock_tcp_wouldblock)(struct ub_event*, int eventbit);
};

struct ub_event {
    unsigned long magic;
    struct ub_event_vmt* vmt;
};
 
typedef void (*ub_event_callback_type)(void*, int, void*, int, int, char*);

struct ub_ctx* ub_ctx_create_ub_event(struct ub_event_base* base);

struct ub_ctx* ub_ctx_create_event(struct event_base* base);

int ub_ctx_set_event(struct ub_ctx* ctx, struct event_base* base); 

int ub_resolve_event(struct ub_ctx* ctx, const char* name, int rrtype, 
    int rrclass, void* mydata, ub_event_callback_type callback,
    int* async_id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _UB_UNBOUND_H */