diff --git a/annotated.html b/annotated.html
new file mode 100644
index 0000000..29e1d10
--- /dev/null
+++ b/annotated.html
@@ -0,0 +1,95 @@
+
+
+
+libevent: Data Structures
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here are the data structures with brief descriptions:
+
+ C bufferevent An opaque type for handling buffered IO C evbuffer An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the network C evbuffer_cb_info Structure passed to an evbuffer_cb_func evbuffer callback C evbuffer_iovec Describes a single extent of memory inside an evbuffer C evbuffer_ptr Pointer to a position within an evbuffer C event Structure to represent a single event C event_base Structure to hold information and state for a Libevent dispatch loop C event_config Configuration for an event_base C evhttp_ext_method Stucture that is passed to (and modified by) the extended method callback function C evthread_condition_callbacks This structure describes the interface a threading library uses for condition variables C evthread_lock_callbacks This structure describes the interface a threading library uses for locking C evutil_addrinfo A definition of struct addrinfo for systems that lack it C evutil_monotonic_timer Structure to hold information about a monotonic timer
+
+
libevent: event2/buffer.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Functions for buffering data for network sending or receiving.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <stdarg.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+struct evbuffer An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the network. More... struct evbuffer_cb_info Structure passed to an evbuffer_cb_func evbuffer callback. More... struct evbuffer_iovec Describes a single extent of memory inside an evbuffer. More... struct evbuffer_ptr Pointer to a position within an evbuffer. More...
+EVBUF_FS_CLOSE_ON_FREE 0x01 Flag for creating evbuffer_file_segment: If this flag is set, then when the evbuffer_file_segment is freed and no longer in use by any evbuffer, the underlying fd is closed. #define EVBUF_FS_DISABLE_LOCKING 0x08 Flag for creating evbuffer_file_segment: Do not allocate a lock for this segment. More... EVBUF_FS_DISABLE_MMAP 0x02 Flag for creating evbuffer_file_segment: Disable memory-map based implementations. #define EVBUF_FS_DISABLE_SENDFILE 0x04 Flag for creating evbuffer_file_segment: Disable direct fd-to-fd implementations (sendfile). More... #define EVBUFFER_CB_ENABLED 1 If this flag is not set, then a callback is temporarily disabled, and should not be invoked. More... #define EVBUFFER_FLAG_DRAINS_TO_FD 1 If this flag is set, then we will not use evbuffer_peek() , evbuffer_remove() , evbuffer_remove_buffer() , and so on to read bytes from this buffer: we'll only take bytes out of this buffer by writing them to the network (as with evbuffer_write_atmost), by removing them without observing them (as with evbuffer_drain), or by copying them all out at once (as with evbuffer_add_buffer). More...
+typedef void(* evbuffer_cb_func ) (struct evbuffer *buffer, const struct evbuffer_cb_info *info, void *arg) Type definition for a callback that is invoked whenever data is added or removed from an evbuffer. More... evbuffer_file_segment_cleanup_cb ) (struct evbuffer_file_segment const *seg, int flags, void *arg) A cleanup function for a evbuffer_file_segment added to an evbuffer for reference. typedef void(* evbuffer_ref_cleanup_cb ) (const void *data, size_t datalen, void *extra) A cleanup function for a piece of memory added to an evbuffer by reference. More...
+EVENT2_EXPORT_SYMBOL int evbuffer_add (struct evbuffer *buf, const void *data, size_t datlen) Append data to the end of an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer (struct evbuffer *outbuf, struct evbuffer *inbuf) Move all data from one evbuffer into another evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer_reference (struct evbuffer *outbuf, struct evbuffer *inbuf) Copy data from one evbuffer into another evbuffer. More... EVENT2_EXPORT_SYMBOL struct evbuffer_cb_entry * evbuffer_add_cb (struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg) Add a new callback to an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_file (struct evbuffer *outbuf, int fd, ev_off_t offset, ev_off_t length) Copy data from a file into the evbuffer for writing to a socket. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_file_segment (struct evbuffer *buf, struct evbuffer_file_segment *seg, ev_off_t offset, ev_off_t length) Insert some or all of an evbuffer_file_segment at the end of an evbuffer. More... EVENT2_EXPORT_SYMBOL size_t evbuffer_add_iovec (struct evbuffer *buffer, struct evbuffer_iovec *vec, int n_vec) Append data from 1 or more iovec's to an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_printf (struct evbuffer *buf, const char *fmt,...) Append a formatted string to the end of an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_reference (struct evbuffer *outbuf, const void *data, size_t datlen, evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg) Reference memory into an evbuffer without copying. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_reference_with_offset (struct evbuffer *outbuf, const void *data, size_t offset, size_t datlen, evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg) Reference memory into an evbuffer without copying. More... EVENT2_EXPORT_SYMBOL int evbuffer_add_vprintf (struct evbuffer *buf, const char *fmt, va_list ap) Append a va_list formatted string to the end of an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_cb_clear_flags (struct evbuffer *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags) Change the flags that are set for a callback on a buffer by removing some. More... EVENT2_EXPORT_SYMBOL int evbuffer_cb_set_flags (struct evbuffer *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags) Change the flags that are set for a callback on a buffer by adding more. More... EVENT2_EXPORT_SYMBOL int evbuffer_clear_flags (struct evbuffer *buf, ev_uint64_t flags) Change the flags that are set for an evbuffer by removing some. More... EVENT2_EXPORT_SYMBOL int evbuffer_commit_space (struct evbuffer *buf, struct evbuffer_iovec *vec, int n_vecs) Commits previously reserved space. More... EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout (struct evbuffer *buf, void *data_out, size_t datlen) Read data from an evbuffer, and leave the buffer unchanged. More... EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout_from (struct evbuffer *buf, const struct evbuffer_ptr *pos, void *data_out, size_t datlen) Read data from the middle of an evbuffer, and leave the buffer unchanged. More... EVENT2_EXPORT_SYMBOL int evbuffer_defer_callbacks (struct evbuffer *buffer, struct event_base *base) Force all the callbacks on an evbuffer to be run, not immediately after the evbuffer is altered, but instead from inside the event loop. More... EVENT2_EXPORT_SYMBOL int evbuffer_drain (struct evbuffer *buf, size_t len) Remove a specified number of bytes data from the beginning of an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_enable_locking (struct evbuffer *buf, void *lock) Enable locking on an evbuffer so that it can safely be used by multiple threads at the same time. More... EVENT2_EXPORT_SYMBOL int evbuffer_expand (struct evbuffer *buf, size_t datlen) Expands the available space in an evbuffer. More... EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_add_cleanup_cb (struct evbuffer_file_segment *seg, evbuffer_file_segment_cleanup_cb cb, void *arg) Add cleanup callback and argument for the callback to an evbuffer_file_segment. More... EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_free (struct evbuffer_file_segment *seg) Free an evbuffer_file_segment. More... EVENT2_EXPORT_SYMBOL struct evbuffer_file_segment * evbuffer_file_segment_new (int fd, ev_off_t offset, ev_off_t length, unsigned flags) Create and return a new evbuffer_file_segment for reading data from a file and sending it out via an evbuffer. More... EVENT2_EXPORT_SYMBOL void evbuffer_free (struct evbuffer *buf) Deallocate storage for an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_freeze (struct evbuffer *buf, int at_front) Prevent calls that modify an evbuffer from succeeding. More... EVENT2_EXPORT_SYMBOL size_t evbuffer_get_contiguous_space (const struct evbuffer *buf) Returns the number of contiguous available bytes in the first buffer chain. More... EVENT2_EXPORT_SYMBOL size_t evbuffer_get_length (const struct evbuffer *buf) Returns the total number of bytes stored in the evbuffer. More... EVENT2_EXPORT_SYMBOL size_t evbuffer_get_max_read (struct evbuffer *buf) Get maximum read buffer size. More... EVENT2_EXPORT_SYMBOL void evbuffer_lock (struct evbuffer *buf) Acquire the lock on an evbuffer. More... EVENT2_EXPORT_SYMBOL struct evbuffer * evbuffer_new (void) Allocate storage for a new evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_peek (struct evbuffer *buffer, ev_ssize_t len, struct evbuffer_ptr *start_at, struct evbuffer_iovec *vec_out, int n_vec) Function to peek at data inside an evbuffer without removing it or copying it out. More... EVENT2_EXPORT_SYMBOL int evbuffer_prepend (struct evbuffer *buf, const void *data, size_t size) Prepends data to the beginning of the evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_prepend_buffer (struct evbuffer *dst, struct evbuffer *src) Prepends all data from the src evbuffer to the beginning of the dst evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_ptr_set (struct evbuffer *buffer, struct evbuffer_ptr *ptr, size_t position, enum evbuffer_ptr_how how) Sets the search pointer in the buffer to position. More... EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_pullup (struct evbuffer *buf, ev_ssize_t size) Makes the data at the beginning of an evbuffer contiguous. More... EVENT2_EXPORT_SYMBOL int evbuffer_read (struct evbuffer *buffer, evutil_socket_t fd, int howmuch) Read from a file descriptor and store the result in an evbuffer. More... EVENT2_EXPORT_SYMBOL char * evbuffer_readln (struct evbuffer *buffer, size_t *n_read_out, enum evbuffer_eol_style eol_style) Read a single line from an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_remove (struct evbuffer *buf, void *data, size_t datlen) Read data from an evbuffer and drain the bytes read. More... EVENT2_EXPORT_SYMBOL int evbuffer_remove_buffer (struct evbuffer *src, struct evbuffer *dst, size_t datlen) Read data from an evbuffer into another evbuffer, draining the bytes from the source buffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb (struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg) Remove a callback from an evbuffer, given the function and argument used to add it. More... EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb_entry (struct evbuffer *buffer, struct evbuffer_cb_entry *ent) Remove a callback from an evbuffer, given a handle returned from evbuffer_add_cb. More... EVENT2_EXPORT_SYMBOL int evbuffer_reserve_space (struct evbuffer *buf, ev_ssize_t size, struct evbuffer_iovec *vec, int n_vec) Reserves space in the last chain or chains of an evbuffer. More... EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search (struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start) Search for a string within an evbuffer. More... EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search_eol (struct evbuffer *buffer, struct evbuffer_ptr *start, size_t *eol_len_out, enum evbuffer_eol_style eol_style) Search for an end-of-line string within an evbuffer. More... EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search_range (struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start, const struct evbuffer_ptr *end) Search for a string within part of an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_set_flags (struct evbuffer *buf, ev_uint64_t flags) Change the flags that are set for an evbuffer by adding more. More... EVENT2_EXPORT_SYMBOL int evbuffer_set_max_read (struct evbuffer *buf, size_t max) Set maximum read buffer size. More... EVENT2_EXPORT_SYMBOL int evbuffer_unfreeze (struct evbuffer *buf, int at_front) Re-enable calls that modify an evbuffer. More... EVENT2_EXPORT_SYMBOL void evbuffer_unlock (struct evbuffer *buf) Release the lock on an evbuffer. More... EVENT2_EXPORT_SYMBOL int evbuffer_write (struct evbuffer *buffer, evutil_socket_t fd) Write the contents of an evbuffer to a file descriptor. More... EVENT2_EXPORT_SYMBOL int evbuffer_write_atmost (struct evbuffer *buffer, evutil_socket_t fd, ev_ssize_t howmuch) Write some of the contents of an evbuffer to a file descriptor. More...
+
+
Functions for buffering data for network sending or receiving.
+
An evbuffer can be used for preparing data before sending it to the network or conversely for reading data from the network. Evbuffers try to avoid memory copies as much as possible. As a result, evbuffers can be used to pass data around without actually incurring the overhead of copying the data.
+
A new evbuffer can be allocated with evbuffer_new() , and can be freed with evbuffer_free() . Most users will be using evbuffers via the bufferevent interface. To access a bufferevent's evbuffers, use bufferevent_get_input() and bufferevent_get_output() .
+
There are several guidelines for using evbuffers.
+
+if you already know how much data you are going to add as a result of calling evbuffer_add() multiple times, it makes sense to use evbuffer_expand() first to make sure that enough memory is allocated before hand.
+evbuffer_add_buffer() adds the contents of one buffer to the other without incurring any unnecessary memory copies.evbuffer_add() and evbuffer_add_buffer() do not mix very well: if you use them, you will wind up with fragmented memory in your buffer.For high-performance code, you may want to avoid copying data into and out of buffers. You can skip the copy step by using evbuffer_reserve_space() /evbuffer_commit_space() when writing into a buffer, and evbuffer_peek() when reading.
+
+
In Libevent 2.0 and later, evbuffers are represented using a linked list of memory chunks, with pointers to the first and last chunk in the chain.
+
As the contents of an evbuffer can be stored in multiple different memory blocks, it cannot be accessed directly. Instead, evbuffer_pullup() can be used to force a specified number of bytes to be contiguous. This will cause memory reallocation and memory copies if the data is split across multiple blocks. It is more efficient, however, to use evbuffer_peek() if you don't require that the memory to be contiguous.
+
+
+
◆
+
+
+
+
+
+ #define EVBUF_FS_DISABLE_LOCKING 0x08
+
+
+
+
+
Flag for creating evbuffer_file_segment: Do not allocate a lock for this segment.
+
If this option is set, then neither the segment nor any evbuffer it is added to may ever be accessed from more than one thread at a time.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVBUF_FS_DISABLE_SENDFILE 0x04
+
+
+
+
+
Flag for creating evbuffer_file_segment: Disable direct fd-to-fd implementations (sendfile).
+
You might want to use this option if data needs to be taken from the evbuffer by any means other than writing it to the network: the sendfile backend is fast, but it only works for sending files directly to the network.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVBUFFER_CB_ENABLED 1
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVBUFFER_FLAG_DRAINS_TO_FD 1
+
+
+
+
+
If this flag is set, then we will not use evbuffer_peek() , evbuffer_remove() , evbuffer_remove_buffer() , and so on to read bytes from this buffer: we'll only take bytes out of this buffer by writing them to the network (as with evbuffer_write_atmost), by removing them without observing them (as with evbuffer_drain), or by copying them all out at once (as with evbuffer_add_buffer).
+
Using this option allows the implementation to use sendfile-based operations for evbuffer_add_file() ; see that function for more information.
+
This flag is on by default for bufferevents that can take advantage of it; you should never actually need to set it on a bufferevent's output buffer.
+
+
+
+
+
+
◆
+
+
+
+
+
Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.
+
An evbuffer may have one or more callbacks set at a time. The order in which they are executed is undefined.
+
A callback function may add more callbacks, or remove itself from the list of callbacks, or add or remove data from the buffer. It may not remove another callback from the list.
+
If a callback adds or removes data from the buffer or from another buffer, this can cause a recursive invocation of your callback or other callbacks. If you ask for an infinite loop, you might just get one: watch out!
+
Parameters
+
+ buffer the buffer whose size has changed info a structure describing how the buffer changed. arg a pointer to user data
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evbuffer_ref_cleanup_cb) (const void *data, size_t datalen, void *extra)
+
+
+
+
+
+
+
◆
+
+
+
+
+
Used to tell evbuffer_readln what kind of line-ending to look for.
+
+Enumerator Any sequence of CR and LF characters is acceptable as an EOL.
+Note that this style can produce ambiguous results: the sequence "CRLF" will be treated as a single EOL if it is all in the buffer at once, but if you first read a CR from the network and later read an LF from the network, it will be treated as two EOLs.
+An EOL is an LF, optionally preceded by a CR.
+This style is most useful for implementing text-based internet protocols.
+An EOL is a CR followed by an LF.
+An EOL is a LF.
+An EOL is a NUL character (that is, a single byte with value 0)
+
+
+
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add
+ (
+ struct evbuffer *
+ buf ,
+
+ const void *
+ data ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Append data to the end of an evbuffer.
+
Parameters
+
+ buf the evbuffer to be appended to data pointer to the beginning of the data buffer datlen the number of bytes to be copied from the data buffer
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer
+ (
+ struct evbuffer *
+ outbuf ,
+
+ struct evbuffer *
+ inbuf
+
+ )
+
+
+
+
+
Move all data from one evbuffer into another evbuffer.
+
This is a destructive add. The data from one buffer moves into the other buffer. However, no unnecessary memory copies occur.
+
Parameters
+
+ outbuf the output buffer inbuf the input buffer
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evbuffer_remove_buffer()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer_reference
+ (
+ struct evbuffer *
+ outbuf ,
+
+ struct evbuffer *
+ inbuf
+
+ )
+
+
+
+
+
Copy data from one evbuffer into another evbuffer.
+
This is a non-destructive add. The data from one buffer is copied into the other buffer. However, no unnecessary memory copies occur.
+
Note that buffers already containing buffer references can't be added to other buffers.
+
Parameters
+
+ outbuf the output buffer inbuf the input buffer
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer_cb_entry* evbuffer_add_cb
+ (
+ struct evbuffer *
+ buffer ,
+
+ evbuffer_cb_func cb ,
+
+ void *
+ cbarg
+
+ )
+
+
+
+
+
Add a new callback to an evbuffer.
+
Subsequent calls to evbuffer_add_cb() add new callbacks. To remove this callback, call evbuffer_remove_cb or evbuffer_remove_cb_entry.
+
Parameters
+
+ buffer the evbuffer to be monitored cb the callback function to invoke when the evbuffer is modified, or NULL to remove all callbacks. cbarg an argument to be provided to the callback function
+
+
+
Returns a handle to the callback on success, or NULL on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_file
+ (
+ struct evbuffer *
+ outbuf ,
+
+ int
+ fd ,
+
+ ev_off_t
+ offset ,
+
+ ev_off_t
+ length
+
+ )
+
+
+
+
+
Copy data from a file into the evbuffer for writing to a socket.
+
This function avoids unnecessary data copies between userland and kernel. If sendfile is available and the EVBUFFER_FLAG_DRAINS_TO_FD flag is set, it uses those functions. Otherwise, it tries to use mmap (or CreateFileMapping on Windows).
+
The function owns the resulting file descriptor and will close it when finished transferring data.
+
The results of using evbuffer_remove() or evbuffer_pullup() on evbuffers whose data was added using this function are undefined.
+
For more fine-grained control, use evbuffer_add_file_segment.
+
Parameters
+
+ outbuf the output buffer fd the file descriptor offset the offset from which to read data length how much data to read, or -1 to read as much as possible. (-1 requires that 'fd' support fstat.)
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_file_segment
+ (
+ struct evbuffer *
+ buf ,
+
+ struct evbuffer_file_segment *
+ seg ,
+
+ ev_off_t
+ offset ,
+
+ ev_off_t
+ length
+
+ )
+
+
+
+
+
Insert some or all of an evbuffer_file_segment at the end of an evbuffer.
+
Note that the offset and length parameters of this function have a different meaning from those provided to evbuffer_file_segment_new: When you create the segment, the offset is the offset within the file , and the length is the length of the segment , whereas when you add a segment to an evbuffer, the offset is within the segment and the length is the length of the _part of the segment you want to use.
+
In other words, if you have a 10 KiB file, and you create an evbuffer_file_segment for it with offset 20 and length 1000, it will refer to bytes 20..1019 inclusive. If you then pass this segment to evbuffer_add_file_segment and specify an offset of 20 and a length of 50, you will be adding bytes 40..99 inclusive.
+
Parameters
+
+ buf the evbuffer to append to seg the segment to add offset the offset within the segment to start from length the amount of data to add, or -1 to add it all.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t evbuffer_add_iovec
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct evbuffer_iovec *
+ vec ,
+
+ int
+ n_vec
+
+ )
+
+
+
+
+
Append data from 1 or more iovec's to an evbuffer.
+
Calculates the number of bytes needed for an iovec structure and guarantees all data will fit into a single chain. Can be used in lieu of functionality which calls evbuffer_add() constantly before being used to increase performance.
+
Parameters
+
+ buffer the destination buffer vec the source iovec n_vec the number of iovec structures.
+
+
+
Returns the number of bytes successfully written to the output buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_printf
+ (
+ struct evbuffer *
+ buf ,
+
+ const char *
+ fmt ,
+
+
+ ...
+
+ )
+
+
+
+
+
Append a formatted string to the end of an evbuffer.
+
The string is formated as printf.
+
Parameters
+
+ buf the evbuffer that will be appended to fmt a format string ... arguments that will be passed to printf(3)
+
+
+
Returns The number of bytes added if successful, or -1 if an error occurred.
+
See also evutil_printf(), evbuffer_add_vprintf()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_reference
+ (
+ struct evbuffer *
+ outbuf ,
+
+ const void *
+ data ,
+
+ size_t
+ datlen ,
+
+ evbuffer_ref_cleanup_cb cleanupfn ,
+
+ void *
+ cleanupfn_arg
+
+ )
+
+
+
+
+
Reference memory into an evbuffer without copying.
+
The memory needs to remain valid until all the added data has been read. This function keeps just a reference to the memory without actually incurring the overhead of a copy.
+
Parameters
+
+ outbuf the output buffer data the memory to reference datlen how memory to reference cleanupfn callback to be invoked when the memory is no longer referenced by this evbuffer. cleanupfn_arg optional argument to the cleanup callback
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_reference_with_offset
+ (
+ struct evbuffer *
+ outbuf ,
+
+ const void *
+ data ,
+
+ size_t
+ offset ,
+
+ size_t
+ datlen ,
+
+ evbuffer_ref_cleanup_cb cleanupfn ,
+
+ void *
+ cleanupfn_arg
+
+ )
+
+
+
+
+
Reference memory into an evbuffer without copying.
+
The memory needs to remain valid until all the added data has been read. This function keeps just a reference to the memory without actually incurring the overhead of a copy.
+
Parameters
+
+ outbuf the output buffer data the memory to reference offset offset inside @data datlen how memory to reference (excluding @offset) cleanupfn callback to be invoked when the memory is no longer referenced by this evbuffer. cleanupfn_arg optional argument to the cleanup callback
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_add_vprintf
+ (
+ struct evbuffer *
+ buf ,
+
+ const char *
+ fmt ,
+
+ va_list
+ ap
+
+ )
+
+
+
+
+
Append a va_list formatted string to the end of an evbuffer.
+
Parameters
+
+ buf the evbuffer that will be appended to fmt a format string ap a varargs va_list argument array that will be passed to vprintf(3)
+
+
+
Returns The number of bytes added if successful, or -1 if an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_cb_clear_flags
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct evbuffer_cb_entry *
+ cb ,
+
+ ev_uint32_t
+ flags
+
+ )
+
+
+
+
+
Change the flags that are set for a callback on a buffer by removing some.
+
Parameters
+
+ buffer the evbuffer that the callback is watching. cb the callback whose status we want to change. flags EVBUFFER_CB_ENABLED to disable the callback.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_cb_set_flags
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct evbuffer_cb_entry *
+ cb ,
+
+ ev_uint32_t
+ flags
+
+ )
+
+
+
+
+
Change the flags that are set for a callback on a buffer by adding more.
+
Parameters
+
+ buffer the evbuffer that the callback is watching. cb the callback whose status we want to change. flags EVBUFFER_CB_ENABLED to re-enable the callback.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_clear_flags
+ (
+ struct evbuffer *
+ buf ,
+
+ ev_uint64_t
+ flags
+
+ )
+
+
+
+
+
Change the flags that are set for an evbuffer by removing some.
+
Parameters
+
+ buf the evbuffer that the callback is watching. flags One or more EVBUFFER_FLAG_* options
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_commit_space
+ (
+ struct evbuffer *
+ buf ,
+
+ struct evbuffer_iovec *
+ vec ,
+
+ int
+ n_vecs
+
+ )
+
+
+
+
+
Commits previously reserved space.
+
Commits some of the space previously reserved with evbuffer_reserve_space() . It then becomes available for reading.
+
This function may return an error if the pointer in the extents do not match those returned from evbuffer_reserve_space, or if data has been added to the buffer since the space was reserved.
+
If you want to commit less data than you got reserved space for, modify the iov_len pointer of the appropriate extent to a smaller value. Note that you may have received more space than you requested if it was available!
+
Parameters
+
+ buf the evbuffer in which to reserve space. vec one or two extents returned by evbuffer_reserve_space. n_vecs the number of extents.
+
+
+
Returns 0 on success, -1 on error
+
See also evbuffer_reserve_space()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout
+ (
+ struct evbuffer *
+ buf ,
+
+ void *
+ data_out ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Read data from an evbuffer, and leave the buffer unchanged.
+
If more bytes are requested than are available in the evbuffer, we only extract as many bytes as were available.
+
Parameters
+
+ buf the evbuffer to be read from data_out the destination buffer to store the result datlen the maximum size of the destination buffer
+
+
+
Returns the number of bytes read, or -1 if we can't drain the buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout_from
+ (
+ struct evbuffer *
+ buf ,
+
+ const struct evbuffer_ptr *
+ pos ,
+
+ void *
+ data_out ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Read data from the middle of an evbuffer, and leave the buffer unchanged.
+
If more bytes are requested than are available in the evbuffer, we only extract as many bytes as were available.
+
Parameters
+
+ buf the evbuffer to be read from pos the position to start reading from data_out the destination buffer to store the result datlen the maximum size of the destination buffer
+
+
+
Returns the number of bytes read, or -1 if we can't drain the buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_defer_callbacks
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct event_base *
+ base
+
+ )
+
+
+
+
+
Force all the callbacks on an evbuffer to be run, not immediately after the evbuffer is altered, but instead from inside the event loop.
+
This can be used to serialize all the callbacks to a single thread of execution.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_drain
+ (
+ struct evbuffer *
+ buf ,
+
+ size_t
+ len
+
+ )
+
+
+
+
+
Remove a specified number of bytes data from the beginning of an evbuffer.
+
Parameters
+
+ buf the evbuffer to be drained len the number of bytes to drain from the beginning of the buffer
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_enable_locking
+ (
+ struct evbuffer *
+ buf ,
+
+ void *
+ lock
+
+ )
+
+
+
+
+
Enable locking on an evbuffer so that it can safely be used by multiple threads at the same time.
+
NOTE: when locking is enabled, the lock will be held when callbacks are invoked. This could result in deadlock if you aren't careful. Plan accordingly!
+
Parameters
+
+ buf An evbuffer to make lockable. lock A lock object, or NULL if we should allocate our own.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_expand
+ (
+ struct evbuffer *
+ buf ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Expands the available space in an evbuffer.
+
Expands the available space in the evbuffer to at least datlen, so that appending datlen additional bytes will not require any new allocations.
+
Parameters
+
+ buf the evbuffer to be expanded datlen the new minimum length requirement
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_add_cleanup_cb
+ (
+ struct evbuffer_file_segment *
+ seg ,
+
+ evbuffer_file_segment_cleanup_cb cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Add cleanup callback and argument for the callback to an evbuffer_file_segment.
+
The cleanup callback will be invoked when no more references to the evbuffer_file_segment exist.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_free
+ (
+ struct evbuffer_file_segment *
+ seg )
+
+
+
+
+
Free an evbuffer_file_segment.
+
It is safe to call this function even if the segment has been added to one or more evbuffers. The evbuffer_file_segment will not be freed until no more references to it exist.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer_file_segment* evbuffer_file_segment_new
+ (
+ int
+ fd ,
+
+ ev_off_t
+ offset ,
+
+ ev_off_t
+ length ,
+
+ unsigned
+ flags
+
+ )
+
+
+
+
+
Create and return a new evbuffer_file_segment for reading data from a file and sending it out via an evbuffer.
+
This function avoids unnecessary data copies between userland and kernel. Where available, it uses sendfile.
+
The file descriptor must not be closed so long as any evbuffer is using this segment.
+
The results of using evbuffer_remove() or evbuffer_pullup() or any other function that reads bytes from an evbuffer on any evbuffer containing the newly returned segment are undefined, unless you pass the EVBUF_FS_DISABLE_SENDFILE flag to this function.
+
Parameters
+
+ fd an open file to read from. offset an index within the file at which to start reading length how much data to read, or -1 to read as much as possible. (-1 requires that 'fd' support fstat.) flags any number of the EVBUF_FS_* flags
+
+
+
Returns a new evbuffer_file_segment, or NULL on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evbuffer_free
+ (
+ struct evbuffer *
+ buf )
+
+
+
+
+
Deallocate storage for an evbuffer.
+
Parameters
+
+ buf pointer to the evbuffer to be freed
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_freeze
+ (
+ struct evbuffer *
+ buf ,
+
+ int
+ at_front
+
+ )
+
+
+
+
+
Prevent calls that modify an evbuffer from succeeding.
+
A buffer may frozen at the front, at the back, or at both the front and the back.
+
If the front of a buffer is frozen, operations that drain data from the front of the buffer, or that prepend data to the buffer, will fail until it is unfrozen. If the back a buffer is frozen, operations that append data from the buffer will fail until it is unfrozen.
+
Parameters
+
+ buf The buffer to freeze at_front If true, we freeze the front of the buffer. If false, we freeze the back.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t evbuffer_get_contiguous_space
+ (
+ const struct evbuffer *
+ buf )
+
+
+
+
+
Returns the number of contiguous available bytes in the first buffer chain.
+
This is useful when processing data that might be split into multiple chains, or that might all be in the first chain. Calls to evbuffer_pullup() that cause reallocation and copying of data can thus be avoided.
+
Parameters
+
+ buf pointer to the evbuffer
+
+
+
Returns 0 if no data is available, otherwise the number of available bytes in the first buffer chain.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t evbuffer_get_length
+ (
+ const struct evbuffer *
+ buf )
+
+
+
+
+
Returns the total number of bytes stored in the evbuffer.
+
Parameters
+
+ buf pointer to the evbuffer
+
+
+
Returns the number of bytes stored in the evbuffer
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t evbuffer_get_max_read
+ (
+ struct evbuffer *
+ buf )
+
+
+
+
+
Get maximum read buffer size.
+
Parameters
+
+ buf pointer to the evbuffer
+
+
+
Returns current maximum buffer read
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evbuffer_lock
+ (
+ struct evbuffer *
+ buf )
+
+
+
+
+
Acquire the lock on an evbuffer.
+
Has no effect if locking was not enabled with evbuffer_enable_locking.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer * evbuffer_new
+ (
+ void
+ )
+
+
+
+
+
Allocate storage for a new evbuffer.
+
Returns a pointer to a newly allocated evbuffer struct, or NULL if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_peek
+ (
+ struct evbuffer *
+ buffer ,
+
+ ev_ssize_t
+ len ,
+
+ struct evbuffer_ptr *
+ start_at ,
+
+ struct evbuffer_iovec *
+ vec_out ,
+
+ int
+ n_vec
+
+ )
+
+
+
+
+
Function to peek at data inside an evbuffer without removing it or copying it out.
+
Pointers to the data are returned by filling the 'vec_out' array with pointers to one or more extents of data inside the buffer.
+
The total data in the extents that you get back may be more than you requested (if there is more data last extent than you asked for), or less (if you do not provide enough evbuffer_iovecs, or if the buffer does not have as much data as you asked to see).
+
Parameters
+
+ buffer the evbuffer to peek into, len the number of bytes to try to peek. If len is negative, we will try to fill as much of vec_out as we can. If len is negative and vec_out is not provided, we return the number of evbuffer_iovecs that would be needed to get all the data in the buffer. start_at an evbuffer_ptr indicating the point at which we should start looking for data. NULL means, "At the start of the
+ buffer." vec_out an array of evbuffer_iovec n_vec the length of vec_out. If 0, we only count how many extents would be necessary to point to the requested amount of data.
+
+
+
Returns The number of extents needed. This may be less than n_vec if we didn't need all the evbuffer_iovecs we were given, or more than n_vec if we would need more to return all the data that was requested.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_prepend
+ (
+ struct evbuffer *
+ buf ,
+
+ const void *
+ data ,
+
+ size_t
+ size
+
+ )
+
+
+
+
+
Prepends data to the beginning of the evbuffer.
+
Parameters
+
+ buf the evbuffer to which to prepend data data a pointer to the memory to prepend size the number of bytes to prepend
+
+
+
Returns 0 if successful, or -1 otherwise
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_prepend_buffer
+ (
+ struct evbuffer *
+ dst ,
+
+ struct evbuffer *
+ src
+
+ )
+
+
+
+
+
Prepends all data from the src evbuffer to the beginning of the dst evbuffer.
+
Parameters
+
+ dst the evbuffer to which to prepend data src the evbuffer to prepend; it will be emptied as a result
+
+
+
Returns 0 if successful, or -1 otherwise
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_ptr_set
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct evbuffer_ptr *
+ ptr ,
+
+ size_t
+ position ,
+
+ enum evbuffer_ptr_how
+ how
+
+ )
+
+
+
+
+
Sets the search pointer in the buffer to position.
+
There are two ways to use this function: you can call evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_SET) to move 'pos' to a position 'N' bytes after the start of the buffer, or evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_ADD) to move 'pos' forward by 'N' bytes.
+
If evbuffer_ptr is not initialized, this function can only be called with EVBUFFER_PTR_SET.
+
An evbuffer_ptr can represent any position from the start of the buffer to a position immediately after the end of the buffer.
+
Parameters
+
+ buffer the evbuffer to be search ptr a pointer to a struct evbuffer_ptr position the position at which to start the next search how determines how the pointer should be manipulated.
+
+
+
Returns 0 on success or -1 otherwise
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL unsigned char* evbuffer_pullup
+ (
+ struct evbuffer *
+ buf ,
+
+ ev_ssize_t
+ size
+
+ )
+
+
+
+
+
Makes the data at the beginning of an evbuffer contiguous.
+
Parameters
+
+ buf the evbuffer to make contiguous size the number of bytes to make contiguous, or -1 to make the entire buffer contiguous.
+
+
+
Returns a pointer to the contiguous memory array, or NULL if param size requested more data than is present in the buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_read
+ (
+ struct evbuffer *
+ buffer ,
+
+ evutil_socket_t fd ,
+
+ int
+ howmuch
+
+ )
+
+
+
+
+
Read from a file descriptor and store the result in an evbuffer.
+
Parameters
+
+ buffer the evbuffer to store the result fd the file descriptor to read from howmuch the number of bytes to be read. If the given number is negative or out of maximum bytes per one read, as many bytes as we can will be read.
+
+
+
Returns the number of bytes read, or -1 if an error occurred
+
See also evbuffer_write()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evbuffer_readln
+ (
+ struct evbuffer *
+ buffer ,
+
+ size_t *
+ n_read_out ,
+
+ enum evbuffer_eol_style
+ eol_style
+
+ )
+
+
+
+
+
Read a single line from an evbuffer.
+
Reads a line terminated by an EOL as determined by the evbuffer_eol_style argument. Returns a newly allocated nul-terminated string; the caller must free the returned value. The EOL is not included in the returned string.
+
Parameters
+
+ buffer the evbuffer to read from n_read_out if non-NULL, points to a size_t that is set to the number of characters in the returned string. This is useful for strings that can contain NUL characters. eol_style the style of line-ending to use.
+
+
+
Returns pointer to a single line, or NULL if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_remove
+ (
+ struct evbuffer *
+ buf ,
+
+ void *
+ data ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Read data from an evbuffer and drain the bytes read.
+
If more bytes are requested than are available in the evbuffer, we only extract as many bytes as were available.
+
Parameters
+
+ buf the evbuffer to be read from data the destination buffer to store the result datlen the maximum size of the destination buffer
+
+
+
Returns the number of bytes read, or -1 if we can't drain the buffer.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_remove_buffer
+ (
+ struct evbuffer *
+ src ,
+
+ struct evbuffer *
+ dst ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Read data from an evbuffer into another evbuffer, draining the bytes from the source buffer.
+
This function avoids copy operations to the extent possible.
+
If more bytes are requested than are available in src, the src buffer is drained completely.
+
Parameters
+
+ src the evbuffer to be read from dst the destination evbuffer to store the result into datlen the maximum numbers of bytes to transfer
+
+
+
Returns the number of bytes read
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb
+ (
+ struct evbuffer *
+ buffer ,
+
+ evbuffer_cb_func cb ,
+
+ void *
+ cbarg
+
+ )
+
+
+
+
+
Remove a callback from an evbuffer, given the function and argument used to add it.
+
Returns 0 if a callback was removed, or -1 if no matching callback was found.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb_entry
+ (
+ struct evbuffer *
+ buffer ,
+
+ struct evbuffer_cb_entry *
+ ent
+
+ )
+
+
+
+
+
Remove a callback from an evbuffer, given a handle returned from evbuffer_add_cb.
+
Calling this function invalidates the handle.
+
Returns 0 if a callback was removed, or -1 if no matching callback was found.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_reserve_space
+ (
+ struct evbuffer *
+ buf ,
+
+ ev_ssize_t
+ size ,
+
+ struct evbuffer_iovec *
+ vec ,
+
+ int
+ n_vec
+
+ )
+
+
+
+
+
Reserves space in the last chain or chains of an evbuffer.
+
Makes space available in the last chain or chains of an evbuffer that can be arbitrarily written to by a user. The space does not become available for reading until it has been committed with evbuffer_commit_space() .
+
The space is made available as one or more extents, represented by an initial pointer and a length. You can force the memory to be available as only one extent. Allowing more extents, however, makes the function more efficient.
+
Multiple subsequent calls to this function will make the same space available until evbuffer_commit_space() has been called.
+
It is an error to do anything that moves around the buffer's internal memory structures before committing the space.
+
NOTE: The code currently does not ever use more than two extents. This may change in future versions.
+
Parameters
+
+ buf the evbuffer in which to reserve space. size how much space to make available, at minimum. The total length of the extents may be greater than the requested length. vec an array of one or more evbuffer_iovec structures to hold pointers to the reserved extents of memory. n_vec The length of the vec array. Must be at least 1; 2 is more efficient.
+
+
+
Returns the number of provided extents, or -1 on error.
+
See also evbuffer_commit_space()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search
+ (
+ struct evbuffer *
+ buffer ,
+
+ const char *
+ what ,
+
+ size_t
+ len ,
+
+ const struct evbuffer_ptr *
+ start
+
+ )
+
+
+
+
+
Search for a string within an evbuffer.
+
Parameters
+
+ buffer the evbuffer to be searched what the string to be searched for len the length of the search string start NULL or a pointer to a valid struct evbuffer_ptr .
+
+
+
Returns a struct evbuffer_ptr whose 'pos' field has the offset of the first occurrence of the string in the buffer after 'start'. The 'pos' field of the result is -1 if the string was not found.
+
+
+
+
+
◆
+
+
+
+
+
Search for an end-of-line string within an evbuffer.
+
Parameters
+
+ buffer the evbuffer to be searched start NULL or a pointer to a valid struct evbuffer_ptr to start searching at. eol_len_out If non-NULL, the pointed-to value will be set to the length of the end-of-line string. eol_style The kind of EOL to look for; see evbuffer_readln() for more information
+
+
+
Returns a struct evbuffer_ptr whose 'pos' field has the offset of the first occurrence EOL in the buffer after 'start'. The 'pos' field of the result is -1 if the string was not found.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search_range
+ (
+ struct evbuffer *
+ buffer ,
+
+ const char *
+ what ,
+
+ size_t
+ len ,
+
+ const struct evbuffer_ptr *
+ start ,
+
+ const struct evbuffer_ptr *
+ end
+
+ )
+
+
+
+
+
Search for a string within part of an evbuffer.
+
Parameters
+
+ buffer the evbuffer to be searched what the string to be searched for len the length of the search string start NULL or a pointer to a valid struct evbuffer_ptr that indicates where we should start searching. end NULL or a pointer to a valid struct evbuffer_ptr that indicates where we should stop searching.
+
+
+
Returns a struct evbuffer_ptr whose 'pos' field has the offset of the first occurrence of the string in the buffer after 'start'. The 'pos' field of the result is -1 if the string was not found.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_set_flags
+ (
+ struct evbuffer *
+ buf ,
+
+ ev_uint64_t
+ flags
+
+ )
+
+
+
+
+
Change the flags that are set for an evbuffer by adding more.
+
Parameters
+
+ buf the evbuffer that the callback is watching. flags One or more EVBUFFER_FLAG_* options
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_set_max_read
+ (
+ struct evbuffer *
+ buf ,
+
+ size_t
+ max
+
+ )
+
+
+
+
+
Set maximum read buffer size.
+
Default is 4096 and it works fine most of time, so before increasing the default check carefully, since this has some negative effects (like memory fragmentation and unfair resource distribution, i.e. some events will make less progress than others).
+
Parameters
+
+ buf pointer to the evbuffer max buffer size
+
+
+
Returns 0 on success, -1 on failure (if max > INT_MAX).
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_unfreeze
+ (
+ struct evbuffer *
+ buf ,
+
+ int
+ at_front
+
+ )
+
+
+
+
+
Re-enable calls that modify an evbuffer.
+
Parameters
+
+ buf The buffer to un-freeze at_front If true, we unfreeze the front of the buffer. If false, we unfreeze the back.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evbuffer_unlock
+ (
+ struct evbuffer *
+ buf )
+
+
+
+
+
Release the lock on an evbuffer.
+
Has no effect if locking was not enabled with evbuffer_enable_locking.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_write
+ (
+ struct evbuffer *
+ buffer ,
+
+ evutil_socket_t fd
+
+ )
+
+
+
+
+
Write the contents of an evbuffer to a file descriptor.
+
The evbuffer will be drained after the bytes have been successfully written.
+
Parameters
+
+ buffer the evbuffer to be written and drained fd the file descriptor to be written to
+
+
+
Returns the number of bytes written, or -1 if an error occurred
+
See also evbuffer_read()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_write_atmost
+ (
+ struct evbuffer *
+ buffer ,
+
+ evutil_socket_t fd ,
+
+ ev_ssize_t
+ howmuch
+
+ )
+
+
+
+
+
Write some of the contents of an evbuffer to a file descriptor.
+
The evbuffer will be drained after the bytes have been successfully written.
+
Parameters
+
+ buffer the evbuffer to be written and drained fd the file descriptor to be written to howmuch the largest allowable number of bytes to write, or -1 to write as many bytes as we can.
+
+
+
Returns the number of bytes written, or -1 if an error occurred
+
See also evbuffer_read()
+
+
+
+
libevent: event2/buffer.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #ifndef EVENT2_BUFFER_H_INCLUDED_
+
27 #define EVENT2_BUFFER_H_INCLUDED_
+
+
75 #include <event2/visibility.h>
+
+
+
+
+
+
81 #include <event2/event-config.h>
+
+
83 #ifdef EVENT__HAVE_SYS_TYPES_H
+
84 #include <sys/types.h>
+
+
86 #ifdef EVENT__HAVE_SYS_UIO_H
+
+
+
+
+
+
98 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
132 #ifdef EVENT__HAVE_SYS_UIO_H
+
133 #define evbuffer_iovec iovec
+
+
135 #define EVBUFFER_IOVEC_IS_NATIVE_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
230 #define EVBUFFER_FLAG_DRAINS_TO_FD 1
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
506 size_t datalen,
void *extra);
+
+
+
+
525 const void *data,
size_t datlen,
+
+
+
+
+
+
+
548 void *cleanupfn_arg);
+
+
+
+
+
+
585 struct evbuffer_file_segment;
+
+
592 #define EVBUF_FS_CLOSE_ON_FREE 0x01
+
+
597 #define EVBUF_FS_DISABLE_MMAP 0x02
+
+
607 #define EVBUF_FS_DISABLE_SENDFILE 0x04
+
+
614 #define EVBUF_FS_DISABLE_LOCKING 0x08
+
+
+
621 struct evbuffer_file_segment const* seg,
int flags,
void * arg);
+
+
+
+
647 int fd, ev_off_t offset, ev_off_t length,
unsigned flags);
+
+
+
+
+
+
+
+
+
+
+
694 struct evbuffer_file_segment *seg, ev_off_t offset, ev_off_t length);
+
+
+
+
+
711 __attribute__((format(printf, 2, 3)))
+
+
+
+
+
+
+
726 __attribute__((format(printf, 2, 0)))
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
941 struct evbuffer_cb_entry;
+
+
+
+
+
+
966 struct evbuffer_cb_entry *ent);
+
+
+
+
+
982 #define EVBUFFER_CB_ENABLED 1
+
+
+
+
993 struct evbuffer_cb_entry *cb, ev_uint32_t flags);
+
+
1002 EVENT2_EXPORT_SYMBOL
+
+
1004 struct evbuffer_cb_entry *cb, ev_uint32_t flags);
+
+
+
+
1016 EVENT2_EXPORT_SYMBOL
+
1017 void evbuffer_cb_suspend(
struct evbuffer *buffer,
struct evbuffer_cb_entry *cb);
+
1026 EVENT2_EXPORT_SYMBOL
+
1027 void evbuffer_cb_unsuspend(
struct evbuffer *buffer,
struct evbuffer_cb_entry *cb);
+
+
+
1040 EVENT2_EXPORT_SYMBOL
+
+
+
1052 EVENT2_EXPORT_SYMBOL
+
+
+
1063 EVENT2_EXPORT_SYMBOL
+
+
+
1080 EVENT2_EXPORT_SYMBOL
+
+
1090 EVENT2_EXPORT_SYMBOL
+
+
+
+
1101 EVENT2_EXPORT_SYMBOL
+
+
+
1117 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evbuffer_enable_locking(struct evbuffer *buf, void *lock)
Enable locking on an evbuffer so that it can safely be used by multiple threads at the same time.
EVENT2_EXPORT_SYMBOL size_t evbuffer_get_length(const struct evbuffer *buf)
Returns the total number of bytes stored in the evbuffer.
@ EVBUFFER_PTR_ADD
Advances the pointer by adding to the current position.
Definition: buffer.h:824
EVENT2_EXPORT_SYMBOL int evbuffer_remove(struct evbuffer *buf, void *data, size_t datlen)
Read data from an evbuffer and drain the bytes read.
EVENT2_EXPORT_SYMBOL int evbuffer_add_file(struct evbuffer *outbuf, int fd, ev_off_t offset, ev_off_t length)
Copy data from a file into the evbuffer for writing to a socket.
EVENT2_EXPORT_SYMBOL int evbuffer_add_reference_with_offset(struct evbuffer *outbuf, const void *data, size_t offset, size_t datlen, evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg)
Reference memory into an evbuffer without copying.
EVENT2_EXPORT_SYMBOL size_t evbuffer_get_contiguous_space(const struct evbuffer *buf)
Returns the number of contiguous available bytes in the first buffer chain.
Structure passed to an evbuffer_cb_func evbuffer callback.
Definition: buffer.h:910
EVENT2_EXPORT_SYMBOL int evbuffer_add(struct evbuffer *buf, const void *data, size_t datlen)
Append data to the end of an evbuffer.
@ EVBUFFER_EOL_CRLF
An EOL is an LF, optionally preceded by a CR.
Definition: buffer.h:436
void * iov_base
The start of the extent of memory.
Definition: buffer.h:139
EVENT2_EXPORT_SYMBOL size_t evbuffer_add_iovec(struct evbuffer *buffer, struct evbuffer_iovec *vec, int n_vec)
Append data from 1 or more iovec's to an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_unfreeze(struct evbuffer *buf, int at_front)
Re-enable calls that modify an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_set_flags(struct evbuffer *buf, ev_uint64_t flags)
Change the flags that are set for an evbuffer by adding more.
EVENT2_EXPORT_SYMBOL int evbuffer_peek(struct evbuffer *buffer, ev_ssize_t len, struct evbuffer_ptr *start_at, struct evbuffer_iovec *vec_out, int n_vec)
Function to peek at data inside an evbuffer without removing it or copying it out.
EVENT2_EXPORT_SYMBOL int evbuffer_set_max_read(struct evbuffer *buf, size_t max)
Set maximum read buffer size.
evbuffer_eol_style
Used to tell evbuffer_readln what kind of line-ending to look for.
Definition: buffer.h:423
@ EVBUFFER_EOL_NUL
An EOL is a NUL character (that is, a single byte with value 0)
Definition: buffer.h:442
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL void evbuffer_lock(struct evbuffer *buf)
Acquire the lock on an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_add_vprintf(struct evbuffer *buf, const char *fmt, va_list ap)
Append a va_list formatted string to the end of an evbuffer.
EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size)
Makes the data at the beginning of an evbuffer contiguous.
@ EVBUFFER_EOL_CRLF_STRICT
An EOL is a CR followed by an LF.
Definition: buffer.h:438
EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start)
Search for a string within an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_defer_callbacks(struct evbuffer *buffer, struct event_base *base)
Force all the callbacks on an evbuffer to be run, not immediately after the evbuffer is altered,...
EVENT2_EXPORT_SYMBOL int evbuffer_prepend(struct evbuffer *buf, const void *data, size_t size)
Prepends data to the beginning of the evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_read(struct evbuffer *buffer, evutil_socket_t fd, int howmuch)
Read from a file descriptor and store the result in an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_write_atmost(struct evbuffer *buffer, evutil_socket_t fd, ev_ssize_t howmuch)
Write some of the contents of an evbuffer to a file descriptor.
void(* evbuffer_ref_cleanup_cb)(const void *data, size_t datalen, void *extra)
A cleanup function for a piece of memory added to an evbuffer by reference.
Definition: buffer.h:505
EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout_from(struct evbuffer *buf, const struct evbuffer_ptr *pos, void *data_out, size_t datlen)
Read data from the middle of an evbuffer, and leave the buffer unchanged.
Describes a single extent of memory inside an evbuffer.
Definition: buffer.h:137
EVENT2_EXPORT_SYMBOL int evbuffer_drain(struct evbuffer *buf, size_t len)
Remove a specified number of bytes data from the beginning of an evbuffer.
Pointer to a position within an evbuffer.
Definition: buffer.h:116
EVENT2_EXPORT_SYMBOL int evbuffer_prepend_buffer(struct evbuffer *dst, struct evbuffer *src)
Prepends all data from the src evbuffer to the beginning of the dst evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb_entry(struct evbuffer *buffer, struct evbuffer_cb_entry *ent)
Remove a callback from an evbuffer, given a handle returned from evbuffer_add_cb.
EVENT2_EXPORT_SYMBOL int evbuffer_ptr_set(struct evbuffer *buffer, struct evbuffer_ptr *ptr, size_t position, enum evbuffer_ptr_how how)
Sets the search pointer in the buffer to position.
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
void(* evbuffer_cb_func)(struct evbuffer *buffer, const struct evbuffer_cb_info *info, void *arg)
Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.
Definition: buffer.h:939
EVENT2_EXPORT_SYMBOL int evbuffer_freeze(struct evbuffer *buf, int at_front)
Prevent calls that modify an evbuffer from succeeding.
EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search_eol(struct evbuffer *buffer, struct evbuffer_ptr *start, size_t *eol_len_out, enum evbuffer_eol_style eol_style)
Search for an end-of-line string within an evbuffer.
EVENT2_EXPORT_SYMBOL struct evbuffer_cb_entry * evbuffer_add_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg)
Add a new callback to an evbuffer.
EVENT2_EXPORT_SYMBOL struct evbuffer_file_segment * evbuffer_file_segment_new(int fd, ev_off_t offset, ev_off_t length, unsigned flags)
Create and return a new evbuffer_file_segment for reading data from a file and sending it out via an ...
EVENT2_EXPORT_SYMBOL char * evbuffer_readln(struct evbuffer *buffer, size_t *n_read_out, enum evbuffer_eol_style eol_style)
Read a single line from an evbuffer.
EVENT2_EXPORT_SYMBOL void evbuffer_unlock(struct evbuffer *buf)
Release the lock on an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_cb_set_flags(struct evbuffer *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags)
Change the flags that are set for a callback on a buffer by adding more.
size_t n_deleted
The number of bytes removed since callbacks were last invoked.
Definition: buffer.h:917
EVENT2_EXPORT_SYMBOL int evbuffer_clear_flags(struct evbuffer *buf, ev_uint64_t flags)
Change the flags that are set for an evbuffer by removing some.
evbuffer_ptr_how
Defines how to adjust an evbuffer_ptr by evbuffer_ptr_set()
Definition: buffer.h:819
size_t n_added
The number of bytes added since callbacks were last invoked.
Definition: buffer.h:915
EVENT2_EXPORT_SYMBOL int evbuffer_add_reference(struct evbuffer *outbuf, const void *data, size_t datlen, evbuffer_ref_cleanup_cb cleanupfn, void *cleanupfn_arg)
Reference memory into an evbuffer without copying.
EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf)
Move all data from one evbuffer into another evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_add_file_segment(struct evbuffer *buf, struct evbuffer_file_segment *seg, ev_off_t offset, ev_off_t length)
Insert some or all of an evbuffer_file_segment at the end of an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_add_printf(struct evbuffer *buf, const char *fmt,...)
Append a formatted string to the end of an evbuffer.
@ EVBUFFER_EOL_LF
An EOL is a LF.
Definition: buffer.h:440
EVENT2_EXPORT_SYMBOL int evbuffer_commit_space(struct evbuffer *buf, struct evbuffer_iovec *vec, int n_vecs)
Commits previously reserved space.
EVENT2_EXPORT_SYMBOL int evbuffer_write(struct evbuffer *buffer, evutil_socket_t fd)
Write the contents of an evbuffer to a file descriptor.
EVENT2_EXPORT_SYMBOL int evbuffer_remove_buffer(struct evbuffer *src, struct evbuffer *dst, size_t datlen)
Read data from an evbuffer into another evbuffer, draining the bytes from the source buffer.
EVENT2_EXPORT_SYMBOL struct evbuffer_ptr evbuffer_search_range(struct evbuffer *buffer, const char *what, size_t len, const struct evbuffer_ptr *start, const struct evbuffer_ptr *end)
Search for a string within part of an evbuffer.
EVENT2_EXPORT_SYMBOL void evbuffer_free(struct evbuffer *buf)
Deallocate storage for an evbuffer.
void(* evbuffer_file_segment_cleanup_cb)(struct evbuffer_file_segment const *seg, int flags, void *arg)
A cleanup function for a evbuffer_file_segment added to an evbuffer for reference.
Definition: buffer.h:620
@ EVBUFFER_EOL_ANY
Any sequence of CR and LF characters is acceptable as an EOL.
Definition: buffer.h:433
size_t orig_size
The number of bytes in this evbuffer when callbacks were last invoked.
Definition: buffer.h:913
EVENT2_EXPORT_SYMBOL int evbuffer_reserve_space(struct evbuffer *buf, ev_ssize_t size, struct evbuffer_iovec *vec, int n_vec)
Reserves space in the last chain or chains of an evbuffer.
@ EVBUFFER_PTR_SET
Sets the pointer to the position; can be called on with an uninitialized evbuffer_ptr.
Definition: buffer.h:822
size_t iov_len
The length of the extent of memory.
Definition: buffer.h:141
EVENT2_EXPORT_SYMBOL int evbuffer_add_buffer_reference(struct evbuffer *outbuf, struct evbuffer *inbuf)
Copy data from one evbuffer into another evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_remove_cb(struct evbuffer *buffer, evbuffer_cb_func cb, void *cbarg)
Remove a callback from an evbuffer, given the function and argument used to add it.
EVENT2_EXPORT_SYMBOL struct evbuffer * evbuffer_new(void)
Allocate storage for a new evbuffer.
EVENT2_EXPORT_SYMBOL size_t evbuffer_get_max_read(struct evbuffer *buf)
Get maximum read buffer size.
EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_free(struct evbuffer_file_segment *seg)
Free an evbuffer_file_segment.
Common convenience functions for cross-platform portability and related socket manipulations.
EVENT2_EXPORT_SYMBOL ev_ssize_t evbuffer_copyout(struct evbuffer *buf, void *data_out, size_t datlen)
Read data from an evbuffer, and leave the buffer unchanged.
EVENT2_EXPORT_SYMBOL void evbuffer_file_segment_add_cleanup_cb(struct evbuffer_file_segment *seg, evbuffer_file_segment_cleanup_cb cb, void *arg)
Add cleanup callback and argument for the callback to an evbuffer_file_segment.
EVENT2_EXPORT_SYMBOL int evbuffer_expand(struct evbuffer *buf, size_t datlen)
Expands the available space in an evbuffer.
EVENT2_EXPORT_SYMBOL int evbuffer_cb_clear_flags(struct evbuffer *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags)
Change the flags that are set for a callback on a buffer by removing some.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: event2/buffer_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Obsolete and deprecated versions of the functions in buffer.h : provided only for backward compatibility.
+More...
+
#include <event2/visibility.h>
+
Go to the source code of this file.
+
+typedef void(* evbuffer_cb ) (struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg) Type definition for a callback that is invoked whenever data is added or removed from an evbuffer. More...
+EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_find (struct evbuffer *buffer, const unsigned char *what, size_t len) Find a string within an evbuffer. More... EVENT2_EXPORT_SYMBOL char * evbuffer_readline (struct evbuffer *buffer) Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY). More... EVENT2_EXPORT_SYMBOL int evbuffer_setcb (struct evbuffer *buffer, evbuffer_cb cb, void *cbarg) Replace all callbacks on an evbuffer with a single new callback, or remove them. More...
+
+
Obsolete and deprecated versions of the functions in buffer.h : provided only for backward compatibility.
+
+
+
◆
+
+
+
+
+
+ typedef void(* evbuffer_cb) (struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg)
+
+
+
+
+
Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.
+
An evbuffer may have one or more callbacks set at a time. The order in which they are executed is undefined.
+
A callback function may add more callbacks, or remove itself from the list of callbacks, or add or remove data from the buffer. It may not remove another callback from the list.
+
If a callback adds or removes data from the buffer or from another buffer, this can cause a recursive invocation of your callback or other callbacks. If you ask for an infinite loop, you might just get one: watch out!
+
Parameters
+
+ buffer the buffer whose size has changed old_len the previous length of the buffer new_len the current length of the buffer arg a pointer to user data
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL unsigned char* evbuffer_find
+ (
+ struct evbuffer *
+ buffer ,
+
+ const unsigned char *
+ what ,
+
+ size_t
+ len
+
+ )
+
+
+
+
+
Find a string within an evbuffer.
+
Parameters
+
+ buffer the evbuffer to be searched what the string to be searched for len the length of the search string
+
+
+
Returns a pointer to the beginning of the search string, or NULL if the search failed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evbuffer_readline
+ (
+ struct evbuffer *
+ buffer )
+
+
+
+
+
Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY).
+
Deprecated: This function is deprecated because its behavior is not correct for almost any protocol, and also because it's wholly subsumed by evbuffer_readln() .
+
Parameters
+
+ buffer the evbuffer to read from
+
+
+
Returns pointer to a single line, or NULL if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evbuffer_setcb
+ (
+ struct evbuffer *
+ buffer ,
+
+ evbuffer_cb cb ,
+
+ void *
+ cbarg
+
+ )
+
+
+
+
+
Replace all callbacks on an evbuffer with a single new callback, or remove them.
+
Subsequent calls to evbuffer_setcb() replace callbacks set by previous calls. Setting the callback to NULL removes any previously set callback.
+
Deprecated: This function is deprecated because it clears all previous callbacks set on the evbuffer, which can cause confusing behavior if multiple parts of the code all want to add their own callbacks on a buffer. Instead, use evbuffer_add() , evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others.
+
Parameters
+
+ buffer the evbuffer to be monitored cb the callback function to invoke when the evbuffer is modified, or NULL to remove all callbacks. cbarg an argument to be provided to the callback function
+
+
+
Returns 0 if successful, or -1 on error
+
+
+
+
libevent: event2/buffer_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_BUFFER_COMPAT_H_INCLUDED_
+
28 #define EVENT2_BUFFER_COMPAT_H_INCLUDED_
+
+
30 #include <event2/visibility.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
111 #define EVBUFFER_LENGTH(x) evbuffer_get_length(x)
+
+
113 #define EVBUFFER_DATA(x) evbuffer_pullup((x), -1)
+
+
+
+
EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_find(struct evbuffer *buffer, const unsigned char *what, size_t len)
Find a string within an evbuffer.
void(* evbuffer_cb)(struct evbuffer *buffer, size_t old_len, size_t new_len, void *arg)
Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.
Definition: buffer_compat.h:73
EVENT2_EXPORT_SYMBOL int evbuffer_setcb(struct evbuffer *buffer, evbuffer_cb cb, void *cbarg)
Replace all callbacks on an evbuffer with a single new callback, or remove them.
EVENT2_EXPORT_SYMBOL char * evbuffer_readline(struct evbuffer *buffer)
Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY).
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
libevent: event2/bufferevent.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Functions for buffering data for network sending or receiving.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+EVENT2_EXPORT_SYMBOL int bufferevent_add_to_rate_limit_group (struct bufferevent *bev, struct bufferevent_rate_limit_group *g) Add 'bev' to the list of bufferevents whose aggregate reading and writing is restricted by 'g'. More... EVENT2_EXPORT_SYMBOL int bufferevent_base_set (struct event_base *base, struct bufferevent *bufev) Assign a bufferevent to a specific event_base . More... EVENT2_EXPORT_SYMBOL int bufferevent_decref (struct bufferevent *bufev) Public interface to manually decrement the reference count of a bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_disable (struct bufferevent *bufev, short event ) Disable a bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_enable (struct bufferevent *bufev, short event ) Enable a bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_flush (struct bufferevent *bufev, short iotype, enum bufferevent_flush_mode mode) Triggers the bufferevent to produce more data if possible. More... EVENT2_EXPORT_SYMBOL void bufferevent_free (struct bufferevent *bufev) Deallocate the storage associated with a bufferevent structure. More... event_base * bufferevent_get_base (struct bufferevent *bev) Return the event_base used by a bufferevent. EVENT2_EXPORT_SYMBOL short bufferevent_get_enabled (struct bufferevent *bufev) Return the events that are enabled on a given bufferevent. More... EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_input (struct bufferevent *bufev) Returns the input buffer. More... bufferevent_get_max_single_read (struct bufferevent *bev) Get the current size limit for single read operation. bufferevent_get_max_single_write (struct bufferevent *bev) Get the current size limit for single write operation. EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_output (struct bufferevent *bufev) Returns the output buffer. More... EVENT2_EXPORT_SYMBOL int bufferevent_get_priority (const struct bufferevent *bufev) Return the priority of a bufferevent. More... bufferevent * bufferevent_get_underlying (struct bufferevent *bufev) Returns the underlying bufferevent associated with a bufferevent (if the bufferevent is a wrapper), or NULL if there is no underlying bufferevent. EVENT2_EXPORT_SYMBOL void bufferevent_getcb (struct bufferevent *bufev, bufferevent_data_cb *readcb_ptr, bufferevent_data_cb *writecb_ptr, bufferevent_event_cb *eventcb_ptr, void **cbarg_ptr) Retrieves the callbacks for a bufferevent. More... evutil_socket_t bufferevent_getfd (struct bufferevent *bufev) Returns the file descriptor associated with a bufferevent, or -1 if no file descriptor is associated with the bufferevent. EVENT2_EXPORT_SYMBOL int bufferevent_getwatermark (struct bufferevent *bufev, short events, size_t *lowmark, size_t *highmark) Retrieves the watermarks for read or write events. More... EVENT2_EXPORT_SYMBOL void bufferevent_incref (struct bufferevent *bufev) Public interface to manually increase the reference count of a bufferevent this is useful in situations where a user may reference the bufferevent somewhere else (unknown to libevent) More... EVENT2_EXPORT_SYMBOL void bufferevent_lock (struct bufferevent *bufev) Acquire the lock on a bufferevent. More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_pair_get_partner (struct bufferevent *bev) Given one bufferevent returned by bufferevent_pair_new() , returns the other one if it still exists. More... EVENT2_EXPORT_SYMBOL int bufferevent_pair_new (struct event_base *base, int options, struct bufferevent *pair[2]) Allocate a pair of linked bufferevents. More... EVENT2_EXPORT_SYMBOL int bufferevent_priority_set (struct bufferevent *bufev, int pri) Assign a priority to a bufferevent. More... EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_free (struct bufferevent_rate_limit_group *) Free a rate-limiting group. More... EVENT2_EXPORT_SYMBOL struct bufferevent_rate_limit_group * bufferevent_rate_limit_group_new (struct event_base *base, const struct ev_token_bucket_cfg *cfg) Create a new rate-limit group for bufferevents. More... EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_cfg (struct bufferevent_rate_limit_group *, const struct ev_token_bucket_cfg *) Change the rate-limiting settings for a given rate-limiting group. More... EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_min_share (struct bufferevent_rate_limit_group *, size_t) Change the smallest quantum we're willing to allocate to any single bufferevent in a group for reading or writing at a time. More... EVENT2_EXPORT_SYMBOL size_t bufferevent_read (struct bufferevent *bufev, void *data, size_t size) Read data from a bufferevent buffer. More... EVENT2_EXPORT_SYMBOL int bufferevent_read_buffer (struct bufferevent *bufev, struct evbuffer *buf) Read data from a bufferevent buffer into an evbuffer. More... bufferevent_remove_from_rate_limit_group (struct bufferevent *bev) Remove 'bev' from its current rate-limit group (if any). EVENT2_EXPORT_SYMBOL int bufferevent_replacefd (struct bufferevent *bufev, evutil_socket_t fd) Replaces the file descriptor on which the bufferevent operates. More... EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_read (struct bufferevent *bev, size_t size) Set the size limit for single read operation. More... EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_write (struct bufferevent *bev, size_t size) Set the size limit for single write operation. More... EVENT2_EXPORT_SYMBOL int bufferevent_set_rate_limit (struct bufferevent *bev, struct ev_token_bucket_cfg *cfg) Set the rate-limit of a the bufferevent 'bev' to the one specified in 'cfg'. More... EVENT2_EXPORT_SYMBOL int bufferevent_set_timeouts (struct bufferevent *bufev, const struct timeval *timeout_read, const struct timeval *timeout_write) Set the read and write timeout for a bufferevent. More... EVENT2_EXPORT_SYMBOL void bufferevent_setcb (struct bufferevent *bufev, bufferevent_data_cb readcb, bufferevent_data_cb writecb, bufferevent_event_cb eventcb, void *cbarg) Changes the callbacks for a bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_setfd (struct bufferevent *bufev, evutil_socket_t fd) Changes the file descriptor on which the bufferevent operates. More... EVENT2_EXPORT_SYMBOL void bufferevent_setwatermark (struct bufferevent *bufev, short events, size_t lowmark, size_t highmark) Sets the watermarks for read and write events. More... EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect (struct bufferevent *bufev, const struct sockaddr *addr, int socklen) Launch a connect() attempt with a socket-based bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname (struct bufferevent *bufev, struct evdns_base *evdns_base, int family, const char *hostname, int port) Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect() . More... EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname_hints (struct bufferevent *bufev, struct evdns_base *evdns_base, const struct evutil_addrinfo *hints_in, const char *hostname, int port) Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect() . More... EVENT2_EXPORT_SYMBOL int bufferevent_socket_get_dns_error (struct bufferevent *bev) Return the error code for the last failed DNS lookup attempt made by bufferevent_socket_connect_hostname() . More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_socket_new (struct event_base *base, evutil_socket_t fd, int options) Create a new socket bufferevent over an existing socket. More... EVENT2_EXPORT_SYMBOL void bufferevent_trigger (struct bufferevent *bufev, short iotype, int options) Triggers bufferevent data callbacks. More... EVENT2_EXPORT_SYMBOL void bufferevent_trigger_event (struct bufferevent *bufev, short what, int options) Triggers the bufferevent event callback. More... EVENT2_EXPORT_SYMBOL void bufferevent_unlock (struct bufferevent *bufev) Release the lock on a bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_write (struct bufferevent *bufev, const void *data, size_t size) Write data to a bufferevent buffer. More... EVENT2_EXPORT_SYMBOL int bufferevent_write_buffer (struct bufferevent *bufev, struct evbuffer *buf) Write data from an evbuffer to a bufferevent buffer. More... EVENT2_EXPORT_SYMBOL void ev_token_bucket_cfg_free (struct ev_token_bucket_cfg *cfg) Free all storage held in 'cfg'. More... EVENT2_EXPORT_SYMBOL struct ev_token_bucket_cfg * ev_token_bucket_cfg_new (size_t read_rate, size_t read_burst, size_t write_rate, size_t write_burst, const struct timeval *tick_len) Initialize and return a new object to configure the rate-limiting behavior of bufferevents. More... Return the current read or write bucket size for a bufferevent.
+
If it is not configured with a per-bufferevent ratelimit, return EV_SSIZE_MAX. This function does not inspect the group limit, if any. Note that it can return a negative value if the bufferevent has been made to read or write more than its limit.
+
bufferevent_get_max_to_read (struct bufferevent *bev) bufferevent_get_max_to_write (struct bufferevent *bev) bufferevent_get_read_limit (struct bufferevent *bev) bufferevent_get_token_bucket_cfg (const struct bufferevent *bev) bufferevent_get_write_limit (struct bufferevent *bev) Return the read or write bucket size for a bufferevent rate limit group.
+
Note that it can return a negative value if bufferevents in the group have been made to read or write more than their limits.
+
bufferevent_rate_limit_group_get_read_limit (struct bufferevent_rate_limit_group *) bufferevent_rate_limit_group_get_write_limit (struct bufferevent_rate_limit_group *) Subtract a number of bytes from a bufferevent's read or write bucket.
+
The decrement value can be negative, if you want to manually refill the bucket. If the change puts the bucket above or below zero, the bufferevent will resume or suspend reading writing as appropriate. These functions make no change in the buckets for the bufferevent's group, if any.
+
Returns 0 on success, -1 on internal error.
+
bufferevent_decrement_read_limit (struct bufferevent *bev, ev_ssize_t decr) bufferevent_decrement_write_limit (struct bufferevent *bev, ev_ssize_t decr) Subtract a number of bytes from a bufferevent rate-limiting group's read or write bucket.
+
The decrement value can be negative, if you want to manually refill the bucket. If the change puts the bucket above or below zero, the bufferevents in the group will resume or suspend reading writing as appropriate.
+
Returns 0 on success, -1 on internal error.
+
bufferevent_rate_limit_group_decrement_read (struct bufferevent_rate_limit_group *, ev_ssize_t) bufferevent_rate_limit_group_decrement_write (struct bufferevent_rate_limit_group *, ev_ssize_t) EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_get_totals (struct bufferevent_rate_limit_group *grp, ev_uint64_t *total_read_out, ev_uint64_t *total_written_out) Inspect the total bytes read/written on a group. More... EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_reset_totals (struct bufferevent_rate_limit_group *grp) Reset the total bytes read/written on a group. More...
+typedef enum bufferevent_filter_result (* bufferevent_filter_cb ) (struct evbuffer *src, struct evbuffer *dst, ev_ssize_t dst_limit, enum bufferevent_flush_mode mode, void *ctx) A callback function to implement a filter for a bufferevent. More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_filter_new (struct bufferevent *underlying, bufferevent_filter_cb input_filter, bufferevent_filter_cb output_filter, int options, void(*free_context)(void *), void *ctx) Allocate a new filtering bufferevent on top of an existing bufferevent. More... enum bufferevent_filter_result { BEV_OK = 0,
+BEV_NEED_MORE = 1,
+BEV_ERROR = 2
+ } Values that filters can return. More...
+
+
Functions for buffering data for network sending or receiving.
+
Bufferevents are higher level than evbuffers: each has an underlying evbuffer for reading and one for writing, and callbacks that are invoked under certain circumstances.
+
A bufferevent provides input and output buffers that get filled and drained automatically. The user of a bufferevent no longer deals directly with the I/O, but instead is reading from input and writing to output buffers.
+
Once initialized, the bufferevent structure can be used repeatedly with bufferevent_enable() and bufferevent_disable() .
+
When reading is enabled, the bufferevent will try to read from the file descriptor onto its input buffer, and call the read callback. When writing is enabled, the bufferevent will try to write data onto its file descriptor when the output buffer has enough data, and call the write callback when the output buffer is sufficiently drained.
+
Bufferevents come in several flavors, including:
+
+Socket-based bufferevents
+A bufferevent that reads and writes data onto a network socket. Created with bufferevent_socket_new() .
+
+Paired bufferevents
+A pair of bufferevents that send and receive data to one another without touching the network. Created with bufferevent_pair_new() .
+
+Filtering bufferevents
+A bufferevent that transforms data, and sends or receives it over another underlying bufferevent. Created with bufferevent_filter_new() .
+
+SSL-backed bufferevents
+A bufferevent that uses the openssl library to send and receive data over an encrypted connection. Created with bufferevent_openssl_socket_new() or bufferevent_openssl_filter_new() .
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* bufferevent_data_cb) (struct bufferevent *bev, void *ctx)
+
+
+
+
+
A read or write callback for a bufferevent.
+
The read callback is triggered when new data arrives in the input buffer and the amount of readable data exceed the low watermark which is 0 by default.
+
The write callback is triggered if the write buffer has been exhausted or fell below its low watermark.
+
Parameters
+
+ bev the bufferevent that triggered the callback ctx the user-specified context for this bufferevent
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* bufferevent_event_cb) (struct bufferevent *bev, short what, void *ctx)
+
+
+
+
+
An event/error callback for a bufferevent.
+
The event callback is triggered if either an EOF condition or another unrecoverable error was encountered.
+
For bufferevents with deferred callbacks, this is a bitwise OR of all errors that have happened on the bufferevent since the last callback invocation.
+
Parameters
+
+ bev the bufferevent for which the error condition was reached what a conjunction of flags: BEV_EVENT_READING or BEV_EVENT_WRITING to indicate if the error was encountered on the read or write path, and one of the following flags: BEV_EVENT_EOF, BEV_EVENT_ERROR, BEV_EVENT_TIMEOUT, BEV_EVENT_CONNECTED. ctx the user-specified context for this bufferevent
+
+
+
+
+
+
+
◆
+
+
+
+
+
A callback function to implement a filter for a bufferevent.
+
Parameters
+
+ src An evbuffer to drain data from. dst An evbuffer to add data to. limit A suggested upper bound of bytes to write to dst. The filter may ignore this value, but doing so means that it will overflow the high-water mark associated with dst. -1 means "no limit". mode Whether we should write data as may be convenient (BEV_NORMAL), or flush as much data as we can (BEV_FLUSH), or flush as much as we can, possibly including an end-of-stream marker (BEV_FINISH). ctx A user-supplied pointer.
+
+
+
Returns BEV_OK if we wrote some data; BEV_NEED_MORE if we can't produce any more output until we get some input; and BEV_ERROR on an error.
+
+
+
+
+
+
◆
+
+
+
+
+
Values that filters can return.
+
+Enumerator everything is okay
+the filter needs to read more data before output
+the filter encountered a critical error, no further data can be processed.
+
+
+
+
+
+
◆
+
+
+
+
+
Flags that can be passed into filters to let them know how to deal with the incoming data.
+
+Enumerator usually set when processing data
+want to checkpoint all data sent.
+encountered EOF on read or done sending data
+
+
+
+
+
+
◆
+
+
+
+
+
Options that can be specified when creating a bufferevent.
+
+Enumerator If set, we close the underlying file descriptor/bufferevent/whatever when this bufferevent is freed.
+If set, and threading is enabled, operations on this bufferevent are protected by a lock.
+If set, callbacks are run deferred in the event loop.
+If set, callbacks are executed without locks being held on the bufferevent.
+This option currently requires that BEV_OPT_DEFER_CALLBACKS also be set; a future version of Libevent might remove the requirement.
+
+
+
+
+
+
◆
+
+
+
+
+
Flags for bufferevent_trigger(_event) that modify when and how to trigger the callback.
+
+Enumerator trigger the callback regardless of the watermarks
+defer even if the callbacks are not
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_add_to_rate_limit_group
+ (
+ struct bufferevent *
+ bev ,
+
+ struct bufferevent_rate_limit_group *
+ g
+
+ )
+
+
+
+
+
Add 'bev' to the list of bufferevents whose aggregate reading and writing is restricted by 'g'.
+
If 'g' is NULL, remove 'bev' from its current group.
+
A bufferevent may belong to no more than one rate-limit group at a time. If 'bev' is already a member of a group, it will be removed from its old group before being added to 'g'.
+
Return 0 on success and -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_base_set
+ (
+ struct event_base *
+ base ,
+
+ struct bufferevent *
+ bufev
+
+ )
+
+
+
+
+
Assign a bufferevent to a specific event_base .
+
NOTE that only socket bufferevents support this function.
+
Parameters
+
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also bufferevent_new()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_decref
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Public interface to manually decrement the reference count of a bufferevent.
+
Warning: make sure you know what you're doing. This is mainly used in conjunction with bufferevent_incref() . This will free up all data associated with a bufferevent if the reference count hits 0.
+
Parameters
+
+ bufev the bufferevent to decrement the refcount on
+
+
+
Returns 1 if the bufferevent was freed, otherwise 0 (still referenced)
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_disable
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ event
+
+ )
+
+
+
+
+
Disable a bufferevent.
+
Parameters
+
+ bufev the bufferevent to be disabled event any combination of EV_READ | EV_WRITE.
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also bufferevent_enable()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_enable
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ event
+
+ )
+
+
+
+
+
Enable a bufferevent.
+
Parameters
+
+ bufev the bufferevent to be enabled event any combination of EV_READ | EV_WRITE.
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also bufferevent_disable()
+
+
+
+
+
◆
+
+
+
+
+
Allocate a new filtering bufferevent on top of an existing bufferevent.
+
Parameters
+
+ underlying the underlying bufferevent. input_filter The filter to apply to data we read from the underlying bufferevent output_filter The filer to apply to data we write to the underlying bufferevent options A bitfield of bufferevent options. free_context A function to use to free the filter context when this bufferevent is freed. ctx A context pointer to pass to the filter functions.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_flush
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ iotype ,
+
+ enum bufferevent_flush_mode
+ mode
+
+ )
+
+
+
+
+
Triggers the bufferevent to produce more data if possible.
+
Parameters
+
+ bufev the bufferevent object iotype either EV_READ or EV_WRITE or both. mode either BEV_NORMAL or BEV_FLUSH or BEV_FINISHED
+
+
+
Returns -1 on failure, 0 if no data was produces, 1 if data was produced
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_free
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Deallocate the storage associated with a bufferevent structure.
+
If there is pending data to write on the bufferevent, it probably won't be flushed before the bufferevent is freed.
+
Parameters
+
+ bufev the bufferevent structure to be freed.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL short bufferevent_get_enabled
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Return the events that are enabled on a given bufferevent.
+
Parameters
+
+ bufev the bufferevent to inspect
+
+
+
Returns A combination of EV_READ | EV_WRITE
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_input
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Returns the input buffer.
+
The user MUST NOT set the callback on this buffer.
+
Parameters
+
+ bufev the bufferevent from which to get the evbuffer
+
+
+
Returns the evbuffer object for the input buffer
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_output
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Returns the output buffer.
+
The user MUST NOT set the callback on this buffer.
+
When filters are being used, the filters need to be manually triggered if the output buffer was manipulated.
+
Parameters
+
+ bufev the bufferevent from which to get the evbuffer
+
+
+
Returns the evbuffer object for the output buffer
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_get_priority
+ (
+ const struct bufferevent *
+ bufev )
+
+
+
+
+
Return the priority of a bufferevent.
+
Only supported for socket bufferevents
+
+
+
+
+
◆
+
+
+
+
+
Retrieves the callbacks for a bufferevent.
+
Parameters
+
+ bufev the bufferevent to examine. readcb_ptr if readcb_ptr is nonnull, *readcb_ptr is set to the current read callback for the bufferevent. writecb_ptr if writecb_ptr is nonnull, *writecb_ptr is set to the current write callback for the bufferevent. eventcb_ptr if eventcb_ptr is nonnull, *eventcb_ptr is set to the current event callback for the bufferevent. cbarg_ptr if cbarg_ptr is nonnull, *cbarg_ptr is set to the current callback argument for the bufferevent.
+
+
+
See also buffervent_setcb()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_getwatermark
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ events ,
+
+ size_t *
+ lowmark ,
+
+ size_t *
+ highmark
+
+ )
+
+
+
+
+
Retrieves the watermarks for read or write events.
+
Returns non-zero if events contains not only EV_READ or EV_WRITE. Returns zero if events equal EV_READ or EV_WRITE
+
Parameters
+
+ bufev the bufferevent to be examined events EV_READ or EV_WRITE lowmark receives the lower watermark if not NULL highmark receives the high watermark if not NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_incref
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Public interface to manually increase the reference count of a bufferevent this is useful in situations where a user may reference the bufferevent somewhere else (unknown to libevent)
+
Parameters
+
+ bufev the bufferevent to increase the refcount on
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_lock
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Acquire the lock on a bufferevent.
+
Has no effect if locking was not enabled with BEV_OPT_THREADSAFE.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_pair_get_partner
+ (
+ struct bufferevent *
+ bev )
+
+
+
+
+
Given one bufferevent returned by bufferevent_pair_new() , returns the other one if it still exists.
+
Otherwise returns NULL.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_pair_new
+ (
+ struct event_base *
+ base ,
+
+ int
+ options ,
+
+ struct bufferevent *
+ pair [2]
+
+ )
+
+
+
+
+
Allocate a pair of linked bufferevents.
+
The bufferevents behave as would two bufferevent_sock instances connected to opposite ends of a socketpair(), except that no internal socketpair is allocated.
+
Parameters
+
+ base The event base to associate with the socketpair. options A set of options for this bufferevent pair A pointer to an array to hold the two new bufferevent objects.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_priority_set
+ (
+ struct bufferevent *
+ bufev ,
+
+ int
+ pri
+
+ )
+
+
+
+
+
Assign a priority to a bufferevent.
+
Only supported for socket bufferevents.
+
Parameters
+
+ bufev a bufferevent struct pri the priority to be assigned
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_free
+ (
+ struct bufferevent_rate_limit_group *
+ )
+
+
+
+
+
Free a rate-limiting group.
+
The group must have no members when this function is called.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_get_totals
+ (
+ struct bufferevent_rate_limit_group *
+ grp ,
+
+ ev_uint64_t *
+ total_read_out ,
+
+ ev_uint64_t *
+ total_written_out
+
+ )
+
+
+
+
+
Inspect the total bytes read/written on a group.
+
Set the variable pointed to by total_read_out to the total number of bytes ever read on grp, and the variable pointed to by total_written_out to the total number of bytes ever written on grp.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct bufferevent_rate_limit_group* bufferevent_rate_limit_group_new
+ (
+ struct event_base *
+ base ,
+
+ const struct ev_token_bucket_cfg *
+ cfg
+
+ )
+
+
+
+
+
Create a new rate-limit group for bufferevents.
+
A rate-limit group constrains the maximum number of bytes sent and received, in toto, by all of its bufferevents.
+
Parameters
+
+ base An event_base to run any necessary timeouts for the group. Note that all bufferevents in the group do not necessarily need to share this event_base . cfg The rate-limit for this group.
+
+
+
Note that all rate-limits hare are currently best-effort: future versions of Libevent may implement them more tightly.
+
Note also that only some bufferevent types currently respect rate-limiting. They are: socket-based bufferevents (normal and IOCP-based), and SSL-based bufferevents.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_reset_totals
+ (
+ struct bufferevent_rate_limit_group *
+ grp )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_cfg
+ (
+ struct bufferevent_rate_limit_group *
+ ,
+
+
+ const struct ev_token_bucket_cfg *
+
+
+
+ )
+
+
+
+
+
Change the rate-limiting settings for a given rate-limiting group.
+
Return 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_min_share
+ (
+ struct bufferevent_rate_limit_group *
+ ,
+
+
+ size_t
+
+
+
+ )
+
+
+
+
+
Change the smallest quantum we're willing to allocate to any single bufferevent in a group for reading or writing at a time.
+
The rationale is that, because of TCP/IP protocol overheads and kernel behavior, if a rate-limiting group is so tight on bandwidth that you're only willing to send 1 byte per tick per bufferevent, you might instead want to batch up the reads and writes so that you send N bytes per 1/N of the bufferevents (chosen at random) each tick, so you still wind up send 1 byte per tick per bufferevent on average, but you don't send so many tiny packets.
+
The default min-share is currently 64 bytes.
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t bufferevent_read
+ (
+ struct bufferevent *
+ bufev ,
+
+ void *
+ data ,
+
+ size_t
+ size
+
+ )
+
+
+
+
+
Read data from a bufferevent buffer.
+
The bufferevent_read() function is used to read data from the input buffer.
+
Parameters
+
+ bufev the bufferevent to be read from data pointer to a buffer that will store the data size the size of the data buffer, in bytes
+
+
+
Returns the amount of data read, in bytes. If 0 is returned, it is possible that there is no data in the buffer or that the read failed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_read_buffer
+ (
+ struct bufferevent *
+ bufev ,
+
+ struct evbuffer *
+ buf
+
+ )
+
+
+
+
+
Read data from a bufferevent buffer into an evbuffer.
+
This avoids memory copies.
+
Parameters
+
+ bufev the bufferevent to be read from buf the evbuffer to which to add data
+
+
+
Returns 0 if successful, or -1 if an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_replacefd
+ (
+ struct bufferevent *
+ bufev ,
+
+ evutil_socket_t fd
+
+ )
+
+
+
+
+
Replaces the file descriptor on which the bufferevent operates.
+
Not supported for all bufferevent types.
+
Unlike bufferevent_setfd() it will close previous file descriptor (if any).
+
Parameters
+
+ bufev the bufferevent object for which to change the file descriptor fd the file descriptor to operate on
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_read
+ (
+ struct bufferevent *
+ bev ,
+
+ size_t
+ size
+
+ )
+
+
+
+
+
Set the size limit for single read operation.
+
Set to 0 for a reasonable default.
+
Return 0 on success and -1 on failure.
+
See also evbuffer_set_max_read()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_write
+ (
+ struct bufferevent *
+ bev ,
+
+ size_t
+ size
+
+ )
+
+
+
+
+
Set the size limit for single write operation.
+
Set to 0 for a reasonable default.
+
Return 0 on success and -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_set_rate_limit
+ (
+ struct bufferevent *
+ bev ,
+
+ struct ev_token_bucket_cfg *
+ cfg
+
+ )
+
+
+
+
+
Set the rate-limit of a the bufferevent 'bev' to the one specified in 'cfg'.
+
If 'cfg' is NULL, disable any per-bufferevent rate-limiting on 'bev'.
+
Note that only some bufferevent types currently respect rate-limiting. They are: socket-based bufferevents (normal and IOCP-based), and SSL-based bufferevents.
+
Return 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_set_timeouts
+ (
+ struct bufferevent *
+ bufev ,
+
+ const struct timeval *
+ timeout_read ,
+
+ const struct timeval *
+ timeout_write
+
+ )
+
+
+
+
+
Set the read and write timeout for a bufferevent.
+
A bufferevent's timeout will fire the first time that the indicated amount of time has elapsed since a successful read or write operation, during which the bufferevent was trying to read or write.
+
(In other words, if reading or writing is disabled, or if the bufferevent's read or write operation has been suspended because there's no data to write, or not enough bandwidth, or so on, the timeout isn't active. The timeout only becomes active when we we're willing to actually read or write.)
+
Calling bufferevent_enable or setting a timeout for a bufferevent whose timeout is already pending resets its timeout.
+
If the timeout elapses, the corresponding operation (EV_READ or EV_WRITE) becomes disabled until you re-enable it again. The bufferevent's event callback is called with the BEV_EVENT_TIMEOUT|BEV_EVENT_READING or BEV_EVENT_TIMEOUT|BEV_EVENT_WRITING.
+
Parameters
+
+ bufev the bufferevent to be modified timeout_read the read timeout, or NULL timeout_write the write timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
Changes the callbacks for a bufferevent.
+
Parameters
+
+ bufev the bufferevent object for which to change callbacks readcb callback to invoke when there is data to be read, or NULL if no callback is desired writecb callback to invoke when the file descriptor is ready for writing, or NULL if no callback is desired eventcb callback to invoke when there is an event on the file descriptor cbarg an argument that will be supplied to each of the callbacks (readcb, writecb, and errorcb)
+
+
+
See also bufferevent_new()
+
+
+
+
+
◆
+
+
+
+
+
Changes the file descriptor on which the bufferevent operates.
+
Not supported for all bufferevent types.
+
Parameters
+
+ bufev the bufferevent object for which to change the file descriptor fd the file descriptor to operate on
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_setwatermark
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ events ,
+
+ size_t
+ lowmark ,
+
+ size_t
+ highmark
+
+ )
+
+
+
+
+
Sets the watermarks for read and write events.
+
On input, a bufferevent does not invoke the user read callback unless there is at least low watermark data in the buffer. If the read buffer is beyond the high watermark, the bufferevent stops reading from the network. But be aware that bufferevent input/read buffer can overrun high watermark limit (typical example is openssl bufferevent), so you should not relay in this.
+
On output, the user write callback is invoked whenever the buffered data falls below the low watermark. Filters that write to this bufev will try not to write more bytes to this buffer than the high watermark would allow, except when flushing.
+
Parameters
+
+ bufev the bufferevent to be modified events EV_READ, EV_WRITE or both lowmark the lower watermark to set highmark the high watermark to set
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect
+ (
+ struct bufferevent *
+ bufev ,
+
+ const struct sockaddr *
+ addr ,
+
+ int
+ socklen
+
+ )
+
+
+
+
+
Launch a connect() attempt with a socket-based bufferevent.
+
When the connect succeeds, the eventcb will be invoked with BEV_EVENT_CONNECTED set.
+
If the bufferevent does not already have a socket set, we allocate a new socket here and make it nonblocking before we begin.
+
If no address is provided, we assume that the socket is already connecting, and configure the bufferevent so that a BEV_EVENT_CONNECTED event will be yielded when it is done connecting.
+
Parameters
+
+ bufev an existing bufferevent allocated with bufferevent_socket_new() . addr the address we should connect to socklen The length of the address
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname
+ (
+ struct bufferevent *
+ bufev ,
+
+ struct evdns_base *
+ evdns_base ,
+
+ int
+ family ,
+
+ const char *
+ hostname ,
+
+ int
+ port
+
+ )
+
+
+
+
+
Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect() .
+
Parameters
+
+ bufev An existing bufferevent allocated with bufferevent_socket_new() evdns_base Optionally, an evdns_base to use for resolving hostnames asynchronously. May be set to NULL for a blocking resolve. family A preferred address family to resolve addresses to, or AF_UNSPEC for no preference. Only AF_INET, AF_INET6, and AF_UNSPEC are supported. hostname The hostname to resolve; see below for notes on recognized formats port The port to connect to on the resolved address.
+
+
+
Returns 0 if successful, -1 on failure.
+
See also bufferevent_socket_connect_hostname_hints()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname_hints
+ (
+ struct bufferevent *
+ bufev ,
+
+ struct evdns_base *
+ evdns_base ,
+
+ const struct evutil_addrinfo *
+ hints_in ,
+
+ const char *
+ hostname ,
+
+ int
+ port
+
+ )
+
+
+
+
+
Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect() .
+
Parameters
+
+ bufev An existing bufferevent allocated with bufferevent_socket_new() evdns_base Optionally, an evdns_base to use for resolving hostnames asynchronously. May be set to NULL for a blocking resolve. hints_in points to an addrinfo structure that specifies criteria for selecting the socket address structures to be used hostname The hostname to resolve; see below for notes on recognized formats port The port to connect to on the resolved address.
+
+
+
Returns 0 if successful, -1 on failure.
+
Recognized hostname formats are:
www.example.com (hostname)
+1.2.3.4 (ipv4address)
+::1 (ipv6address)
+[::1] ([ipv6address])
+ Performance note: If you do not provide an evdns_base, this function may block while it waits for a DNS response. This is probably not what you want.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_socket_get_dns_error
+ (
+ struct bufferevent *
+ bev )
+
+
+
+
+
Return the error code for the last failed DNS lookup attempt made by bufferevent_socket_connect_hostname() .
+
Parameters
+
+ bev The bufferevent object.
+
+
+
Returns DNS error code.
+
See also evutil_gai_strerror()
+
+
+
+
+
◆
+
+
+
+
+
Create a new socket bufferevent over an existing socket.
+
Parameters
+
+ base the event base to associate with the new bufferevent. fd the file descriptor from which data is read and written to. This file descriptor is not allowed to be a pipe(2). It is safe to set the fd to -1, so long as you later set it with bufferevent_setfd or bufferevent_socket_connect() . options Zero or more BEV_OPT_* flags
+
+
+
Returns a pointer to a newly allocated bufferevent struct, or NULL if an error occurred
+
See also bufferevent_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_trigger
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ iotype ,
+
+ int
+ options
+
+ )
+
+
+
+
+
Triggers bufferevent data callbacks.
+
The function will honor watermarks unless options contain BEV_TRIG_IGNORE_WATERMARKS. If the options contain BEV_OPT_DEFER_CALLBACKS, the callbacks are deferred.
+
Parameters
+
+ bufev the bufferevent object iotype either EV_READ or EV_WRITE or both. options
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_trigger_event
+ (
+ struct bufferevent *
+ bufev ,
+
+ short
+ what ,
+
+ int
+ options
+
+ )
+
+
+
+
+
Triggers the bufferevent event callback.
+
If the options contain BEV_OPT_DEFER_CALLBACKS, the callbacks are deferred.
+
Parameters
+
+ bufev the bufferevent object what the flags to pass onto the event callback options
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_unlock
+ (
+ struct bufferevent *
+ bufev )
+
+
+
+
+
Release the lock on a bufferevent.
+
Has no effect if locking was not enabled with BEV_OPT_THREADSAFE.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_write
+ (
+ struct bufferevent *
+ bufev ,
+
+ const void *
+ data ,
+
+ size_t
+ size
+
+ )
+
+
+
+
+
Write data to a bufferevent buffer.
+
The bufferevent_write() function can be used to write data to the file descriptor. The data is appended to the output buffer and written to the descriptor automatically as it becomes available for writing.
+
Parameters
+
+ bufev the bufferevent to be written to data a pointer to the data to be written size the length of the data, in bytes
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also bufferevent_write_buffer()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_write_buffer
+ (
+ struct bufferevent *
+ bufev ,
+
+ struct evbuffer *
+ buf
+
+ )
+
+
+
+
+
Write data from an evbuffer to a bufferevent buffer.
+
The evbuffer is being drained as a result.
+
Parameters
+
+ bufev the bufferevent to be written to buf the evbuffer to be written
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also bufferevent_write()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void ev_token_bucket_cfg_free
+ (
+ struct ev_token_bucket_cfg *
+ cfg )
+
+
+
+
+
Free all storage held in 'cfg'.
+
Note: 'cfg' is not currently reference-counted; it is not safe to free it until no bufferevent is using it.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct ev_token_bucket_cfg* ev_token_bucket_cfg_new
+ (
+ size_t
+ read_rate ,
+
+ size_t
+ read_burst ,
+
+ size_t
+ write_rate ,
+
+ size_t
+ write_burst ,
+
+ const struct timeval *
+ tick_len
+
+ )
+
+
+
+
+
Initialize and return a new object to configure the rate-limiting behavior of bufferevents.
+
Parameters
+
+ read_rate The maximum number of bytes to read per tick on average. read_burst The maximum number of bytes to read in any single tick. write_rate The maximum number of bytes to write per tick on average. write_burst The maximum number of bytes to write in any single tick. tick_len The length of a single tick. Defaults to one second. Any fractions of a millisecond are ignored.
+
+
+
Note that all rate-limits hare are currently best-effort: future versions of Libevent may implement them more tightly.
+
+
+
+
libevent: event2/bufferevent.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_BUFFEREVENT_H_INCLUDED_
+
28 #define EVENT2_BUFFEREVENT_H_INCLUDED_
+
+
78 #include <event2/visibility.h>
+
+
+
+
+
+
84 #include <event2/event-config.h>
+
85 #ifdef EVENT__HAVE_SYS_TYPES_H
+
86 #include <sys/types.h>
+
+
88 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
+
+
+
+
101 #define BEV_EVENT_READING 0x01
+
102 #define BEV_EVENT_WRITING 0x02
+
103 #define BEV_EVENT_EOF 0x10
+
104 #define BEV_EVENT_ERROR 0x20
+
105 #define BEV_EVENT_TIMEOUT 0x40
+
106 #define BEV_EVENT_CONNECTED 0x80
+
+
115 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
235 struct evdns_base *evdns_base,
int family,
const char *hostname,
int port);
+
+
+
+
264 struct evdns_base *evdns_base,
const struct evutil_addrinfo *hints_in,
const char *hostname,
int port);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
421 const void *data,
size_t size);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
548 const struct timeval *timeout_read,
const struct timeval *timeout_write);
+
+
+
+
573 size_t lowmark,
size_t highmark);
+
+
+
+
587 size_t *lowmark,
size_t *highmark);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
761 void (*free_context)(
void *),
+
+
+
+
+
+
+
+
+
790 struct ev_token_bucket_cfg;
+
+
796 struct bufferevent_rate_limit_group;
+
+
799 #define EV_RATE_LIMIT_MAX EV_SSIZE_MAX
+
+
+
+
819 size_t read_rate,
size_t read_burst,
+
820 size_t write_rate,
size_t write_burst,
+
821 const struct timeval *tick_len);
+
+
+
+
+
+
+
844 struct ev_token_bucket_cfg *cfg);
+
+
+
+
+
866 const struct ev_token_bucket_cfg *cfg);
+
+
+
874 struct bufferevent_rate_limit_group *,
+
875 const struct ev_token_bucket_cfg *);
+
+
+
+
895 struct bufferevent_rate_limit_group *,
size_t );
+
+
+
+
+
+
+
916 struct bufferevent_rate_limit_group *g);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
964 ev_ssize_t bufferevent_get_read_limit(
struct bufferevent *bev);
+
+
966 ev_ssize_t bufferevent_get_write_limit(
struct bufferevent *bev);
+
+
970 ev_ssize_t bufferevent_get_max_to_read(
struct bufferevent *bev);
+
+
972 ev_ssize_t bufferevent_get_max_to_write(
struct bufferevent *bev);
+
+
+
975 const struct ev_token_bucket_cfg *bufferevent_get_token_bucket_cfg(
const struct bufferevent * bev);
+
+
+
987 ev_ssize_t bufferevent_rate_limit_group_get_read_limit(
+
988 struct bufferevent_rate_limit_group *);
+
+
990 ev_ssize_t bufferevent_rate_limit_group_get_write_limit(
+
991 struct bufferevent_rate_limit_group *);
+
1008 EVENT2_EXPORT_SYMBOL
+
1009 int bufferevent_decrement_read_limit(
struct bufferevent *bev, ev_ssize_t decr);
+
1010 EVENT2_EXPORT_SYMBOL
+
1011 int bufferevent_decrement_write_limit(
struct bufferevent *bev, ev_ssize_t decr);
+
1027 EVENT2_EXPORT_SYMBOL
+
1028 int bufferevent_rate_limit_group_decrement_read(
+
1029 struct bufferevent_rate_limit_group *, ev_ssize_t);
+
1030 EVENT2_EXPORT_SYMBOL
+
1031 int bufferevent_rate_limit_group_decrement_write(
+
1032 struct bufferevent_rate_limit_group *, ev_ssize_t);
+
1042 EVENT2_EXPORT_SYMBOL
+
+
1044 struct bufferevent_rate_limit_group *grp,
+
1045 ev_uint64_t *total_read_out, ev_uint64_t *total_written_out);
+
+
1052 EVENT2_EXPORT_SYMBOL
+
+
+
1055 struct bufferevent_rate_limit_group *grp);
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int bufferevent_flush(struct bufferevent *bufev, short iotype, enum bufferevent_flush_mode mode)
Triggers the bufferevent to produce more data if possible.
EVENT2_EXPORT_SYMBOL void ev_token_bucket_cfg_free(struct ev_token_bucket_cfg *cfg)
Free all storage held in 'cfg'.
@ BEV_OPT_CLOSE_ON_FREE
If set, we close the underlying file descriptor/bufferevent/whatever when this bufferevent is freed.
Definition: bufferevent.h:161
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_pair_get_partner(struct bufferevent *bev)
Given one bufferevent returned by bufferevent_pair_new(), returns the other one if it still exists.
EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname(struct bufferevent *bufev, struct evdns_base *evdns_base, int family, const char *hostname, int port)
Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect().
EVENT2_EXPORT_SYMBOL int bufferevent_setfd(struct bufferevent *bufev, evutil_socket_t fd)
Changes the file descriptor on which the bufferevent operates.
EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_output(struct bufferevent *bufev)
Returns the output buffer.
@ BEV_TRIG_IGNORE_WATERMARKS
trigger the callback regardless of the watermarks
Definition: bufferevent.h:663
EVENT2_EXPORT_SYMBOL int bufferevent_priority_set(struct bufferevent *bufev, int pri)
Assign a priority to a bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_set_timeouts(struct bufferevent *bufev, const struct timeval *timeout_read, const struct timeval *timeout_write)
Set the read and write timeout for a bufferevent.
EVENT2_EXPORT_SYMBOL struct ev_token_bucket_cfg * ev_token_bucket_cfg_new(size_t read_rate, size_t read_burst, size_t write_rate, size_t write_burst, const struct timeval *tick_len)
Initialize and return a new object to configure the rate-limiting behavior of bufferevents.
bufferevent_flush_mode
Flags that can be passed into filters to let them know how to deal with the incoming data.
Definition: bufferevent.h:633
EVENT2_EXPORT_SYMBOL struct bufferevent_rate_limit_group * bufferevent_rate_limit_group_new(struct event_base *base, const struct ev_token_bucket_cfg *cfg)
Create a new rate-limit group for bufferevents.
EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_reset_totals(struct bufferevent_rate_limit_group *grp)
Reset the total bytes read/written on a group.
EVENT2_EXPORT_SYMBOL int bufferevent_socket_get_dns_error(struct bufferevent *bev)
Return the error code for the last failed DNS lookup attempt made by bufferevent_socket_connect_hostn...
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_get_underlying(struct bufferevent *bufev)
Returns the underlying bufferevent associated with a bufferevent (if the bufferevent is a wrapper),...
EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_free(struct bufferevent_rate_limit_group *)
Free a rate-limiting group.
EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect_hostname_hints(struct bufferevent *bufev, struct evdns_base *evdns_base, const struct evutil_addrinfo *hints_in, const char *hostname, int port)
Resolve the hostname 'hostname' and connect to it as with bufferevent_socket_connect().
EVENT2_EXPORT_SYMBOL ev_ssize_t bufferevent_get_max_single_read(struct bufferevent *bev)
Get the current size limit for single read operation.
EVENT2_EXPORT_SYMBOL void bufferevent_getcb(struct bufferevent *bufev, bufferevent_data_cb *readcb_ptr, bufferevent_data_cb *writecb_ptr, bufferevent_event_cb *eventcb_ptr, void **cbarg_ptr)
Retrieves the callbacks for a bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_base_set(struct event_base *base, struct bufferevent *bufev)
Assign a bufferevent to a specific event_base.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL int bufferevent_enable(struct bufferevent *bufev, short event)
Enable a bufferevent.
bufferevent_trigger_options
Flags for bufferevent_trigger(_event) that modify when and how to trigger the callback.
Definition: bufferevent.h:661
Structure to represent a single event.
Definition: event.h:276
@ BEV_OPT_THREADSAFE
If set, and threading is enabled, operations on this bufferevent are protected by a lock.
Definition: bufferevent.h:165
EVENT2_EXPORT_SYMBOL int bufferevent_getwatermark(struct bufferevent *bufev, short events, size_t *lowmark, size_t *highmark)
Retrieves the watermarks for read or write events.
@ BEV_FLUSH
want to checkpoint all data sent.
Definition: bufferevent.h:638
EVENT2_EXPORT_SYMBOL int bufferevent_read_buffer(struct bufferevent *bufev, struct evbuffer *buf)
Read data from a bufferevent buffer into an evbuffer.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_filter_new(struct bufferevent *underlying, bufferevent_filter_cb input_filter, bufferevent_filter_cb output_filter, int options, void(*free_context)(void *), void *ctx)
Allocate a new filtering bufferevent on top of an existing bufferevent.
EVENT2_EXPORT_SYMBOL struct evbuffer * bufferevent_get_input(struct bufferevent *bufev)
Returns the input buffer.
enum bufferevent_filter_result(* bufferevent_filter_cb)(struct evbuffer *src, struct evbuffer *dst, ev_ssize_t dst_limit, enum bufferevent_flush_mode mode, void *ctx)
A callback function to implement a filter for a bufferevent.
Definition: bufferevent.h:738
EVENT2_EXPORT_SYMBOL struct event_base * bufferevent_get_base(struct bufferevent *bev)
Return the event_base used by a bufferevent.
EVENT2_EXPORT_SYMBOL void bufferevent_incref(struct bufferevent *bufev)
Public interface to manually increase the reference count of a bufferevent this is useful in situatio...
An opaque type for handling buffered IO.
Definition: bufferevent.h:114
EVENT2_EXPORT_SYMBOL void bufferevent_lock(struct bufferevent *bufev)
Acquire the lock on a bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_set_rate_limit(struct bufferevent *bev, struct ev_token_bucket_cfg *cfg)
Set the rate-limit of a the bufferevent 'bev' to the one specified in 'cfg'.
EVENT2_EXPORT_SYMBOL ev_ssize_t bufferevent_get_max_single_write(struct bufferevent *bev)
Get the current size limit for single write operation.
EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_read(struct bufferevent *bev, size_t size)
Set the size limit for single read operation.
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
EVENT2_EXPORT_SYMBOL short bufferevent_get_enabled(struct bufferevent *bufev)
Return the events that are enabled on a given bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_socket_connect(struct bufferevent *bufev, const struct sockaddr *addr, int socklen)
Launch a connect() attempt with a socket-based bufferevent.
EVENT2_EXPORT_SYMBOL evutil_socket_t bufferevent_getfd(struct bufferevent *bufev)
Returns the file descriptor associated with a bufferevent, or -1 if no file descriptor is associated ...
EVENT2_EXPORT_SYMBOL void bufferevent_unlock(struct bufferevent *bufev)
Release the lock on a bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_remove_from_rate_limit_group(struct bufferevent *bev)
Remove 'bev' from its current rate-limit group (if any).
EVENT2_EXPORT_SYMBOL int bufferevent_get_priority(const struct bufferevent *bufev)
Return the priority of a bufferevent.
EVENT2_EXPORT_SYMBOL void bufferevent_setwatermark(struct bufferevent *bufev, short events, size_t lowmark, size_t highmark)
Sets the watermarks for read and write events.
EVENT2_EXPORT_SYMBOL void bufferevent_rate_limit_group_get_totals(struct bufferevent_rate_limit_group *grp, ev_uint64_t *total_read_out, ev_uint64_t *total_written_out)
Inspect the total bytes read/written on a group.
EVENT2_EXPORT_SYMBOL void bufferevent_trigger(struct bufferevent *bufev, short iotype, int options)
Triggers bufferevent data callbacks.
void(* bufferevent_event_cb)(struct bufferevent *bev, short what, void *ctx)
An event/error callback for a bufferevent.
Definition: bufferevent.h:155
void(* bufferevent_data_cb)(struct bufferevent *bev, void *ctx)
A read or write callback for a bufferevent.
Definition: bufferevent.h:136
EVENT2_EXPORT_SYMBOL void bufferevent_trigger_event(struct bufferevent *bufev, short what, int options)
Triggers the bufferevent event callback.
@ BEV_FINISHED
encountered EOF on read or done sending data
Definition: bufferevent.h:641
EVENT2_EXPORT_SYMBOL size_t bufferevent_read(struct bufferevent *bufev, void *data, size_t size)
Read data from a bufferevent buffer.
EVENT2_EXPORT_SYMBOL int bufferevent_decref(struct bufferevent *bufev)
Public interface to manually decrement the reference count of a bufferevent.
@ BEV_NEED_MORE
the filter needs to read more data before output
Definition: bufferevent.h:713
@ BEV_OPT_UNLOCK_CALLBACKS
If set, callbacks are executed without locks being held on the bufferevent.
Definition: bufferevent.h:174
EVENT2_EXPORT_SYMBOL int bufferevent_replacefd(struct bufferevent *bufev, evutil_socket_t fd)
Replaces the file descriptor on which the bufferevent operates.
EVENT2_EXPORT_SYMBOL void bufferevent_setcb(struct bufferevent *bufev, bufferevent_data_cb readcb, bufferevent_data_cb writecb, bufferevent_event_cb eventcb, void *cbarg)
Changes the callbacks for a bufferevent.
@ BEV_NORMAL
usually set when processing data
Definition: bufferevent.h:635
EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_cfg(struct bufferevent_rate_limit_group *, const struct ev_token_bucket_cfg *)
Change the rate-limiting settings for a given rate-limiting group.
EVENT2_EXPORT_SYMBOL int bufferevent_pair_new(struct event_base *base, int options, struct bufferevent *pair[2])
Allocate a pair of linked bufferevents.
@ BEV_OPT_DEFER_CALLBACKS
If set, callbacks are run deferred in the event loop.
Definition: bufferevent.h:168
EVENT2_EXPORT_SYMBOL int bufferevent_rate_limit_group_set_min_share(struct bufferevent_rate_limit_group *, size_t)
Change the smallest quantum we're willing to allocate to any single bufferevent in a group for readin...
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_socket_new(struct event_base *base, evutil_socket_t fd, int options)
Create a new socket bufferevent over an existing socket.
EVENT2_EXPORT_SYMBOL void bufferevent_free(struct bufferevent *bufev)
Deallocate the storage associated with a bufferevent structure.
bufferevent_options
Options that can be specified when creating a bufferevent.
Definition: bufferevent.h:158
@ BEV_ERROR
the filter encountered a critical error, no further data can be processed.
Definition: bufferevent.h:717
@ BEV_OK
everything is okay
Definition: bufferevent.h:710
Common convenience functions for cross-platform portability and related socket manipulations.
EVENT2_EXPORT_SYMBOL int bufferevent_add_to_rate_limit_group(struct bufferevent *bev, struct bufferevent_rate_limit_group *g)
Add 'bev' to the list of bufferevents whose aggregate reading and writing is restricted by 'g'.
A definition of struct addrinfo for systems that lack it.
Definition: util.h:707
EVENT2_EXPORT_SYMBOL int bufferevent_set_max_single_write(struct bufferevent *bev, size_t size)
Set the size limit for single write operation.
bufferevent_filter_result
Values that filters can return.
Definition: bufferevent.h:708
EVENT2_EXPORT_SYMBOL int bufferevent_write(struct bufferevent *bufev, const void *data, size_t size)
Write data to a bufferevent buffer.
EVENT2_EXPORT_SYMBOL int bufferevent_disable(struct bufferevent *bufev, short event)
Disable a bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_write_buffer(struct bufferevent *bufev, struct evbuffer *buf)
Write data from an evbuffer to a bufferevent buffer.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
@ BEV_TRIG_DEFER_CALLBACKS
defer even if the callbacks are not
Definition: bufferevent.h:666
libevent: event2/bufferevent_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Deprecated versions of the functions in bufferevent.h : provided only for backwards compatibility.
+More...
+
#include <event2/visibility.h>
+
Go to the source code of this file.
+
+
+
Deprecated versions of the functions in bufferevent.h : provided only for backwards compatibility.
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_new
+ (
+ evutil_socket_t fd ,
+
+ evbuffercb
+ readcb ,
+
+ evbuffercb
+ writecb ,
+
+ everrorcb
+ errorcb ,
+
+ void *
+ cbarg
+
+ )
+
+
+
+
+
Create a new bufferevent for an fd.
+
This function is deprecated. Use bufferevent_socket_new and bufferevent_set_callbacks instead.
+
Libevent provides an abstraction on top of the regular event callbacks. This abstraction is called a buffered event. A buffered event provides input and output buffers that get filled and drained automatically. The user of a buffered event no longer deals directly with the I/O, but instead is reading from input and writing to output buffers.
+
Once initialized, the bufferevent structure can be used repeatedly with bufferevent_enable() and bufferevent_disable() .
+
When read enabled the bufferevent will try to read from the file descriptor and call the read callback. The write callback is executed whenever the output buffer is drained below the write low watermark, which is 0 by default.
+
If multiple bases are in use, bufferevent_base_set() must be called before enabling the bufferevent for the first time.
+
Deprecated: This function is deprecated because it uses the current event base, and as such can be error prone for multithreaded programs. Use bufferevent_socket_new() instead.
+
Parameters
+
+ fd the file descriptor from which data is read and written to. This file descriptor is not allowed to be a pipe(2). readcb callback to invoke when there is data to be read, or NULL if no callback is desired writecb callback to invoke when the file descriptor is ready for writing, or NULL if no callback is desired errorcb callback to invoke when there is an error on the file descriptor cbarg an argument that will be supplied to each of the callbacks (readcb, writecb, and errorcb)
+
+
+
Returns a pointer to a newly allocated bufferevent struct, or NULL if an error occurred
+
See also bufferevent_base_set() , bufferevent_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_settimeout
+ (
+ struct bufferevent *
+ bufev ,
+
+ int
+ timeout_read ,
+
+ int
+ timeout_write
+
+ )
+
+
+
+
+
Set the read and write timeout for a buffered event.
+
Deprecated: Use bufferevent_set_timeouts instead.
+
Parameters
+
+ bufev the bufferevent to be modified timeout_read the read timeout timeout_write the write timeout
+
+
+
+
+
+
libevent: event2/bufferevent_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #ifndef EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_
+
29 #define EVENT2_BUFFEREVENT_COMPAT_H_INCLUDED_
+
+
37 #include <event2/visibility.h>
+
+
39 #define evbuffercb bufferevent_data_cb
+
40 #define everrorcb bufferevent_event_cb
+
+
+
+
85 evbuffercb readcb, evbuffercb writecb, everrorcb errorcb,
void *cbarg);
+
+
+
+
+
99 int timeout_read,
int timeout_write);
+
+
101 #define EVBUFFER_READ BEV_EVENT_READING
+
102 #define EVBUFFER_WRITE BEV_EVENT_WRITING
+
103 #define EVBUFFER_EOF BEV_EVENT_EOF
+
104 #define EVBUFFER_ERROR BEV_EVENT_ERROR
+
105 #define EVBUFFER_TIMEOUT BEV_EVENT_TIMEOUT
+
+
108 #define EVBUFFER_INPUT(x) bufferevent_get_input(x)
+
+
110 #define EVBUFFER_OUTPUT(x) bufferevent_get_output(x)
+
+
+
An opaque type for handling buffered IO.
Definition: bufferevent.h:114
EVENT2_EXPORT_SYMBOL void bufferevent_settimeout(struct bufferevent *bufev, int timeout_read, int timeout_write)
Set the read and write timeout for a buffered event.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_new(evutil_socket_t fd, evbuffercb readcb, evbuffercb writecb, everrorcb errorcb, void *cbarg)
Create a new bufferevent for an fd.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: event2/bufferevent_ssl.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
OpenSSL support for bufferevents.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <event2/bufferevent.h >
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+mbedtls_dyncontext
+bufferevent_ssl_state { BUFFEREVENT_SSL_OPEN = 0,
+BUFFEREVENT_SSL_CONNECTING = 1,
+BUFFEREVENT_SSL_ACCEPTING = 2
+ } The state of an SSL object to be used when creating a new SSL bufferevent.
+bufferevent_get_mbedtls_error (struct bufferevent *bev) Return the most recent MbedTLS error reported on an SSL bufferevent. bufferevent_get_openssl_error (struct bufferevent *bev) Return the most recent OpenSSL error reported on an SSL bufferevent. bufferevent_mbedtls_dyncontext_free (mbedtls_dyncontext *ctx) Deallocate heap-based MbedTLS context. bufferevent_mbedtls_dyncontext_new (struct mbedtls_ssl_config *conf) Create a new heap-based MbedTLS context for use it in bufferevent_mbedtls_* functions. EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_mbedtls_filter_new (struct event_base *base, struct bufferevent *underlying, mbedtls_dyncontext *ssl, enum bufferevent_ssl_state state, int options) Create a new SSL bufferevent to send its data over another bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_mbedtls_get_allow_dirty_shutdown (struct bufferevent *bev) Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. More... bufferevent_mbedtls_get_ssl (struct bufferevent *bufev) Return the underlying mbedtls SSL * object for an SSL bufferevent. bufferevent_mbedtls_renegotiate (struct bufferevent *bev) Tells a bufferevent to begin SSL renegotiation. EVENT2_EXPORT_SYMBOL void bufferevent_mbedtls_set_allow_dirty_shutdown (struct bufferevent *bev, int allow_dirty_shutdown) Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_mbedtls_socket_new (struct event_base *base, evutil_socket_t fd, mbedtls_dyncontext *ssl, enum bufferevent_ssl_state state, int options) Create a new SSL bufferevent to send its data over an SSL * on a socket. More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_openssl_filter_new (struct event_base *base, struct bufferevent *underlying, struct ssl_st *ssl, enum bufferevent_ssl_state state, int options) Create a new SSL bufferevent to send its data over another bufferevent. More... EVENT2_EXPORT_SYMBOL int bufferevent_openssl_get_allow_dirty_shutdown (struct bufferevent *bev) Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. More... bufferevent_openssl_get_ssl (struct bufferevent *bufev) Return the underlying openssl SSL * object for an SSL bufferevent. EVENT2_EXPORT_SYMBOL void bufferevent_openssl_set_allow_dirty_shutdown (struct bufferevent *bev, int allow_dirty_shutdown) Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag. More... EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_openssl_socket_new (struct event_base *base, evutil_socket_t fd, struct ssl_st *ssl, enum bufferevent_ssl_state state, int options) Create a new SSL bufferevent to send its data over an SSL * on a socket. More... bufferevent_ssl_renegotiate (struct bufferevent *bev) Tells a bufferevent to begin SSL renegotiation.
+
+
OpenSSL support for bufferevents.
+
+
+
◆
+
+
+
+
+
+ #define BUFFEREVENT_SSL_BATCH_WRITE 2
+
+
+
+
+
Control writes in the SSL bufferevents.
+
By default SSL bufferevent will peek bytes from the buffer as the arrived. with respect to the segment boundaries in the buffer. However, by ignoring these segment boundaries number of packets to send can be decreased.
+
This flags will ignore the segment boundaries.
+
Useful in conjunction with http layer.
+
+
+
+
+
◆
+
+
+
+
+
+ #define BUFFEREVENT_SSL_DIRTY_SHUTDOWN 1
+
+
+
+
+
Control how to report dirty SSL shutdowns.
+
If the peer (or the network, or an attacker) closes the TCP connection before closing the SSL channel, and the protocol is SSL >= v3, this is a "dirty" shutdown. If BUFFEREVENT_SSL_DIRTY_SHUTDOWN is not set (default), this is reported as BEV_EVENT_ERROR.
+
If instead BUFFEREVENT_SSL_DIRTY_SHUTDOWN is set, a dirty shutdown is reported as BEV_EVENT_EOF.
+
(Note that if the protocol is < SSLv3, you will always receive BEV_EVENT_EOF, since SSL 2 and earlier cannot distinguish a secure connection close from a dirty one. This is one reason (among many) not to use SSL 2.)
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_mbedtls_filter_new
+ (
+ struct event_base *
+ base ,
+
+ struct bufferevent *
+ underlying ,
+
+ mbedtls_dyncontext *
+ ssl ,
+
+ enum bufferevent_ssl_state
+ state ,
+
+ int
+ options
+
+ )
+
+
+
+
+
Create a new SSL bufferevent to send its data over another bufferevent.
+
Parameters
+
+ base An event_base to use to detect reading and writing. It must also be the base for the underlying bufferevent. underlying A socket to use for this SSL ssl A SSL* object from openssl. state The current state of the SSL connection options One or more bufferevent_options
+
+
+
Returns A new bufferevent on success, or NULL on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_mbedtls_get_allow_dirty_shutdown
+ (
+ struct bufferevent *
+ bev )
+
+
+
+
+
Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
+
See also BUFFEREVENT_SSL_DIRTY_SHUTDOWN
+
Deprecated: This function is deprecated, use bufferevent_ssl_get_flags() instead.
+
See also bufferevent_ssl_get_flags()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_mbedtls_set_allow_dirty_shutdown
+ (
+ struct bufferevent *
+ bev ,
+
+ int
+ allow_dirty_shutdown
+
+ )
+
+
+
+
+
Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
+
See also BUFFEREVENT_SSL_DIRTY_SHUTDOWN
+
Deprecated: This function is deprecated, use bufferevent_ssl_set_flags() instead.
+
See also bufferevent_ssl_set_flags()
+
+
+
+
+
◆
+
+
+
+
+
Create a new SSL bufferevent to send its data over an SSL * on a socket.
+
Parameters
+
+ base An event_base to use to detect reading and writing fd A socket to use for this SSL ssl A SSL* object from mbedtls. state The current state of the SSL connection options One or more bufferevent_options
+
+
+
Returns A new bufferevent on success, or NULL on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_openssl_filter_new
+ (
+ struct event_base *
+ base ,
+
+ struct bufferevent *
+ underlying ,
+
+ struct ssl_st *
+ ssl ,
+
+ enum bufferevent_ssl_state
+ state ,
+
+ int
+ options
+
+ )
+
+
+
+
+
Create a new SSL bufferevent to send its data over another bufferevent.
+
Parameters
+
+ base An event_base to use to detect reading and writing. It must also be the base for the underlying bufferevent. underlying A socket to use for this SSL ssl A SSL* object from openssl. state The current state of the SSL connection options One or more bufferevent_options
+
+
+
Returns A new bufferevent on success, or NULL on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int bufferevent_openssl_get_allow_dirty_shutdown
+ (
+ struct bufferevent *
+ bev )
+
+
+
+
+
Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
+
See also BUFFEREVENT_SSL_DIRTY_SHUTDOWN
+
Deprecated: This function is deprecated, use bufferevent_ssl_get_flags() instead.
+
See also bufferevent_ssl_get_flags()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void bufferevent_openssl_set_allow_dirty_shutdown
+ (
+ struct bufferevent *
+ bev ,
+
+ int
+ allow_dirty_shutdown
+
+ )
+
+
+
+
+
Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
+
See also BUFFEREVENT_SSL_DIRTY_SHUTDOWN
+
Deprecated: This function is deprecated, use bufferevent_ssl_set_flags() instead.
+
See also bufferevent_ssl_set_flags()
+
+
+
+
+
◆
+
+
+
+
+
Create a new SSL bufferevent to send its data over an SSL * on a socket.
+
Parameters
+
+ base An event_base to use to detect reading and writing fd A socket to use for this SSL ssl A SSL* object from openssl. state The current state of the SSL connection options One or more bufferevent_options
+
+
+
Returns A new bufferevent on success, or NULL on failure.
+
+
+
+
libevent: event2/bufferevent_ssl.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #ifndef EVENT2_BUFFEREVENT_SSL_H_INCLUDED_
+
27 #define EVENT2_BUFFEREVENT_SSL_H_INCLUDED_
+
+
33 #include <event2/visibility.h>
+
34 #include <event2/event-config.h>
+
+
+
+
+
+
+
+
+
47 BUFFEREVENT_SSL_OPEN = 0,
+
48 BUFFEREVENT_SSL_CONNECTING = 1,
+
49 BUFFEREVENT_SSL_ACCEPTING = 2
+
+
+
67 #define BUFFEREVENT_SSL_DIRTY_SHUTDOWN 1
+
+
79 #define BUFFEREVENT_SSL_BATCH_WRITE 2
+
+
81 #if defined(EVENT__HAVE_OPENSSL) || defined(EVENT__HAVE_MBEDTLS)
+
+
+
89 ev_uint64_t bufferevent_ssl_get_flags(
struct bufferevent *bev);
+
+
97 ev_uint64_t bufferevent_ssl_set_flags(
struct bufferevent *bev, ev_uint64_t flags);
+
+
105 ev_uint64_t bufferevent_ssl_clear_flags(
struct bufferevent *bev, ev_uint64_t flags);
+
+
+
+
109 #if defined(EVENT__HAVE_OPENSSL) || defined(EVENT_IN_DOXYGEN_)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
168 int allow_dirty_shutdown);
+
+
+
+
+
+
+
+
+
+
+
+
+
184 #if defined(EVENT__HAVE_MBEDTLS) || defined(EVENT_IN_DOXYGEN_)
+
185 struct mbedtls_ssl_context;
+
186 struct mbedtls_ssl_config;
+
187 typedef struct mbedtls_ssl_context mbedtls_dyncontext;
+
+
+
+
+
+
204 mbedtls_dyncontext *ssl,
+
+
+
+
+
+
+
+
222 mbedtls_dyncontext *ssl,
+
+
+
+
+
+
+
+
244 int allow_dirty_shutdown);
+
+
+
248 struct mbedtls_ssl_context *
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL struct mbedtls_ssl_context * bufferevent_mbedtls_get_ssl(struct bufferevent *bufev)
Return the underlying mbedtls SSL * object for an SSL bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_openssl_get_allow_dirty_shutdown(struct bufferevent *bev)
Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
EVENT2_EXPORT_SYMBOL unsigned long bufferevent_get_mbedtls_error(struct bufferevent *bev)
Return the most recent MbedTLS error reported on an SSL bufferevent.
EVENT2_EXPORT_SYMBOL int bufferevent_mbedtls_get_allow_dirty_shutdown(struct bufferevent *bev)
Get value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
bufferevent_ssl_state
The state of an SSL object to be used when creating a new SSL bufferevent.
Definition: bufferevent_ssl.h:46
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL void bufferevent_mbedtls_dyncontext_free(mbedtls_dyncontext *ctx)
Deallocate heap-based MbedTLS context.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_openssl_filter_new(struct event_base *base, struct bufferevent *underlying, struct ssl_st *ssl, enum bufferevent_ssl_state state, int options)
Create a new SSL bufferevent to send its data over another bufferevent.
An opaque type for handling buffered IO.
Definition: bufferevent.h:114
EVENT2_EXPORT_SYMBOL int bufferevent_ssl_renegotiate(struct bufferevent *bev)
Tells a bufferevent to begin SSL renegotiation.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_mbedtls_filter_new(struct event_base *base, struct bufferevent *underlying, mbedtls_dyncontext *ssl, enum bufferevent_ssl_state state, int options)
Create a new SSL bufferevent to send its data over another bufferevent.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_openssl_socket_new(struct event_base *base, evutil_socket_t fd, struct ssl_st *ssl, enum bufferevent_ssl_state state, int options)
Create a new SSL bufferevent to send its data over an SSL * on a socket.
EVENT2_EXPORT_SYMBOL struct bufferevent * bufferevent_mbedtls_socket_new(struct event_base *base, evutil_socket_t fd, mbedtls_dyncontext *ssl, enum bufferevent_ssl_state state, int options)
Create a new SSL bufferevent to send its data over an SSL * on a socket.
EVENT2_EXPORT_SYMBOL void bufferevent_mbedtls_set_allow_dirty_shutdown(struct bufferevent *bev, int allow_dirty_shutdown)
Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
Functions for buffering data for network sending or receiving.
EVENT2_EXPORT_SYMBOL void bufferevent_openssl_set_allow_dirty_shutdown(struct bufferevent *bev, int allow_dirty_shutdown)
Set value of the BUFFEREVENT_SSL_DIRTY_SHUTDOWN flag.
EVENT2_EXPORT_SYMBOL int bufferevent_mbedtls_renegotiate(struct bufferevent *bev)
Tells a bufferevent to begin SSL renegotiation.
Common convenience functions for cross-platform portability and related socket manipulations.
EVENT2_EXPORT_SYMBOL mbedtls_dyncontext * bufferevent_mbedtls_dyncontext_new(struct mbedtls_ssl_config *conf)
Create a new heap-based MbedTLS context for use it in bufferevent_mbedtls_* functions.
EVENT2_EXPORT_SYMBOL unsigned long bufferevent_get_openssl_error(struct bufferevent *bev)
Return the most recent OpenSSL error reported on an SSL bufferevent.
EVENT2_EXPORT_SYMBOL struct ssl_st * bufferevent_openssl_get_ssl(struct bufferevent *bufev)
Return the underlying openssl SSL * object for an SSL bufferevent.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: Data Structure Index
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/closed.png b/closed.png
new file mode 100644
index 0000000..98cc2c9
Binary files /dev/null and b/closed.png differ
diff --git a/deprecated.html b/deprecated.html
new file mode 100644
index 0000000..2af42f7
--- /dev/null
+++ b/deprecated.html
@@ -0,0 +1,167 @@
+
+
+
+libevent: Deprecated List
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Global bufferevent_mbedtls_get_allow_dirty_shutdown (struct bufferevent *bev)
+Global bufferevent_mbedtls_set_allow_dirty_shutdown (struct bufferevent *bev, int allow_dirty_shutdown)
+Global bufferevent_new (evutil_socket_t fd, evbuffercb readcb, evbuffercb writecb, everrorcb errorcb, void *cbarg)
+bufferevent_socket_new() instead. Global bufferevent_openssl_get_allow_dirty_shutdown (struct bufferevent *bev)
+Global bufferevent_openssl_set_allow_dirty_shutdown (struct bufferevent *bev, int allow_dirty_shutdown)
+Global bufferevent_settimeout (struct bufferevent *bufev, int timeout_read, int timeout_write)
+Global evbuffer_readline (struct evbuffer *buffer)
+evbuffer_readln() . Global evbuffer_setcb (struct evbuffer *buffer, evbuffer_cb cb, void *cbarg)
+evbuffer_add() , evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others. Global evdns_add_server_port (evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data)
+evdns_add_server_port_with_base() . Global evdns_clear_nameservers_and_suspend (void)
+evdns_base_clear_nameservers_and_suspend() . Global evdns_count_nameservers (void)
+evdns_base_count_nameservers() . Global evdns_get_global_base (void)
+Global evdns_init (void)
+event_init() , and so is not safe for multithreaded use. Additionally, it allocates a global structure that only one thread can use. The replacement is evdns_base_new() . Global evdns_nameserver_add (unsigned long int address)
+evdns_base_nameserver_add() . Global evdns_nameserver_ip_add (const char *ip_as_string)
+evdns_base_nameserver_ip_add() . Global evdns_resolv_conf_parse (int flags, const char *const filename)
+evdns_base_resolv_conf_parse() . Global evdns_resolve_ipv4 (const char *name, int flags, evdns_callback_type callback, void *ptr)
+evdns_base_resolve_ipv4() . Global evdns_resolve_reverse (const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr)
+evdns_base_resolve_reverse() . Global evdns_resolve_reverse_ipv6 (const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr)
+evdns_base_resolve_reverse_ipv6() . Global evdns_resume (void)
+evdns_base_resume() . Global evdns_search_add (const char *domain)
+evdns_base_search_add() . Global evdns_search_clear (void)
+evdns_base_search_clear() . Global evdns_search_ndots_set (const int ndots)
+evdns_base_search_ndots_set() . Global evdns_set_option (const char *option, const char *val, int flags)
+evdns_base_set_option() . Global evdns_shutdown (int fail_requests)
+File event_compat.h
+Global event_dispatch (void)
+event_init() , and because it is not safe for multithreaded use. The replacement is event_base_dispatch() . Global event_get_method (void)
+event_base_get_method() . Its use is deprecated because it relies on the "current" base configured by event_init() . Global event_init (void)
+event_base , and is totally unsafe for multithreaded use. The replacement is event_base_new() . Global event_loop (int)
+event_base_loop() . Global event_loopbreak (void)
+event_base_loopbreak() . Global event_loopexit (const struct timeval *)
+event_base_loopexit() . Global event_once (evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *, const struct timeval *)
+event_base_once() . Its use is deprecated because it relies on the "current" base configured by event_init() . Global event_priority_init (int)
+event_init() , and because it is not safe for multithreaded use. The replacement is event_base_priority_init() . Global event_set (struct event *, evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *)
+event_set() is not recommended for new code, because it requires a subsequent call to event_base_set() to be safe under most circumstances. Use event_assign() or event_new() instead. Global evhttp_connection_new (const char *address, ev_uint16_t port)
+Global evhttp_connection_set_base (struct evhttp_connection *evcon, struct event_base *base)
+Global evhttp_decode_uri (const char *uri)
+Global evhttp_parse_query (const char *uri, struct evkeyvalq *headers)
+Global evhttp_start (const char *address, ev_uint16_t port)
+Module Misnamed functions
+Module signal_* macros
+Module timeout_* macros
+
+
+
libevent: event2 Directory Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+file buffer.h [code] Functions for buffering data for network sending or receiving. file buffer_compat.h [code] Obsolete and deprecated versions of the functions in buffer.h : provided only for backward compatibility. file bufferevent.h [code] Functions for buffering data for network sending or receiving. file bufferevent_compat.h [code] Deprecated versions of the functions in bufferevent.h : provided only for backwards compatibility. file bufferevent_ssl.h [code] OpenSSL support for bufferevents. file dns.h [code] Provides a few APIs to use for resolving DNS names, and a facility for implementing simple DNS servers. file dns_compat.h [code] Potentially non-threadsafe versions of the functions in dns.h : provided only for backwards compatibility. file event.h [code] Core functions for waiting for and receiving events, and using event bases. file event_compat.h [code] Potentially non-threadsafe versions of the functions in event.h : provided only for backwards compatibility. file http.h [code] Basic support for HTTP serving. file http_compat.h [code] Potentially non-threadsafe versions of the functions in http.h : provided only for backwards compatibility. file listener.h [code] A callback that we invoke when a listener has a new connection. file rpc.h [code] This header files provides basic support for an RPC server and client. file rpc_compat.h [code] Deprecated versions of the functions in rpc.h : provided only for backwards compatibility. file tag.h [code] Helper functions for reading and writing tagged data onto buffers. file tag_compat.h [code] Obsolete/deprecated functions from tag.h ; provided only for backwards compatibility. file thread.h [code] Functions for multi-threaded applications using Libevent. file util.h [code] Common convenience functions for cross-platform portability and related socket manipulations. file watch.h [code] "Prepare" and "check" watchers.
+
libevent: event2/dns.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Provides a few APIs to use for resolving DNS names, and a facility for implementing simple DNS servers.
+More...
+
#include <event2/visibility.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+DNS_CNAME 4 DNS_CNAME_CALLBACK 0x80 Make a separate callback for CNAME in answer. DNS_ERR_CANCEL 69 The request was canceled via a call to evdns_cancel_request. DNS_ERR_FORMAT 1 The name server was unable to interpret the query. #define DNS_ERR_NODATA 70 There were no answers and no error condition in the DNS packet. More... DNS_ERR_NONE 0 Error codes 0-5 are as described in RFC 1035. DNS_ERR_NOTEXIST 3 The domain name does not exist. DNS_ERR_NOTIMPL 4 The name server does not support the requested kind of query. DNS_ERR_REFUSED 5 The name server refuses to reform the specified operation for policy reasons. DNS_ERR_SERVERFAILED 2 The name server was unable to process this query due to a problem with the name server. DNS_ERR_SHUTDOWN 68 The request was canceled because the DNS subsystem was shut down. DNS_ERR_TIMEOUT 67 Communication with the server timed out. DNS_ERR_TRUNCATED 65 The reply was truncated or ill-formatted. DNS_ERR_UNKNOWN 66 An unknown error occurred. DNS_IPv4_A 1 DNS_IPv6_AAAA 3 DNS_NO_SEARCH DNS_QUERY_NO_SEARCH DNS_OPTION_HOSTSFILE 8 DNS_OPTION_MISC 4 DNS_OPTION_NAMESERVERS 2 DNS_OPTION_NAMESERVERS_NO_DEFAULT 16 DNS_OPTION_SEARCH 1 #define DNS_OPTIONS_ALL All above: More... DNS_PTR 2 DNS_QUERY_IGNTC 0x04 Ignore trancation flag in responses (don't fallback to TCP connections). DNS_QUERY_NO_SEARCH 0x01 Disable searching for the query. DNS_QUERY_USEVC 0x02 Use TCP connections ("virtual circuits") for queries rather than UDP datagrams. EVDNS_ADDITIONAL_SECTION 2 EVDNS_ANSWER_SECTION 0 EVDNS_AUTHORITY_SECTION 1 EVDNS_BASE_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED EVDNS_BASE_DISABLE_WHEN_INACTIVE 0x8000 Flag for evdns_base_new: Do not prevent the libevent event loop from exiting when we have no active dns requests. #define EVDNS_BASE_INITIALIZE_NAMESERVERS 1 Flag for evdns_base_new: process resolv.conf. More... #define EVDNS_BASE_NAMESERVERS_NO_DEFAULT 0x10000 Flag for evdns_base_new: If EVDNS_BASE_INITIALIZE_NAMESERVERS isset, do not add default nameserver if there are no nameservers in resolv.conf. More... EVDNS_CLASS_INET 1 EVDNS_ERROR_FAILED_TO_OPEN_FILE 1 EVDNS_ERROR_FAILED_TO_STAT_FILE 2 EVDNS_ERROR_FILE_TOO_LARGE 3 EVDNS_ERROR_NO_NAMESERVERS_CONFIGURED 6 EVDNS_ERROR_NONE 0 EVDNS_ERROR_OUT_OF_MEMORY 4 EVDNS_ERROR_SHORT_READ_FROM_FILE 5 EVDNS_FLAGS_AA 0x400 EVDNS_FLAGS_RD 0x080 EVDNS_QTYPE_ALL 255 EVDNS_QTYPE_AXFR 252 EVDNS_TYPE_A 1 EVDNS_TYPE_AAAA 28 EVDNS_TYPE_CNAME 5 EVDNS_TYPE_MX 15 EVDNS_TYPE_NS 2 EVDNS_TYPE_PTR 12 EVDNS_TYPE_SOA 6 EVDNS_TYPE_TXT 16
+EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port_with_base (struct event_base *base, evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data) Create a new UDP DNS server port. More... EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port_with_listener (struct event_base *base, struct evconnlistener *listener, int flags, evdns_request_callback_fn_type callback, void *user_data) Create a new TCP DNS server port. More... EVENT2_EXPORT_SYMBOL void evdns_base_clear_host_addresses (struct evdns_base *base) Remove all hosts entries that have been loaded into the event_base via evdns_base_load_hosts or via event_base_resolv_conf_parse. More... EVENT2_EXPORT_SYMBOL int evdns_base_clear_nameservers_and_suspend (struct evdns_base *base) Remove all configured nameservers, and suspend all pending resolves. More... EVENT2_EXPORT_SYMBOL int evdns_base_config_windows_nameservers (struct evdns_base *) Obtain nameserver information using the Windows API. More... EVENT2_EXPORT_SYMBOL int evdns_base_count_nameservers (struct evdns_base *base) Get the number of configured nameservers. More... EVENT2_EXPORT_SYMBOL void evdns_base_free (struct evdns_base *base, int fail_requests) Shut down the asynchronous DNS resolver and terminate all active requests. More... EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_addr (struct evdns_base *base, int idx, struct sockaddr *sa, ev_socklen_t len) Retrieve the address of the 'idx'th configured nameserver. More... EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_fd (struct evdns_base *base, int idx) Retrieve the fd of the 'idx'th configured nameserver. More... EVENT2_EXPORT_SYMBOL int evdns_base_load_hosts (struct evdns_base *base, const char *hosts_fname) Load an /etc/hosts-style file from 'hosts_fname' into 'base'. More... EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_add (struct evdns_base *base, unsigned long int address) Add a nameserver. More... EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_ip_add (struct evdns_base *base, const char *ip_as_string) Add a nameserver by string address. More... evdns_base_nameserver_sockaddr_add (struct evdns_base *base, const struct sockaddr *sa, ev_socklen_t len, unsigned flags) Add a nameserver by sockaddr. EVENT2_EXPORT_SYMBOL struct evdns_base * evdns_base_new (struct event_base *event_base , int flags) Initialize the asynchronous DNS library. More... EVENT2_EXPORT_SYMBOL int evdns_base_resolv_conf_parse (struct evdns_base *base, int flags, const char *const filename) Parse a resolv.conf file. More... EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_ipv4 (struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr) Lookup an A record for a given name. More... EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_ipv6 (struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr) Lookup an AAAA record for a given name. More... EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_reverse (struct evdns_base *base, const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr) Lookup a PTR record for a given IP address. More... EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_reverse_ipv6 (struct evdns_base *base, const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr) Lookup a PTR record for a given IPv6 address. More... EVENT2_EXPORT_SYMBOL int evdns_base_resume (struct evdns_base *base) Resume normal operation and continue any suspended resolve requests. More... EVENT2_EXPORT_SYMBOL void evdns_base_search_add (struct evdns_base *base, const char *domain) Add a domain to the list of search domains. More... evdns_base_search_clear (struct evdns_base *base) Clear the list of search domains. EVENT2_EXPORT_SYMBOL void evdns_base_search_ndots_set (struct evdns_base *base, const int ndots) Set the 'ndots' parameter for searches. More... EVENT2_EXPORT_SYMBOL int evdns_base_set_option (struct evdns_base *base, const char *option, const char *val) Set the value of a configuration option. More... EVENT2_EXPORT_SYMBOL void evdns_cancel_request (struct evdns_base *base, struct evdns_request *req) Cancels a pending DNS resolution request. More... evdns_close_server_port (struct evdns_server_port *port) Close down a DNS server port, and free associated structures. const EVENT2_EXPORT_SYMBOL char * evdns_err_to_string (int err) Convert a DNS error code to a string. More... EVENT2_EXPORT_SYMBOL struct evdns_getaddrinfo_request * evdns_getaddrinfo (struct evdns_base *dns_base, const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, evdns_getaddrinfo_cb cb, void *arg) Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'. More... evdns_getaddrinfo_cancel (struct evdns_getaddrinfo_request *req) EVENT2_EXPORT_SYMBOL int evdns_server_port_set_option (struct evdns_server_port *port, enum evdns_server_option option, size_t value) Configure DNS server. More... evdns_server_request_add_a_reply (struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl) evdns_server_request_add_aaaa_reply (struct evdns_server_request *req, const char *name, int n, const void *addrs, int ttl) evdns_server_request_add_cname_reply (struct evdns_server_request *req, const char *name, const char *cname, int ttl) evdns_server_request_add_ptr_reply (struct evdns_server_request *req, struct in_addr *in, const char *inaddr_name, const char *hostname, int ttl) evdns_server_request_add_reply (struct evdns_server_request *req, int section, const char *name, int type, int dns_class, int ttl, int datalen, int is_name, const char *data) evdns_server_request_drop (struct evdns_server_request *req) Free a DNS request without sending back a reply. evdns_server_request_get_requesting_addr (struct evdns_server_request *req, struct sockaddr *sa, int addr_len) Get the address that made a DNS request. evdns_server_request_respond (struct evdns_server_request *req, int err) Send back a response to a DNS request, and free the request structure. EVENT2_EXPORT_SYMBOL void evdns_server_request_set_flags (struct evdns_server_request *req, int flags) Sets some flags in a reply we're building. More... EVENT2_EXPORT_SYMBOL void evdns_set_log_fn (evdns_debug_log_fn_type fn) Set the callback function to handle DNS log messages. More...
+
+
Provides a few APIs to use for resolving DNS names, and a facility for implementing simple DNS servers.
+
Welcome, gentle reader
+
Async DNS lookups are really a whole lot harder than they should be, mostly stemming from the fact that the libc resolver has never been very good at them. Before you use this library you should see if libc can do the job for you with the modern async call getaddrinfo_a (see http://www.imperialviolet.org/page25.html#e498 ). Otherwise, please continue.
+
The library keeps track of the state of nameservers and will avoid them when they go down. Otherwise it will round robin between them.
+
Quick start guide:
#include "evdns.h"
+
void callback(int result, char type, int count, int ttl,
+
void *addresses, void *arg);
+
+
evdns_resolve("www.hostname.com" , 0, callback, NULL);
+
When the lookup is complete the callback function is called. The first argument will be one of the DNS_ERR_* defines in evdns.h. Hopefully it will be DNS_ERR_NONE, in which case type will be DNS_IPv4_A, count will be the number of IP addresses, ttl is the time which the data can be cached for (in seconds), addresses will point to an array of uint32_t's and arg will be whatever you passed to evdns_resolve.
+
Searching:
+
In order for this library to be a good replacement for glibc's resolver it supports searching. This involves setting a list of default domains, in which names will be queried for. The number of dots in the query name determines the order in which this list is used.
+
Searching appears to be a single lookup from the point of view of the API, although many DNS queries may be generated from a single call to evdns_resolve. Searching can also drastically slow down the resolution of names.
+
To disable searching:
+Never set it up. If you never call evdns_resolv_conf_parse or evdns_search_add then no searching will occur.
+If you do call evdns_resolv_conf_parse then don't pass DNS_OPTION_SEARCH (or DNS_OPTIONS_ALL, which implies it).
+When calling evdns_resolve, pass the DNS_QUERY_NO_SEARCH flag.
+
+
The order of searches depends on the number of dots in the name. If the number is greater than the ndots setting then the names is first tried globally. Otherwise each search domain is appended in turn.
+
The ndots setting can either be set from a resolv.conf, or by calling evdns_search_ndots_set.
+
For example, with ndots set to 1 (the default) and a search domain list of ["myhome.net"]:
+
+ Query: www
+ Order: www.myhome.net, www. Query: www.abc
+ Order: www.abc., www.abc.myhome.net
+ Internals:
+
Requests are kept in two queues. The first is the inflight queue. In this queue requests have an allocated transaction id and nameserver. They will soon be transmitted if they haven't already been.
+
The second is the waiting queue. The size of the inflight ring is limited and all other requests wait in waiting queue for space. This bounds the number of concurrent requests so that we don't flood the nameserver. Several algorithms require a full walk of the inflight queue and so bounding its size keeps thing going nicely under huge (many thousands of requests) loads.
+
If a nameserver loses too many requests it is considered down and we try not to use it. After a while we send a probe to that nameserver (a lookup for google.com) and, if it replies, we consider it working again. If the nameserver fails a probe we wait longer to try again with the next probe.
+
+
+
◆
+
+
+
+
+
+ #define DNS_ERR_NODATA 70
+
+
+
+
+
There were no answers and no error condition in the DNS packet.
+
This can happen when you ask for an address that exists, but a record type that doesn't.
+
+
+
+
+
◆
+
+
+
+
+
+ #define DNS_OPTIONS_ALL
+
+
+
+
Value: ( \
+
DNS_OPTION_SEARCH | \
+
DNS_OPTION_NAMESERVERS | \
+
DNS_OPTION_MISC | \
+
DNS_OPTION_HOSTSFILE | \
+
0 \
+
)
+
+
All above:
+
+DNS_OPTION_SEARCH
+DNS_OPTION_NAMESERVERS
+DNS_OPTION_MISC
+DNS_OPTION_HOSTSFILE
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVDNS_BASE_INITIALIZE_NAMESERVERS 1
+
+
+
+
+
Flag for evdns_base_new: process resolv.conf.
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVDNS_BASE_NAMESERVERS_NO_DEFAULT 0x10000
+
+
+
+
+
Flag for evdns_base_new: If EVDNS_BASE_INITIALIZE_NAMESERVERS isset, do not add default nameserver if there are no nameservers in resolv.conf.
+
See also DNS_OPTION_NAMESERVERS_NO_DEFAULT
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evdns_callback_type) (int result, char type, int count, int ttl, void *addresses, void *arg)
+
+
+
+
+
The callback that contains the results from a lookup.
+
+result is one of the DNS_ERR_* values (DNS_ERR_NONE for success)
+type is either DNS_IPv4_A or DNS_PTR or DNS_IPv6_AAAA
+count contains the number of addresses of form type
+ttl is the number of seconds the resolution may be cached for.
+addresses needs to be cast according to type. It will be an array of 4-byte sequences for ipv4, or an array of 16-byte sequences for ipv6, or a nul-terminated string for PTR.
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evdns_debug_log_fn_type) (int is_warning, const char *msg)
+
+
+
+
+
A callback that is invoked when a log message is generated.
+
Parameters
+
+ is_warning indicates if the log message is a 'warning' msg the content of the log message
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evdns_request_callback_fn_type) (struct evdns_server_request *, void *)
+
+
+
+
+
A callback to implement a DNS server.
+
The callback function receives a DNS request. It should then optionally add a number of answers to the reply using the evdns_server_request_add_*_reply functions, before calling either evdns_server_request_respond to send the reply back, or evdns_server_request_drop to decline to answer the request.
+
Parameters
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
List of configurable evdns_server_port options.
+
See also evdns_server_port_set_option()
+
+Enumerator Maximum number of simultaneous tcp connections (clients) that server can hold.
+Can be set only for TCP DNS servers.
+Idle timeout (in seconds) of incoming TCP connections.
+If client doesn't send any requests via the connection during this period connection is closed by the server. Can be set only for TCP DNS servers.
+
+
+
+
+
+
+
◆
+
+
+
+
+
Create a new UDP DNS server port.
+
Parameters
+
+ base The event base to handle events for the server port. socket A UDP socket to accept DNS requests. flags Always 0 for now. callback A function to invoke whenever we get a DNS request on the socket. user_data Data to pass to the callback.
+
+
+
Returns an evdns_server_port structure for this server port or NULL if an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_server_port* evdns_add_server_port_with_listener
+ (
+ struct event_base *
+ base ,
+
+ struct evconnlistener *
+ listener ,
+
+ int
+ flags ,
+
+ evdns_request_callback_fn_type callback ,
+
+ void *
+ user_data
+
+ )
+
+
+
+
+
Create a new TCP DNS server port.
+
Parameters
+
+ base The event base to handle events for the server port. listener A TCP listener to accept DNS requests. flags Always 0 for now. callback A function to invoke whenever we get a DNS request on the socket. user_data Data to pass to the callback.
+
+
+
Returns an evdns_server_port structure for this server port or NULL if an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_base_clear_host_addresses
+ (
+ struct evdns_base *
+ base )
+
+
+
+
+
Remove all hosts entries that have been loaded into the event_base via evdns_base_load_hosts or via event_base_resolv_conf_parse.
+
Parameters
+
+ base the evdns base to remove outdated host addresses from
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_clear_nameservers_and_suspend
+ (
+ struct evdns_base *
+ base )
+
+
+
+
+
Remove all configured nameservers, and suspend all pending resolves.
+
Resolves will not necessarily be re-attempted until evdns_base_resume() is called.
+
Parameters
+
+ base the evdns_base to which to apply this operation
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_base_resume()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_config_windows_nameservers
+ (
+ struct evdns_base *
+ )
+
+
+
+
+
Obtain nameserver information using the Windows API.
+
Attempt to configure a set of nameservers based on platform settings on a win32 host. Preferentially tries to use GetNetworkParams; if that fails, looks in the registry.
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resolv_conf_parse()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_count_nameservers
+ (
+ struct evdns_base *
+ base )
+
+
+
+
+
Get the number of configured nameservers.
+
This returns the number of configured nameservers (not necessarily the number of running nameservers). This is useful for double-checking whether our calls to the various nameserver configuration functions have been successful.
+
Parameters
+
+ base the evdns_base to which to apply this operation
+
+
+
Returns the number of configured nameservers
+
See also evdns_base_nameserver_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_base_free
+ (
+ struct evdns_base *
+ base ,
+
+ int
+ fail_requests
+
+ )
+
+
+
+
+
Shut down the asynchronous DNS resolver and terminate all active requests.
+
If the 'fail_requests' option is enabled, all active requests will return an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, the requests will be silently discarded.
+
Parameters
+
+ base the evdns base to free fail_requests if zero, active requests will be aborted; if non-zero, active requests will return DNS_ERR_SHUTDOWN.
+
+
+
See also evdns_base_new()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_addr
+ (
+ struct evdns_base *
+ base ,
+
+ int
+ idx ,
+
+ struct sockaddr *
+ sa ,
+
+ ev_socklen_t
+ len
+
+ )
+
+
+
+
+
Retrieve the address of the 'idx'th configured nameserver.
+
Parameters
+
+ base The evdns_base to examine. idx The index of the nameserver to get the address of. sa A location to receive the server's address. len The number of bytes available at sa.
+
+
+
Returns the number of bytes written into sa on success. On failure, returns -1 if idx is greater than the number of configured nameservers, or a value greater than 'len' if len was not high enough.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_fd
+ (
+ struct evdns_base *
+ base ,
+
+ int
+ idx
+
+ )
+
+
+
+
+
Retrieve the fd of the 'idx'th configured nameserver.
+
Parameters
+
+ base The evdns_base to examine. idx The index of the nameserver to get the address of.
+
+
+
Returns the fd value. On failure, returns -1 if idx is greater than the number of configured nameservers
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_load_hosts
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ hosts_fname
+
+ )
+
+
+
+
+
Load an /etc/hosts-style file from 'hosts_fname' into 'base'.
+
If hosts_fname is NULL, add minimal entries for localhost, and nothing else.
+
Note that only evdns_getaddrinfo uses the /etc/hosts entries.
+
This function does not replace previously loaded hosts entries; to do that, call evdns_base_clear_host_addresses first.
+
Return 0 on success, negative on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_add
+ (
+ struct evdns_base *
+ base ,
+
+ unsigned long int
+ address
+
+ )
+
+
+
+
+
Add a nameserver.
+
The address should be an IPv4 address in network byte order. The type of address is chosen so that it matches in_addr.s_addr.
+
Parameters
+
+ base the evdns_base to which to add the name server address an IP address in network byte order
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_base_nameserver_ip_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_ip_add
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ ip_as_string
+
+ )
+
+
+
+
+
Add a nameserver by string address.
+
This function parses a n IPv4 or IPv6 address from a string and adds it as a nameserver. It supports the following formats:
+[IPv6Address]:port
+[IPv6Address]
+IPv6Address
+IPv4Address:port
+IPv4Address
+
+
If no port is specified, it defaults to 53.
+
Parameters
+
+ base the evdns_base to which to apply this operation
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_base_nameserver_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_base* evdns_base_new
+ (
+ struct event_base *
+ event_base ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
Initialize the asynchronous DNS library.
+
This function initializes support for non-blocking name resolution by calling evdns_resolv_conf_parse() on UNIX and evdns_config_windows_nameservers() on Windows.
+
Parameters
+
+ event_base the event base to associate the dns client with flags any of EVDNS_BASE_INITIALIZE_NAMESERVERS| EVDNS_BASE_DISABLE_WHEN_INACTIVE|EVDNS_BASE_NAMESERVERS_NO_DEFAULT
+
+
+
Returns evdns_base object if successful, or NULL if an error occurred.
+
See also evdns_base_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_resolv_conf_parse
+ (
+ struct evdns_base *
+ base ,
+
+ int
+ flags ,
+
+ const char *const
+ filename
+
+ )
+
+
+
+
+
Parse a resolv.conf file.
+
The 'flags' parameter determines what information is parsed from the resolv.conf file. See the man page for resolv.conf for the format of this file.
+
The following directives are not parsed from the file: sortlist, rotate, no-check-names, inet6, debug.
+
If this function encounters an error, the possible return values are: EVDNS_ERROR_FAILED_TO_OPEN_FILE (1) - failed to open file EVDNS_ERROR_FAILED_TO_STAT_FILE (2) - failed to stat file EVDNS_ERROR_FILE_TOO_LARGE (3) - file too large EVDNS_ERROR_OUT_OF_MEMORY (4) - out of memory EVDNS_ERROR_SHORT_READ_FROM_FILE (5) - short read from file EVDNS_ERROR_NO_NAMESERVERS_CONFIGURED (6) - no nameservers configured.
+
Parameters
+
+ base the evdns_base to which to apply this operation flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| DNS_OPTION_HOSTSFILE|DNS_OPTIONS_ALL|DNS_OPTION_NAMESERVERS_NO_DEFAULT filename the path to the resolv.conf file
+
+
+
Returns 0 if successful, or various positive error codes if an error occurred (see above)
+
See also resolv.conf(3), evdns_config_windows_nameservers()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_request* evdns_base_resolve_ipv4
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ name ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup an A record for a given name.
+
Parameters
+
+ base the evdns_base to which to apply this operation name a DNS hostname flags either 0, or combination of DNS_QUERY_* flags. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns an evdns_request object if successful, or NULL if an error occurred.
+
See also evdns_resolve_ipv6() , evdns_resolve_reverse() , evdns_resolve_reverse_ipv6() , evdns_cancel_request()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_request* evdns_base_resolve_ipv6
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ name ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup an AAAA record for a given name.
+
Parameters
+
+ base the evdns_base to which to apply this operation name a DNS hostname flags either 0, or combination of DNS_QUERY_* flags. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns an evdns_request object if successful, or NULL if an error occurred.
+
See also evdns_resolve_ipv4() , evdns_resolve_reverse() , evdns_resolve_reverse_ipv6() , evdns_cancel_request()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_request* evdns_base_resolve_reverse
+ (
+ struct evdns_base *
+ base ,
+
+ const struct in_addr *
+ in ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup a PTR record for a given IP address.
+
Parameters
+
+ base the evdns_base to which to apply this operation in an IPv4 address flags either 0, or combination of DNS_QUERY_* flags. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns an evdns_request object if successful, or NULL if an error occurred.
+
See also evdns_resolve_reverse_ipv6() , evdns_cancel_request()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_request* evdns_base_resolve_reverse_ipv6
+ (
+ struct evdns_base *
+ base ,
+
+ const struct in6_addr *
+ in ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup a PTR record for a given IPv6 address.
+
Parameters
+
+ base the evdns_base to which to apply this operation in an IPv6 address flags either 0, or combination of DNS_QUERY_* flags. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns an evdns_request object if successful, or NULL if an error occurred.
+
See also evdns_resolve_reverse_ipv6() , evdns_cancel_request()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_resume
+ (
+ struct evdns_base *
+ base )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_base_search_add
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ domain
+
+ )
+
+
+
+
+
Add a domain to the list of search domains.
+
Parameters
+
+ domain the domain to be added to the search list
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_base_search_ndots_set
+ (
+ struct evdns_base *
+ base ,
+
+ const int
+ ndots
+
+ )
+
+
+
+
+
Set the 'ndots' parameter for searches.
+
Sets the number of dots which, when found in a name, causes the first query to be without any search domain.
+
Parameters
+
+ ndots the new ndots parameter
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_base_set_option
+ (
+ struct evdns_base *
+ base ,
+
+ const char *
+ option ,
+
+ const char *
+ val
+
+ )
+
+
+
+
+
Set the value of a configuration option.
+
The currently available configuration options are:
+
ndots, timeout, max-timeouts, max-inflight, attempts, randomize-case, bind-to, initial-probe-timeout, max-probe-timeout, probe-backoff-factor, getaddrinfo-allow-skew, so-rcvbuf, so-sndbuf, tcp-idle-timeout, use-vc, ignore-tc, edns-udp-size.
+
+probe-backoff-factor Backoff factor of probe timeout
+max-probe-timeout Maximum timeout between two probe packets will change initial-probe-timeout when this value is smaller
+
+
In versions before Libevent 2.0.3-alpha, the option name needed to end with a colon.
+
In case of options without values (use-vc, ingore-tc) val should be an empty string or NULL.
+
Parameters
+
+ base the evdns_base to which to apply this operation option the name of the configuration option to be modified val the value to be set
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_cancel_request
+ (
+ struct evdns_base *
+ base ,
+
+ struct evdns_request *
+ req
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* evdns_err_to_string
+ (
+ int
+ err )
+
+
+
+
+
Convert a DNS error code to a string.
+
Parameters
+
+ err the DNS error code
+
+
+
Returns a string containing an explanation of the error code
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_getaddrinfo_request* evdns_getaddrinfo
+ (
+ struct evdns_base *
+ dns_base ,
+
+ const char *
+ nodename ,
+
+ const char *
+ servname ,
+
+ const struct evutil_addrinfo *
+ hints_in ,
+
+ evdns_getaddrinfo_cb cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'.
+
If we can answer the request immediately (with an error or not!), then we invoke cb immediately and return NULL. Otherwise we return an evdns_getaddrinfo_request and invoke cb later.
+
When the callback is invoked, we pass as its first argument the error code that getaddrinfo would return (or 0 for no error). As its second argument, we pass the evutil_addrinfo structures we found (or NULL on error). We pass 'arg' as the third argument.
+
Limitations:
+
+The AI_V4MAPPED and AI_ALL flags are not currently implemented.
+For ai_socktype, we only handle SOCKTYPE_STREAM, SOCKTYPE_UDP, and 0.
+For ai_protocol, we only handle IPPROTO_TCP, IPPROTO_UDP, and 0.
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_server_port_set_option
+ (
+ struct evdns_server_port *
+ port ,
+
+ enum evdns_server_option
+ option ,
+
+ size_t
+ value
+
+ )
+
+
+
+
+
Configure DNS server.
+
Parameters
+
+ port the evdns_server_port to which to apply this operation option
+
+
+
See also evdns_server_option for the list of possible options
+
Parameters
+
+ val value of the option
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_server_request_set_flags
+ (
+ struct evdns_server_request *
+ req ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
Sets some flags in a reply we're building.
+
Allows setting of the AA or RD flags
+
+
+
+
+
◆
+
+
+
+
+
Set the callback function to handle DNS log messages.
+
If this callback is not set, evdns log messages are handled with the regular Libevent logging system.
+
Parameters
+
+ fn the callback to be invoked when a log message is generated
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evdns_resolv_conf_parse(int flags, const char *const filename)
Parse a resolv.conf file.
#define DNS_OPTIONS_ALL
All above:
Definition: dns.h:225
libevent: event2/dns.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
141 #ifndef EVENT2_DNS_H_INCLUDED_
+
142 #define EVENT2_DNS_H_INCLUDED_
+
+
144 #include <event2/visibility.h>
+
+
+
+
+
+
+
+
+
154 #define DNS_ERR_NONE 0
+
+
156 #define DNS_ERR_FORMAT 1
+
+
159 #define DNS_ERR_SERVERFAILED 2
+
+
161 #define DNS_ERR_NOTEXIST 3
+
+
163 #define DNS_ERR_NOTIMPL 4
+
+
166 #define DNS_ERR_REFUSED 5
+
+
168 #define DNS_ERR_TRUNCATED 65
+
+
170 #define DNS_ERR_UNKNOWN 66
+
+
172 #define DNS_ERR_TIMEOUT 67
+
+
174 #define DNS_ERR_SHUTDOWN 68
+
+
176 #define DNS_ERR_CANCEL 69
+
+
180 #define DNS_ERR_NODATA 70
+
+
+
+
184 #define DNS_IPv6_AAAA 3
+
+
+
188 #define DNS_QUERY_NO_SEARCH 0x01
+
+
190 #define DNS_QUERY_USEVC 0x02
+
+
192 #define DNS_QUERY_IGNTC 0x04
+
+
194 #define DNS_CNAME_CALLBACK 0x80
+
+
+
197 #define DNS_OPTION_SEARCH 1
+
+
199 #define DNS_OPTION_NAMESERVERS 2
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
215 #define DNS_OPTION_MISC 4
+
+
217 #define DNS_OPTION_HOSTSFILE 8
+
+
225 #define DNS_OPTIONS_ALL ( \
+
226 DNS_OPTION_SEARCH | \
+
227 DNS_OPTION_NAMESERVERS | \
+
+
229 DNS_OPTION_HOSTSFILE | \
+
+
+
+
+
234 #define DNS_OPTION_NAMESERVERS_NO_DEFAULT 16
+
+
+
237 #define DNS_NO_SEARCH DNS_QUERY_NO_SEARCH
+
+
249 typedef void (*
evdns_callback_type ) (
int result,
char type,
int count,
int ttl,
void *addresses,
void *arg);
+
+
+
+
+
255 #define EVDNS_BASE_INITIALIZE_NAMESERVERS 1
+
+
258 #define EVDNS_BASE_DISABLE_WHEN_INACTIVE 0x8000
+
+
262 #define EVDNS_BASE_NAMESERVERS_NO_DEFAULT 0x10000
+
+
+
265 #define EVDNS_ERROR_NONE 0
+
+
267 #define EVDNS_ERROR_FAILED_TO_OPEN_FILE 1
+
+
269 #define EVDNS_ERROR_FAILED_TO_STAT_FILE 2
+
+
271 #define EVDNS_ERROR_FILE_TOO_LARGE 3
+
+
273 #define EVDNS_ERROR_OUT_OF_MEMORY 4
+
+
275 #define EVDNS_ERROR_SHORT_READ_FROM_FILE 5
+
+
277 #define EVDNS_ERROR_NO_NAMESERVERS_CONFIGURED 6
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
343 unsigned long int address);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
405 const char *ip_as_string);
+
+
+
+
+
413 const struct sockaddr *sa, ev_socklen_t len,
unsigned flags);
+
+
415 struct evdns_request;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
564 #if defined(EVENT_IN_DOXYGEN_) || defined(_WIN32)
+
+
+
+
577 #define EVDNS_BASE_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
631 struct evdns_server_request;
+
632 struct evdns_server_question;
+
+
+
646 #define EVDNS_ANSWER_SECTION 0
+
647 #define EVDNS_AUTHORITY_SECTION 1
+
648 #define EVDNS_ADDITIONAL_SECTION 2
+
+
650 #define EVDNS_TYPE_A 1
+
651 #define EVDNS_TYPE_NS 2
+
652 #define EVDNS_TYPE_CNAME 5
+
653 #define EVDNS_TYPE_SOA 6
+
654 #define EVDNS_TYPE_PTR 12
+
655 #define EVDNS_TYPE_MX 15
+
656 #define EVDNS_TYPE_TXT 16
+
657 #define EVDNS_TYPE_AAAA 28
+
+
659 #define EVDNS_QTYPE_AXFR 252
+
660 #define EVDNS_QTYPE_ALL 255
+
+
662 #define EVDNS_CLASS_INET 1
+
+
+
665 #define EVDNS_FLAGS_AA 0x400
+
666 #define EVDNS_FLAGS_RD 0x080
+
+
+
+
+
682 struct evconnlistener;
+
+
+
+
697 struct event_base *base,
struct evconnlistener *listener,
int flags,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
744 int evdns_server_request_add_reply(
struct evdns_server_request *req,
int section,
const char *name,
int type,
int dns_class,
int ttl,
int datalen,
int is_name,
const char *data);
+
+
746 int evdns_server_request_add_a_reply(
struct evdns_server_request *req,
const char *name,
int n,
const void *addrs,
int ttl);
+
+
748 int evdns_server_request_add_aaaa_reply(
struct evdns_server_request *req,
const char *name,
int n,
const void *addrs,
int ttl);
+
+
750 int evdns_server_request_add_ptr_reply(
struct evdns_server_request *req,
struct in_addr *in,
const char *inaddr_name,
const char *hostname,
int ttl);
+
+
752 int evdns_server_request_add_cname_reply(
struct evdns_server_request *req,
const char *name,
const char *cname,
int ttl);
+
+
+
+
+
+
+
+
+
+
+
+
+
775 struct evdns_getaddrinfo_request;
+
+
+
795 struct evdns_base *dns_base,
+
796 const char *nodename,
const char *servname,
+
+
+
+
+
+
+
+
804 void evdns_getaddrinfo_cancel(
struct evdns_getaddrinfo_request *req);
+
+
+
+
820 struct sockaddr *sa, ev_socklen_t len);
+
+
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_sockaddr_add(struct evdns_base *base, const struct sockaddr *sa, ev_socklen_t len, unsigned flags)
Add a nameserver by sockaddr.
EVENT2_EXPORT_SYMBOL int evdns_server_request_get_requesting_addr(struct evdns_server_request *req, struct sockaddr *sa, int addr_len)
Get the address that made a DNS request.
void(* evdns_getaddrinfo_cb)(int result, struct evutil_addrinfo *res, void *arg)
Callback for evdns_getaddrinfo.
Definition: dns.h:772
EVENT2_EXPORT_SYMBOL int evdns_base_resume(struct evdns_base *base)
Resume normal operation and continue any suspended resolve requests.
EVENT2_EXPORT_SYMBOL void evdns_close_server_port(struct evdns_server_port *port)
Close down a DNS server port, and free associated structures.
void(* evdns_debug_log_fn_type)(int is_warning, const char *msg)
A callback that is invoked when a log message is generated.
Definition: dns.h:614
EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_addr(struct evdns_base *base, int idx, struct sockaddr *sa, ev_socklen_t len)
Retrieve the address of the 'idx'th configured nameserver.
EVENT2_EXPORT_SYMBOL int evdns_server_request_respond(struct evdns_server_request *req, int err)
Send back a response to a DNS request, and free the request structure.
evdns_server_option
List of configurable evdns_server_port options.
Definition: dns.h:709
EVENT2_EXPORT_SYMBOL void evdns_base_clear_host_addresses(struct evdns_base *base)
Remove all hosts entries that have been loaded into the event_base via evdns_base_load_hosts or via e...
EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_ipv4(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr)
Lookup an A record for a given name.
EVENT2_EXPORT_SYMBOL int evdns_server_request_drop(struct evdns_server_request *req)
Free a DNS request without sending back a reply.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
@ EVDNS_SOPT_TCP_MAX_CLIENTS
Maximum number of simultaneous tcp connections (clients) that server can hold.
Definition: dns.h:714
EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_ipv6(struct evdns_base *base, const char *name, int flags, evdns_callback_type callback, void *ptr)
Lookup an AAAA record for a given name.
EVENT2_EXPORT_SYMBOL int evdns_base_load_hosts(struct evdns_base *base, const char *hosts_fname)
Load an /etc/hosts-style file from 'hosts_fname' into 'base'.
EVENT2_EXPORT_SYMBOL int evdns_base_get_nameserver_fd(struct evdns_base *base, int idx)
Retrieve the fd of the 'idx'th configured nameserver.
EVENT2_EXPORT_SYMBOL void evdns_base_search_ndots_set(struct evdns_base *base, const int ndots)
Set the 'ndots' parameter for searches.
EVENT2_EXPORT_SYMBOL void evdns_cancel_request(struct evdns_base *base, struct evdns_request *req)
Cancels a pending DNS resolution request.
EVENT2_EXPORT_SYMBOL void evdns_base_search_clear(struct evdns_base *base)
Clear the list of search domains.
EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_reverse(struct evdns_base *base, const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr)
Lookup a PTR record for a given IP address.
EVENT2_EXPORT_SYMBOL int evdns_base_resolv_conf_parse(struct evdns_base *base, int flags, const char *const filename)
Parse a resolv.conf file.
EVENT2_EXPORT_SYMBOL void evdns_base_free(struct evdns_base *base, int fail_requests)
Shut down the asynchronous DNS resolver and terminate all active requests.
@ EVDNS_SOPT_TCP_IDLE_TIMEOUT
Idle timeout (in seconds) of incoming TCP connections.
Definition: dns.h:721
EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port_with_base(struct event_base *base, evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data)
Create a new UDP DNS server port.
void(* evdns_request_callback_fn_type)(struct evdns_server_request *, void *)
A callback to implement a DNS server.
Definition: dns.h:645
EVENT2_EXPORT_SYMBOL struct evdns_request * evdns_base_resolve_reverse_ipv6(struct evdns_base *base, const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr)
Lookup a PTR record for a given IPv6 address.
EVENT2_EXPORT_SYMBOL void evdns_set_log_fn(evdns_debug_log_fn_type fn)
Set the callback function to handle DNS log messages.
void(* evdns_callback_type)(int result, char type, int count, int ttl, void *addresses, void *arg)
The callback that contains the results from a lookup.
Definition: dns.h:249
EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port_with_listener(struct event_base *base, struct evconnlistener *listener, int flags, evdns_request_callback_fn_type callback, void *user_data)
Create a new TCP DNS server port.
EVENT2_EXPORT_SYMBOL int evdns_base_config_windows_nameservers(struct evdns_base *)
Obtain nameserver information using the Windows API.
EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_ip_add(struct evdns_base *base, const char *ip_as_string)
Add a nameserver by string address.
EVENT2_EXPORT_SYMBOL struct evdns_getaddrinfo_request * evdns_getaddrinfo(struct evdns_base *dns_base, const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, evdns_getaddrinfo_cb cb, void *arg)
Make a non-blocking getaddrinfo request using the dns_base in 'dns_base'.
EVENT2_EXPORT_SYMBOL struct evdns_base * evdns_base_new(struct event_base *event_base, int flags)
Initialize the asynchronous DNS library.
EVENT2_EXPORT_SYMBOL void evdns_base_search_add(struct evdns_base *base, const char *domain)
Add a domain to the list of search domains.
EVENT2_EXPORT_SYMBOL int evdns_base_set_option(struct evdns_base *base, const char *option, const char *val)
Set the value of a configuration option.
Common convenience functions for cross-platform portability and related socket manipulations.
const EVENT2_EXPORT_SYMBOL char * evdns_err_to_string(int err)
Convert a DNS error code to a string.
EVENT2_EXPORT_SYMBOL int evdns_base_nameserver_add(struct evdns_base *base, unsigned long int address)
Add a nameserver.
A definition of struct addrinfo for systems that lack it.
Definition: util.h:707
EVENT2_EXPORT_SYMBOL int evdns_base_count_nameservers(struct evdns_base *base)
Get the number of configured nameservers.
EVENT2_EXPORT_SYMBOL void evdns_server_request_set_flags(struct evdns_server_request *req, int flags)
Sets some flags in a reply we're building.
EVENT2_EXPORT_SYMBOL int evdns_base_clear_nameservers_and_suspend(struct evdns_base *base)
Remove all configured nameservers, and suspend all pending resolves.
EVENT2_EXPORT_SYMBOL int evdns_server_port_set_option(struct evdns_server_port *port, enum evdns_server_option option, size_t value)
Configure DNS server.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: event2/dns_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Potentially non-threadsafe versions of the functions in dns.h : provided only for backwards compatibility.
+More...
+
#include <event2/event-config.h>
+
#include <event2/util.h >
+
#include <event2/visibility.h>
+
+
Go to the source code of this file.
+
+EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port (evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data) As evdns_server_new_with_base. More... EVENT2_EXPORT_SYMBOL int evdns_clear_nameservers_and_suspend (void) Remove all configured nameservers, and suspend all pending resolves. More... EVENT2_EXPORT_SYMBOL int evdns_count_nameservers (void) Get the number of configured nameservers. More... EVENT2_EXPORT_SYMBOL struct evdns_base * evdns_get_global_base (void) Return the global evdns_base created by event_init() and used by the other deprecated functions. More... EVENT2_EXPORT_SYMBOL int evdns_init (void) Initialize the asynchronous DNS library. More... EVENT2_EXPORT_SYMBOL int evdns_nameserver_add (unsigned long int address) Add a nameserver. More... EVENT2_EXPORT_SYMBOL int evdns_nameserver_ip_add (const char *ip_as_string) Add a nameserver. More... EVENT2_EXPORT_SYMBOL int evdns_resolv_conf_parse (int flags, const char *const filename) Parse a resolv.conf file. More... EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv4 (const char *name, int flags, evdns_callback_type callback, void *ptr) Lookup an A record for a given name. More... EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv6 (const char *name, int flags, evdns_callback_type callback, void *ptr) Lookup an AAAA record for a given name. More... EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse (const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr) Lookup a PTR record for a given IP address. More... EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse_ipv6 (const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr) Lookup a PTR record for a given IPv6 address. More... EVENT2_EXPORT_SYMBOL int evdns_resume (void) Resume normal operation and continue any suspended resolve requests. More... EVENT2_EXPORT_SYMBOL void evdns_search_add (const char *domain) Add a domain to the list of search domains. More... EVENT2_EXPORT_SYMBOL void evdns_search_clear (void) Clear the list of search domains. More... EVENT2_EXPORT_SYMBOL void evdns_search_ndots_set (const int ndots) Set the 'ndots' parameter for searches. More... EVENT2_EXPORT_SYMBOL int evdns_set_option (const char *option, const char *val, int flags) Set the value of a configuration option. More... EVENT2_EXPORT_SYMBOL void evdns_shutdown (int fail_requests) Shut down the asynchronous DNS resolver and terminate all active requests. More...
+
+
Potentially non-threadsafe versions of the functions in dns.h : provided only for backwards compatibility.
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_server_port* evdns_add_server_port
+ (
+ evutil_socket_t socket ,
+
+ int
+ flags ,
+
+ evdns_request_callback_fn_type callback ,
+
+ void *
+ user_data
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_clear_nameservers_and_suspend
+ (
+ void
+ )
+
+
+
+
+
Remove all configured nameservers, and suspend all pending resolves.
+
Resolves will not necessarily be re-attempted until evdns_resume() is called.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_clear_nameservers_and_suspend() .
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resume()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_count_nameservers
+ (
+ void
+ )
+
+
+
+
+
Get the number of configured nameservers.
+
This returns the number of configured nameservers (not necessarily the number of running nameservers). This is useful for double-checking whether our calls to the various nameserver configuration functions have been successful.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_count_nameservers() .
+
Returns the number of configured nameservers
+
See also evdns_nameserver_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evdns_base* evdns_get_global_base
+ (
+ void
+ )
+
+
+
+
+
Return the global evdns_base created by event_init() and used by the other deprecated functions.
+
Deprecated: This function is deprecated because use of the global evdns_base is error-prone.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_init
+ (
+ void
+ )
+
+
+
+
+
Initialize the asynchronous DNS library.
+
This function initializes support for non-blocking name resolution by calling evdns_resolv_conf_parse() on UNIX and evdns_config_windows_nameservers() on Windows.
+
Deprecated: This function is deprecated because it always uses the current event base, and is easily confused by multiple calls to event_init() , and so is not safe for multithreaded use. Additionally, it allocates a global structure that only one thread can use. The replacement is evdns_base_new() .
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_shutdown()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_nameserver_add
+ (
+ unsigned long int
+ address )
+
+
+
+
+
Add a nameserver.
+
The address should be an IPv4 address in network byte order. The type of address is chosen so that it matches in_addr.s_addr.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_nameserver_add() .
+
Parameters
+
+ address an IP address in network byte order
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_nameserver_ip_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_nameserver_ip_add
+ (
+ const char *
+ ip_as_string )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resolv_conf_parse
+ (
+ int
+ flags ,
+
+ const char *const
+ filename
+
+ )
+
+
+
+
+
Parse a resolv.conf file.
+
The 'flags' parameter determines what information is parsed from the resolv.conf file. See the man page for resolv.conf for the format of this file.
+
The following directives are not parsed from the file: sortlist, rotate, no-check-names, inet6, debug.
+
If this function encounters an error, the possible return values are: 1 = failed to open file, 2 = failed to stat file, 3 = file too large, 4 = out of memory, 5 = short read from file, 6 = no nameservers listed in the file
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_resolv_conf_parse() .
+
Parameters
+
+ flags any of DNS_OPTION_NAMESERVERS|DNS_OPTION_SEARCH|DNS_OPTION_MISC| DNS_OPTIONS_ALL filename the path to the resolv.conf file
+
+
+
Returns 0 if successful, or various positive error codes if an error occurred (see above)
+
See also resolv.conf(3), evdns_config_windows_nameservers()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv4
+ (
+ const char *
+ name ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup an A record for a given name.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_resolve_ipv4() .
+
Parameters
+
+ name a DNS hostname flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resolve_ipv6() , evdns_resolve_reverse() , evdns_resolve_reverse_ipv6()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv6
+ (
+ const char *
+ name ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup an AAAA record for a given name.
+
Parameters
+
+ name a DNS hostname flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resolve_ipv4() , evdns_resolve_reverse() , evdns_resolve_reverse_ipv6()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse
+ (
+ const struct in_addr *
+ in ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup a PTR record for a given IP address.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_resolve_reverse() .
+
Parameters
+
+ in an IPv4 address flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resolve_reverse_ipv6()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse_ipv6
+ (
+ const struct in6_addr *
+ in ,
+
+ int
+ flags ,
+
+ evdns_callback_type callback ,
+
+ void *
+ ptr
+
+ )
+
+
+
+
+
Lookup a PTR record for a given IPv6 address.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_resolve_reverse_ipv6() .
+
Parameters
+
+ in an IPv6 address flags either 0, or DNS_QUERY_NO_SEARCH to disable searching for this query. callback a callback function to invoke when the request is completed ptr an argument to pass to the callback function
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also evdns_resolve_reverse_ipv6()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_resume
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_search_add
+ (
+ const char *
+ domain )
+
+
+
+
+
Add a domain to the list of search domains.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_search_add() .
+
Parameters
+
+ domain the domain to be added to the search list
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_search_clear
+ (
+ void
+ )
+
+
+
+
+
Clear the list of search domains.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_search_clear() .
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_search_ndots_set
+ (
+ const int
+ ndots )
+
+
+
+
+
Set the 'ndots' parameter for searches.
+
Sets the number of dots which, when found in a name, causes the first query to be without any search domain.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_search_ndots_set() .
+
Parameters
+
+ ndots the new ndots parameter
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evdns_set_option
+ (
+ const char *
+ option ,
+
+ const char *
+ val ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
Set the value of a configuration option.
+
The currently available configuration options are:
+
ndots, timeout, max-timeouts, max-inflight, and attempts
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_set_option() .
+
Parameters
+
+ option the name of the configuration option to be modified val the value to be set flags Ignored.
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evdns_shutdown
+ (
+ int
+ fail_requests )
+
+
+
+
+
Shut down the asynchronous DNS resolver and terminate all active requests.
+
If the 'fail_requests' option is enabled, all active requests will return an empty result with the error flag set to DNS_ERR_SHUTDOWN. Otherwise, the requests will be silently discarded.
+
Deprecated: This function is deprecated because it does not allow the caller to specify which evdns_base it applies to. The recommended function is evdns_base_shutdown().
+
Parameters
+
+ fail_requests if zero, active requests will be aborted; if non-zero, active requests will return DNS_ERR_SHUTDOWN.
+
+
+
See also evdns_init()
+
+
+
+
libevent: event2/dns_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_DNS_COMPAT_H_INCLUDED_
+
28 #define EVENT2_DNS_COMPAT_H_INCLUDED_
+
+
+
+
+
+
42 #include <event2/event-config.h>
+
43 #ifdef EVENT__HAVE_SYS_TYPES_H
+
44 #include <sys/types.h>
+
+
46 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
+
+
+
52 #include <event2/visibility.h>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
344 struct evdns_server_port *
+
+
+
+
+
+
350 int evdns_config_windows_nameservers(
void );
+
351 #define EVDNS_CONFIG_WINDOWS_NAMESERVERS_IMPLEMENTED
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse(const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr)
Lookup a PTR record for a given IP address.
EVENT2_EXPORT_SYMBOL void evdns_search_add(const char *domain)
Add a domain to the list of search domains.
EVENT2_EXPORT_SYMBOL int evdns_resolve_reverse_ipv6(const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr)
Lookup a PTR record for a given IPv6 address.
EVENT2_EXPORT_SYMBOL int evdns_resolv_conf_parse(int flags, const char *const filename)
Parse a resolv.conf file.
EVENT2_EXPORT_SYMBOL int evdns_nameserver_add(unsigned long int address)
Add a nameserver.
EVENT2_EXPORT_SYMBOL int evdns_init(void)
Initialize the asynchronous DNS library.
EVENT2_EXPORT_SYMBOL struct evdns_base * evdns_get_global_base(void)
Return the global evdns_base created by event_init() and used by the other deprecated functions.
EVENT2_EXPORT_SYMBOL int evdns_clear_nameservers_and_suspend(void)
Remove all configured nameservers, and suspend all pending resolves.
EVENT2_EXPORT_SYMBOL int evdns_nameserver_ip_add(const char *ip_as_string)
Add a nameserver.
EVENT2_EXPORT_SYMBOL void evdns_search_ndots_set(const int ndots)
Set the 'ndots' parameter for searches.
EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv6(const char *name, int flags, evdns_callback_type callback, void *ptr)
Lookup an AAAA record for a given name.
EVENT2_EXPORT_SYMBOL int evdns_resolve_ipv4(const char *name, int flags, evdns_callback_type callback, void *ptr)
Lookup an A record for a given name.
EVENT2_EXPORT_SYMBOL int evdns_resume(void)
Resume normal operation and continue any suspended resolve requests.
EVENT2_EXPORT_SYMBOL void evdns_search_clear(void)
Clear the list of search domains.
void(* evdns_request_callback_fn_type)(struct evdns_server_request *, void *)
A callback to implement a DNS server.
Definition: dns.h:645
void(* evdns_callback_type)(int result, char type, int count, int ttl, void *addresses, void *arg)
The callback that contains the results from a lookup.
Definition: dns.h:249
EVENT2_EXPORT_SYMBOL int evdns_set_option(const char *option, const char *val, int flags)
Set the value of a configuration option.
EVENT2_EXPORT_SYMBOL void evdns_shutdown(int fail_requests)
Shut down the asynchronous DNS resolver and terminate all active requests.
EVENT2_EXPORT_SYMBOL struct evdns_server_port * evdns_add_server_port(evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data)
As evdns_server_new_with_base.
EVENT2_EXPORT_SYMBOL int evdns_count_nameservers(void)
Get the number of configured nameservers.
Common convenience functions for cross-platform portability and related socket manipulations.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
+
+
+libevent: event2/event.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Core functions for waiting for and receiving events, and using event bases.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <stdio.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+_EVENT_LOG_DEBUG EVENT_LOG_DEBUG _EVENT_LOG_ERR EVENT_LOG_ERR _EVENT_LOG_MSG EVENT_LOG_MSG _EVENT_LOG_WARN EVENT_LOG_WARN EVENT_DBG_ALL 0xffffffffu EVENT_DBG_NONE 0 event_get_signal (ev) ((int)event_get_fd (ev)) Get the signal number assigned to a signal event. EVENT_MAX_PRIORITIES 256 Largest number of priorities that Libevent can support. EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED This definition is present if Libevent was built with support for event_set_mem_functions() LIBEVENT_VERSION EVENT__VERSION As event_get_version, but gives the version of Libevent's headers. LIBEVENT_VERSION_NUMBER EVENT__NUMERIC_VERSION As event_get_version_number, but gives the version number of Libevent's headers. Flags to pass to event_base_get_num_events() to specify the kinds of events we want to aggregate counts for
+
EVENT_BASE_COUNT_ACTIVE 1U count the number of active events, which have been triggered. EVENT_BASE_COUNT_ADDED 4U count the number of events which have been added to event base, including internal events. EVENT_BASE_COUNT_VIRTUAL 2U count the number of virtual events, which is used to represent an internal condition, other than a pending event, that keeps the loop from exiting. EVENT_LOG_DEBUG 0 EVENT_LOG_ERR 3 EVENT_LOG_MSG 1 EVENT_LOG_WARN 2 These flags control the behavior of event_base_loop() .
+
#define EVLOOP_NO_EXIT_ON_EMPTY 0x04 Do not exit the loop because we have no pending events. More... EVLOOP_NONBLOCK 0x02 Do not block: see which events are ready now, run the callbacks of the highest-priority ones, then exit. EVLOOP_ONCE 0x01 Block until we have an active event, then exit once all active events have had their callbacks run. Flags to pass to event_new() , event_assign() , event_pending() , and anything else with an argument of the form "short events"
+
#define EV_CLOSED 0x80 Detects connection close events. More... EV_ET 0x20 Select edge-triggered behavior, if supported by the backend. #define EV_FINALIZE 0x40 If this option is provided, then event_del() will not block in one thread while waiting for the event callback to complete in another thread. More... #define EV_PERSIST 0x10 Persistent event: won't get removed automatically when activated. More... EV_READ 0x02 Wait for a socket or FD to become readable. EV_SIGNAL 0x08 Wait for a POSIX signal to be raised. #define EV_TIMEOUT 0x01 Indicates that a timeout has occurred. More... EV_WRITE 0x04 Wait for a socket or FD to become writeable. Aliases for working with one-shot timer events If you need EV_PERSIST timer use event_*() functions.
+
evtimer_add (ev, tv) event_add ((ev), (tv)) evtimer_assign (ev, b, cb, arg) event_assign ((ev), (b), -1, 0, (cb), (arg)) evtimer_del (ev) event_del (ev) evtimer_initialized (ev) event_initialized (ev) evtimer_new (b, cb, arg) event_new ((b), -1, 0, (cb), (arg)) evtimer_pending (ev, tv) event_pending ((ev), EV_TIMEOUT , (tv)) Aliases for working with signal events
+
evsignal_add (ev, tv) event_add ((ev), (tv)) evsignal_assign (ev, b, x, cb, arg) event_assign ((ev), (b), (x), EV_SIGNAL |EV_PERSIST , cb, (arg)) evsignal_del (ev) event_del (ev) evsignal_initialized (ev) event_initialized (ev) evsignal_new (b, x, cb, arg) event_new ((b), (x), EV_SIGNAL |EV_PERSIST , (cb), (arg)) evsignal_pending (ev, tv) event_pending ((ev), EV_SIGNAL , (tv)) Aliases for working with user-triggered events If you need EV_PERSIST event use event_*() functions.
+
evuser_del (ev) event_del (ev) evuser_initialized (ev) event_initialized (ev) evuser_new (b, cb, arg) event_new ((b), -1, 0, (cb), (arg)) evuser_pending (ev, tv) event_pending ((ev), 0, (tv)) evuser_trigger (ev) event_active ((ev), 0, 0)
+enum event_base_config_flag { EVENT_BASE_FLAG_NOLOCK = 0x01,
+EVENT_BASE_FLAG_IGNORE_ENV = 0x02,
+EVENT_BASE_FLAG_STARTUP_IOCP = 0x04,
+EVENT_BASE_FLAG_NO_CACHE_TIME = 0x08,
+EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST = 0x10,
+EVENT_BASE_FLAG_PRECISE_TIMER = 0x20,
+EVENT_BASE_FLAG_EPOLL_DISALLOW_TIMERFD = 0x40,
+EVENT_BASE_FLAG_USE_SIGNALFD = 0x80
+ A flag passed to event_config_set_flag() . More... enum event_method_feature { EV_FEATURE_ET = 0x01,
+EV_FEATURE_O1 = 0x02,
+EV_FEATURE_FDS = 0x04,
+EV_FEATURE_EARLY_CLOSE = 0x08
+ } A flag used to describe which features an event_base (must) provide. More...
+EVENT2_EXPORT_SYMBOL void event_active (struct event *ev, int res, short ncalls) Make an event active. More... EVENT2_EXPORT_SYMBOL int event_add (struct event *ev, const struct timeval *timeout) Add an event to the set of pending events. More... EVENT2_EXPORT_SYMBOL int event_assign (struct event *ev, struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg) Prepare a new, already-allocated event structure to be added. More... EVENT2_EXPORT_SYMBOL void event_base_active_by_fd (struct event_base *base, evutil_socket_t fd, short events) Activates all pending events for the given fd and event mask. More... EVENT2_EXPORT_SYMBOL void event_base_active_by_signal (struct event_base *base, int sig) Activates all pending signals with a given signal number. More... EVENT2_EXPORT_SYMBOL int event_base_dispatch (struct event_base *base) Event dispatching loop. More... EVENT2_EXPORT_SYMBOL void event_base_dump_events (struct event_base *base, FILE *output) Writes a human-readable description of all inserted and/or active events to a provided stdio stream. More... EVENT2_EXPORT_SYMBOL int event_base_foreach_event (struct event_base *base, event_base_foreach_event_cb fn, void *arg) Iterate over all added or active events events in an event loop, and invoke a given callback on each one. More... EVENT2_EXPORT_SYMBOL void event_base_free (struct event_base *eb) Deallocate all memory associated with an event_base , and free the base. More... event_base_free_nofinalize (struct event_base *) As event_base_free, but do not run finalizers. EVENT2_EXPORT_SYMBOL int event_base_get_features (const struct event_base *base) Return a bitmask of the features implemented by an event base. More... EVENT2_EXPORT_SYMBOL int event_base_get_max_events (struct event_base *eb, unsigned int flags, int clear) Get the maximum number of events in a given event_base as specified in the flags. More... const EVENT2_EXPORT_SYMBOL char * event_base_get_method (const struct event_base *eb) Get the kernel event notification mechanism used by Libevent. More... EVENT2_EXPORT_SYMBOL int event_base_get_npriorities (struct event_base *eb) Get the number of different event priorities. More... EVENT2_EXPORT_SYMBOL int event_base_get_num_events (struct event_base *eb, unsigned int flags) Gets the number of events in event_base , as specified in the flags. More... EVENT2_EXPORT_SYMBOL struct event * event_base_get_running_event (struct event_base *base) If called from within the callback for an event, returns that event. More... const EVENT2_EXPORT_SYMBOL char * event_base_get_signal_method (const struct event_base *eb) Get the kernel signal handling mechanism used by Libevent. More... EVENT2_EXPORT_SYMBOL int event_base_gettimeofday_cached (struct event_base *base, struct timeval *tv) Sets 'tv' to the current time (as returned by gettimeofday()), looking at the cached value in 'base' if possible, and calling gettimeofday() or clock_gettime() as appropriate if there is no cached time. More... EVENT2_EXPORT_SYMBOL int event_base_got_break (struct event_base *eb) Checks if the event loop was told to abort immediately by event_base_loopbreak() . More... EVENT2_EXPORT_SYMBOL int event_base_got_exit (struct event_base *eb) Checks if the event loop was told to exit by event_base_loopexit() . More... EVENT2_EXPORT_SYMBOL const struct timeval * event_base_init_common_timeout (struct event_base *base, const struct timeval *duration) Prepare an event_base to use a large number of timeouts with the same duration. More... EVENT2_EXPORT_SYMBOL int event_base_loop (struct event_base *eb, int flags) Wait for events to become active, and run their callbacks. More... EVENT2_EXPORT_SYMBOL int event_base_loopbreak (struct event_base *eb) Abort the active event_base_loop() immediately. More... EVENT2_EXPORT_SYMBOL int event_base_loopcontinue (struct event_base *eb) Tell the active event_base_loop() to scan for new events immediately. More... EVENT2_EXPORT_SYMBOL int event_base_loopexit (struct event_base *eb, const struct timeval *tv) Exit the event loop after the specified time. More... EVENT2_EXPORT_SYMBOL struct event_base * event_base_new (void) Create and return a new event_base to use with the rest of Libevent. More... EVENT2_EXPORT_SYMBOL struct event_base * event_base_new_with_config (const struct event_config *cfg) Initialize the event API. More... EVENT2_EXPORT_SYMBOL int event_base_once (struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *arg, const struct timeval *timeout) Schedule a one-time event. More... EVENT2_EXPORT_SYMBOL int event_base_priority_init (struct event_base *eb, int npriorities) Set the number of different event priorities. More... EVENT2_EXPORT_SYMBOL int event_base_set (struct event_base *eb, struct event *ev) Associate a different event base with an event. More... EVENT2_EXPORT_SYMBOL int event_base_update_cache_time (struct event_base *base) Update cached_tv in the 'base' to the current time. More... EVENT2_EXPORT_SYMBOL int event_config_avoid_method (struct event_config *cfg, const char *method) Enters an event method that should be avoided into the configuration. More... EVENT2_EXPORT_SYMBOL void event_config_free (struct event_config *cfg) Deallocates all memory associated with an event configuration object. More... EVENT2_EXPORT_SYMBOL struct event_config * event_config_new (void) Allocates a new event configuration object. More... EVENT2_EXPORT_SYMBOL int event_config_require_features (struct event_config *cfg, int feature) Enters a required event method feature that the application demands. More... EVENT2_EXPORT_SYMBOL int event_config_set_flag (struct event_config *cfg, int flag) Sets one or more flags to configure what parts of the eventual event_base will be initialized, and how they'll work. More... EVENT2_EXPORT_SYMBOL int event_config_set_max_dispatch_interval (struct event_config *cfg, const struct timeval *max_interval, int max_callbacks, int min_priority) Record an interval and/or a number of callbacks after which the event base should check for new events. More... EVENT2_EXPORT_SYMBOL int event_config_set_num_cpus_hint (struct event_config *cfg, int cpus) Records a hint for the number of CPUs in the system. More... EVENT2_EXPORT_SYMBOL void event_debug_unassign (struct event *) When debugging mode is enabled, informs Libevent that an event should no longer be considered as assigned. More... EVENT2_EXPORT_SYMBOL int event_del (struct event *ev) Remove an event from the set of monitored events. More... event_del_block (struct event *ev) As event_del() , but always blocks while the event's callback is running in another thread, even if the event was constructed with the EV_FINALIZE flag. event_del_noblock (struct event *ev) As event_del() , but never blocks while the event's callback is running in another thread, even if the event was constructed without the EV_FINALIZE flag. EVENT2_EXPORT_SYMBOL void event_enable_debug_logging (ev_uint32_t which) Turn on debugging logs and have them sent to the default log handler. More... EVENT2_EXPORT_SYMBOL void event_enable_debug_mode (void) Enable some relatively expensive debugging checks in Libevent that would normally be turned off. More... EVENT2_EXPORT_SYMBOL void event_free (struct event *) Deallocate a struct event * returned by event_new() . More... EVENT2_EXPORT_SYMBOL void event_get_assignment (const struct event *event , struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, event_callback_fn *callback_out, void **arg_out) Extract all of arguments given to construct a given event. More... event_base * event_get_base (const struct event *ev) Get the event_base associated with an event. event_callback_fn event_get_callback (const struct event *ev) Return the callback assigned to an event. event_get_callback_arg (const struct event *ev) Return the callback argument assigned to an event. event_get_events (const struct event *ev) Return the events (EV_READ, EV_WRITE, etc) assigned to an event. evutil_socket_t event_get_fd (const struct event *ev) Get the socket or signal assigned to an event, or -1 if the event has no socket. EVENT2_EXPORT_SYMBOL int event_get_priority (const struct event *ev) Return the priority of an event. More... EVENT2_EXPORT_SYMBOL size_t event_get_struct_event_size (void) Return the size of struct event that the Libevent library was compiled with. More... const EVENT2_EXPORT_SYMBOL char ** event_get_supported_methods (void) Gets all event notification mechanisms supported by Libevent. More... const EVENT2_EXPORT_SYMBOL char * event_get_version (void) Get the Libevent version. More... EVENT2_EXPORT_SYMBOL ev_uint32_t event_get_version_number (void) Return a numeric representation of Libevent's version. More... event_gettime_monotonic (struct event_base *base, struct timeval *tp) Query the current monotonic time from the timer for a struct event_base . EVENT2_EXPORT_SYMBOL int event_initialized (const struct event *ev) Test if an event structure might be initialized. More... EVENT2_EXPORT_SYMBOL struct event * event_new (struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg) Allocate and assign a new event structure, ready to be added. More... EVENT2_EXPORT_SYMBOL int event_pending (const struct event *ev, short events, struct timeval *tv) Checks if a specific event is pending or scheduled. More... EVENT2_EXPORT_SYMBOL int event_priority_set (struct event *ev, int priority) Assign a priority to an event. More... EVENT2_EXPORT_SYMBOL int event_reinit (struct event_base *base) Reinitialize the event base after a fork. More... EVENT2_EXPORT_SYMBOL int event_remove_timer (struct event *ev) Remove a timer from a pending event without removing the event itself. More... EVENT2_EXPORT_SYMBOL void * event_self_cbarg (void) Return a value used to specify that the event itself must be used as the callback argument. More... EVENT2_EXPORT_SYMBOL void event_set_fatal_callback (event_fatal_cb cb) Override Libevent's behavior in the event of a fatal internal error. More... EVENT2_EXPORT_SYMBOL void event_set_log_callback (event_log_cb cb) Redirect Libevent's log messages. More... EVENT2_EXPORT_SYMBOL void event_set_mem_functions (void *(*malloc_fn)(size_t sz), void *(*realloc_fn)(void *ptr, size_t sz), void(*free_fn)(void *ptr)) Override the functions that Libevent uses for memory management. More... EVENT2_EXPORT_SYMBOL void libevent_global_shutdown (void) Release up all globally-allocated resources allocated by Libevent. More... These functions are used to safely tear down an event in a multithreaded application.
+
If you construct your events with EV_FINALIZE to avoid deadlocks, you will need a way to remove an event in the certainty that it will definitely not be running its callback when you deallocate it and its callback argument.
+
To do this, call one of event_finalize() or event_free_finalize with 0 for its first argument, the event to tear down as its second argument, and a callback function as its third argument. The callback will be invoked as part of the event loop, with the event's priority.
+
After you call a finalizer function, event_add() and event_active() will no longer work on the event, and event_del() will produce a no-op. You must not try to change the event's fields with event_assign() or event_set() while the finalize callback is in progress. Once the callback has been invoked, you should treat the event structure as containing uninitialized memory.
+
The event_free_finalize() function frees the event after it's finalized; event_finalize() does not.
+
A finalizer callback must not make events pending or active. It must not add events, activate events, or attempt to "resuscitate" the event being finalized in any way.
+
Returns 0 on success, -1 on failure.
+
event_finalize (unsigned, struct event *, event_finalize_callback_fn ) event_free_finalize (unsigned, struct event *, event_finalize_callback_fn )
+
+
Core functions for waiting for and receiving events, and using event bases.
+
+
+
◆
+
+
+
+
+
+ #define EV_CLOSED 0x80
+
+
+
+
+
Detects connection close events.
+
You can use this to detect when a connection has been closed, without having to read all the pending data from a connection.
+
Not all backends support EV_CLOSED. To detect or require it, use the feature flag EV_FEATURE_EARLY_CLOSE.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EV_FINALIZE 0x40
+
+
+
+
+
If this option is provided, then event_del() will not block in one thread while waiting for the event callback to complete in another thread.
+
To use this option safely, you may need to use event_finalize() or event_free_finalize() in order to safely tear down an event in a multithreaded application. See those functions for more information.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EV_PERSIST 0x10
+
+
+
+
+
Persistent event: won't get removed automatically when activated.
+
When a persistent event with a timeout becomes activated, its timeout is reset to 0.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EV_TIMEOUT 0x01
+
+
+
+
+
Indicates that a timeout has occurred.
+
It's not necessary to pass this flag to event_for new()/event_assign() to get a timeout.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVLOOP_NO_EXIT_ON_EMPTY 0x04
+
+
+
+
+
+
+
◆
+
+
+
+
+
A callback function for an event.
+
It receives three arguments:
+
Parameters
+
+ fd An fd or signal events One or more EV_* flags arg A user-supplied argument.
+
+
+
See also event_new()
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* event_fatal_cb) (int err)
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* event_log_cb) (int severity, const char *msg)
+
+
+
+
+
+
+
◆
+
+
+
+
+
A flag passed to event_config_set_flag() .
+
These flags change the behavior of an allocated event_base .
+
See also event_config_set_flag() , event_base_new_with_config() , event_method_feature
+
+Enumerator Do not allocate a lock for the event base, even if we have locking set up.
+Setting this option will make it unsafe and nonfunctional to call functions on the base concurrently from multiple threads.
+Do not check the EVENT_* environment variables when configuring an event_base
+Windows only: enable the IOCP dispatcher at startup.
+If this flag is set then bufferevent_socket_new() and
+evconn_listener_new() will use IOCP-backed implementations
+instead of the usual select-based one on Windows.
+
+Note: it is experimental feature, and has some bugs.
+ Instead of checking the current time every time the event loop is ready to run timeout callbacks, check after each timeout callback.
+If we are using the epoll backend, this flag says that it is safe to use Libevent's internal change-list code to batch up adds and deletes in order to try to do as few syscalls as possible.
+Setting this flag can make your code run faster, but it may trigger a Linux bug: it is not safe to use this flag if you have any fds cloned by dup() or its variants. Doing so will produce strange and hard-to-diagnose bugs.
+This flag can also be activated by setting the EVENT_EPOLL_USE_CHANGELIST environment variable.
+This flag has no effect if you wind up using a backend other than epoll.
+Ordinarily, Libevent implements its time and timeout code using the fastest monotonic timer that we have.
+If this flag is set, however, we use less efficient more precise timer, assuming one is present.
+With EVENT_BASE_FLAG_PRECISE_TIMER, epoll backend will use timerfd for more accurate timers, this will allows to disable this.
+That said that this is something in between lack of (CLOCK_MONOTONIC_COARSE) and enabled EVENT_BASE_FLAG_PRECISE_TIMER (CLOCK_MONOTONIC + timerfd).
+This flag has no effect if you wind up using a backend other than epoll and if you do not have EVENT_BASE_FLAG_PRECISE_TIMER enabled.
+Use signalfd(2) to handle signals over sigaction/signal.
+But note, that in some edge cases signalfd() may works differently.
+
+
+
+
+
+
◆
+
+
+
+
+
A flag used to describe which features an event_base (must) provide.
+
Because of OS limitations, not every Libevent backend supports every possible feature. You can use this type with event_config_require_features() to tell Libevent to only proceed if your event_base implements a given feature, and you can receive this type from event_base_get_features() to see which features are available.
+
+Enumerator Require an event method that allows edge-triggered events with EV_ET.
+Require an event method where having one event triggered among many is [approximately] an O(1) operation.
+This excludes (for example) select and poll, which are approximately O(N) for N equal to the total number of possible events.
+Require an event method that allows file descriptors as well as sockets.
+Require an event method that allows you to use EV_CLOSED to detect connection close without the necessity of reading all the pending data.
+Methods that do support EV_CLOSED may not be able to provide support on all kernel versions.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_active
+ (
+ struct event *
+ ev ,
+
+ int
+ res ,
+
+ short
+ ncalls
+
+ )
+
+
+
+
+
Make an event active.
+
You can use this function on a pending or a non-pending event to make it active, so that its callback will be run by event_base_dispatch() or event_base_loop() .
+
One common use in multithreaded programs is to wake the thread running event_base_loop() from another thread.
+
Parameters
+
+ ev an event to make active. res a set of flags to pass to the event's callback. ncalls an obsolete argument: this is ignored.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_add
+ (
+ struct event *
+ ev ,
+
+ const struct timeval *
+ timeout
+
+ )
+
+
+
+
+
Add an event to the set of pending events.
+
The function event_add() schedules the execution of the event 'ev' when the condition specified by event_assign() or event_new() occurs, or when the time specified in timeout has elapsed. If a timeout is NULL, no timeout occurs and the function will only be called if a matching event occurs. The event in the ev argument must be already initialized by event_assign() or event_new() and may not be used in calls to event_assign() until it is no longer pending.
+
If the event in the ev argument already has a scheduled timeout, calling event_add() replaces the old timeout with the new one if tv is non-NULL.
+
Parameters
+
+ ev an event struct initialized via event_assign() or event_new() timeout the maximum amount of time to wait for the event, or NULL to wait forever
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_del() , event_assign() , event_new()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_assign
+ (
+ struct event *
+ ev ,
+
+ struct event_base *
+ base ,
+
+ evutil_socket_t fd ,
+
+ short
+ events ,
+
+ event_callback_fn callback ,
+
+ void *
+ callback_arg
+
+ )
+
+
+
+
+
Prepare a new, already-allocated event structure to be added.
+
The function event_assign() prepares the event structure ev to be used in future calls to event_add() and event_del() . Unlike event_new() , it doesn't allocate memory itself: it requires that you have already allocated a struct event, probably on the heap. Doing this will typically make your code depend on the size of the event structure, and thereby create incompatibility with future versions of Libevent.
+
The easiest way to avoid this problem is just to use event_new() and event_free() instead.
+
A slightly harder way to future-proof your code is to use event_get_struct_event_size() to determine the required size of an event at runtime.
+
Note that it is NOT safe to call this function on an event that is active or pending. Doing so WILL corrupt internal data structures in Libevent, and lead to strange, hard-to-diagnose bugs. You can use event_assign to change an existing event, but only if it is not active or pending!
+
The arguments for this function, and the behavior of the events that it makes, are as for event_new() .
+
Parameters
+
+ ev an event struct to be modified base the event base to which ev should be attached. fd the file descriptor to be monitored events desired events to monitor; can be EV_READ and/or EV_WRITE callback callback function to be invoked when the event occurs callback_arg an argument to be passed to the callback function
+
+
+
Returns 0 if success, or -1 on invalid arguments.
+
See also event_new() , event_add() , event_del() , event_base_once() , event_get_struct_event_size()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_base_active_by_fd
+ (
+ struct event_base *
+ base ,
+
+ evutil_socket_t fd ,
+
+ short
+ events
+
+ )
+
+
+
+
+
Activates all pending events for the given fd and event mask.
+
This function activates pending events only. Events which have not been added will not become active.
+
Parameters
+
+ base the event_base on which to activate the events. fd An fd to active events on. events One or more of EV_{READ,WRITE,TIMEOUT}.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_base_active_by_signal
+ (
+ struct event_base *
+ base ,
+
+ int
+ sig
+
+ )
+
+
+
+
+
Activates all pending signals with a given signal number.
+
This function activates pending events only. Events which have not been added will not become active.
+
Parameters
+
+ base the event_base on which to activate the events. sig The signal to active events on.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_dispatch
+ (
+ struct event_base *
+ base )
+
+
+
+
+
Event dispatching loop.
+
This loop will run the event base until either there are no more pending or active, or until something calls event_base_loopbreak() or event_base_loopexit() .
+
Parameters
+
+
+
+
Returns 0 if successful, -1 if an error occurred, or 1 if we exited because no events were pending or active.
+
See also event_base_loop()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_base_dump_events
+ (
+ struct event_base *
+ base ,
+
+ FILE *
+ output
+
+ )
+
+
+
+
+
Writes a human-readable description of all inserted and/or active events to a provided stdio stream.
+
This is intended for debugging; its format is not guaranteed to be the same between libevent versions.
+
Parameters
+
+ base An event_base on which to scan the events. output A stdio file to write on.
+
+
+
+
+
+
+
◆
+
+
+
+
+
Iterate over all added or active events events in an event loop, and invoke a given callback on each one.
+
The callback must not call any function that modifies the event base, that modifies any event in the event base, or that adds or removes any event to the event base. Doing so is unsupported and will lead to undefined behavior – likely, to crashes.
+
event_base_foreach_event() holds a lock on the event_base() for the whole time it's running: slow callbacks are not advisable.
+
Note that Libevent adds some events of its own to make pieces of its functionality work. You must not assume that the only events you'll encounter will be the ones you added yourself.
+
The callback function must return 0 to continue iteration, or some other integer to stop iterating.
+
Parameters
+
+ base An event_base on which to scan the events. fn A callback function to receive the events. arg An argument passed to the callback function.
+
+
+
Returns 0 if we iterated over every event, or the value returned by the callback function if the loop exited early.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_base_free
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
Deallocate all memory associated with an event_base , and free the base.
+
Note that this function will not close any fds or free any memory passed to event_new as the argument to callback.
+
If there are any pending finalizer callbacks, this function will invoke them.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_get_features
+ (
+ const struct event_base *
+ base )
+
+
+
+
+
Return a bitmask of the features implemented by an event base.
+
This will be a bitwise OR of one or more of the values of event_method_feature
+
See also event_method_feature
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_get_max_events
+ (
+ struct event_base *
+ eb ,
+
+ unsigned int
+ flags ,
+
+ int
+ clear
+
+ )
+
+
+
+
+
Get the maximum number of events in a given event_base as specified in the flags.
+
Parameters
+
+ eb the event_base structure returned by event_base_new() flags a bitwise combination of the kinds of events to aggregate counts for clear option used to reset the maximum count.
+
+
+
Returns the number of events specified in the flags
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* event_base_get_method
+ (
+ const struct event_base *
+ eb )
+
+
+
+
+
Get the kernel event notification mechanism used by Libevent.
+
Parameters
+
+
+
+
Returns a string identifying the kernel event mechanism (kqueue, epoll, etc.)
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_get_npriorities
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
Get the number of different event priorities.
+
Parameters
+
+
+
+
Returns Number of different event priorities
+
See also event_base_priority_init()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_get_num_events
+ (
+ struct event_base *
+ eb ,
+
+ unsigned int
+ flags
+
+ )
+
+
+
+
+
Gets the number of events in event_base , as specified in the flags.
+
Since event base has some internal events added to make some of its functionalities work, EVENT_BASE_COUNT_ADDED may return more than the number of events you added using event_add() .
+
If you pass EVENT_BASE_COUNT_ACTIVE and EVENT_BASE_COUNT_ADDED together, an active event will be counted twice. However, this might not be the case in future libevent versions. The return value is an indication of the work load, but the user shouldn't rely on the exact value as this may change in the future.
+
Parameters
+
+ eb the event_base structure returned by event_base_new() flags a bitwise combination of the kinds of events to aggregate counts for
+
+
+
Returns the number of events specified in the flags
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event * event_base_get_running_event
+ (
+ struct event_base *
+ base )
+
+
+
+
+
If called from within the callback for an event, returns that event.
+
The behavior of this function is not defined when called from outside the callback function for an event.
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* event_base_get_signal_method
+ (
+ const struct event_base *
+ eb )
+
+
+
+
+
Get the kernel signal handling mechanism used by Libevent.
+
Parameters
+
+
+
+
Returns a string identifying the kernel signal handling mechanism, which is "signal" for traditional UNIX signal handlers, "kqueue_signal" for kqueue(2)-based method on *BSD and macOS, and "signalfd_signal" for Linux-only signalfd(2)-based method.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_gettimeofday_cached
+ (
+ struct event_base *
+ base ,
+
+ struct timeval *
+ tv
+
+ )
+
+
+
+
+
Sets 'tv' to the current time (as returned by gettimeofday()), looking at the cached value in 'base' if possible, and calling gettimeofday() or clock_gettime() as appropriate if there is no cached time.
+
Generally, this value will only be cached while actually processing event callbacks, and may be very inaccurate if your callbacks take a long time to execute.
+
Returns 0 on success, negative on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_got_break
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_got_exit
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL const struct timeval* event_base_init_common_timeout
+ (
+ struct event_base *
+ base ,
+
+ const struct timeval *
+ duration
+
+ )
+
+
+
+
+
Prepare an event_base to use a large number of timeouts with the same duration.
+
Libevent's default scheduling algorithm is optimized for having a large number of timeouts with their durations more or less randomly distributed. But if you have a large number of timeouts that all have the same duration (for example, if you have a large number of connections that all have a 10-second timeout), then you can improve Libevent's performance by telling Libevent about it.
+
To do this, call this function with the common duration. It will return a pointer to a different, opaque timeout value. (Don't depend on its actual contents!) When you use this timeout value in event_add() , Libevent will schedule the event more efficiently.
+
(This optimization probably will not be worthwhile until you have thousands or tens of thousands of events with the same timeout.)
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_loop
+ (
+ struct event_base *
+ eb ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_loopbreak
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_loopcontinue
+ (
+ struct event_base *
+ eb )
+
+
+
+
+
Tell the active event_base_loop() to scan for new events immediately.
+
Calling this function makes the currently active event_base_loop() start the loop over again (scanning for new events) after the current event callback finishes. If the event loop is not running, this function has no effect.
+
event_base_loopbreak() is typically invoked from this event's callback. This behavior is analogous to the "continue;" statement.
+
Subsequent invocations of event loop will proceed normally.
+
Parameters
+
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_base_loopbreak()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_loopexit
+ (
+ struct event_base *
+ eb ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Exit the event loop after the specified time.
+
The next event_base_loop() iteration after the given timer expires will complete normally (handling all queued events) then exit without blocking for events again.
+
Subsequent invocations of event_base_loop() will proceed normally.
+
Parameters
+
+ eb the event_base structure returned by event_init() tv the amount of time after which the loop should terminate, or NULL to exit after running all currently active events.
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_base_loopbreak()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event_base * event_base_new
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event_base * event_base_new_with_config
+ (
+ const struct event_config *
+ cfg )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_once
+ (
+ struct event_base *
+ base ,
+
+ evutil_socket_t fd ,
+
+ short
+ events ,
+
+ event_callback_fn callback ,
+
+ void *
+ arg ,
+
+ const struct timeval *
+ timeout
+
+ )
+
+
+
+
+
Schedule a one-time event.
+
The function event_base_once() is similar to event_new() . However, it schedules a callback to be called exactly once, and does not require the caller to prepare an event structure.
+
Note that in Libevent 2.0 and earlier, if the event is never triggered, the internal memory used to hold it will never be freed. In Libevent 2.1, the internal memory will get freed by event_base_free() if the event is never triggered. The 'arg' value, however, will not get freed in either case–you'll need to free that on your own if you want it to go away.
+
Parameters
+
+ base an event_base fd a file descriptor to monitor, or -1 for no fd. events event(s) to monitor; can be any of EV_READ | EV_WRITE, or EV_TIMEOUT callback callback function to be invoked when the event occurs arg an argument to be passed to the callback function timeout the maximum amount of time to wait for the event. NULL makes an EV_READ/EV_WRITE event make forever; NULL makes an EV_TIMEOUT event success immediately.
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_priority_init
+ (
+ struct event_base *
+ eb ,
+
+ int
+ npriorities
+
+ )
+
+
+
+
+
Set the number of different event priorities.
+
By default Libevent schedules all active events with the same priority. However, some time it is desirable to process some events with a higher priority than others. For that reason, Libevent supports strict priority queues. Active events with a lower priority are always processed before events with a higher priority.
+
The number of different priorities can be set initially with the event_base_priority_init() function. This function should be called before the first call to event_base_dispatch() . The event_priority_set() function can be used to assign a priority to an event. By default, Libevent assigns the middle priority to all events unless their priority is explicitly set.
+
Note that urgent-priority events can starve less-urgent events: after running all urgent-priority callbacks, Libevent checks for more urgent events again, before running less-urgent events. Less-urgent events will not have their callbacks run until there are no events more urgent than them that want to be active.
+
Parameters
+
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_priority_set()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_set
+ (
+ struct event_base *
+ eb ,
+
+ struct event *
+ ev
+
+ )
+
+
+
+
+
Associate a different event base with an event.
+
The event to be associated must not be currently active or pending.
+
Parameters
+
+ eb the event base ev the event
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_base_update_cache_time
+ (
+ struct event_base *
+ base )
+
+
+
+
+
Update cached_tv in the 'base' to the current time.
+
You can use this function is useful for selectively increasing the accuracy of the cached time value in 'base' during callbacks that take a long time to execute.
+
This function has no effect if the base is currently not in its event loop, or if timeval caching is disabled via EVENT_BASE_FLAG_NO_CACHE_TIME.
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_config_avoid_method
+ (
+ struct event_config *
+ cfg ,
+
+ const char *
+ method
+
+ )
+
+
+
+
+
Enters an event method that should be avoided into the configuration.
+
This can be used to avoid event mechanisms that do not support certain file descriptor types, or for debugging to avoid certain event mechanisms. An application can make use of multiple event bases to accommodate incompatible file descriptor types.
+
Parameters
+
+ cfg the event configuration object method the name of the event method to avoid
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_config_free
+ (
+ struct event_config *
+ cfg )
+
+
+
+
+
Deallocates all memory associated with an event configuration object.
+
Parameters
+
+ cfg the event configuration object to be freed.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event_config * event_config_new
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_config_require_features
+ (
+ struct event_config *
+ cfg ,
+
+ int
+ feature
+
+ )
+
+
+
+
+
Enters a required event method feature that the application demands.
+
Note that not every feature or combination of features is supported on every platform. Code that requests features should be prepared to handle the case where event_base_new_with_config() returns NULL, as in:
+ event_config_require_features(cfg, EV_FEATURE_ET);
+ base = event_base_new_with_config(cfg);
+ if (base == NULL) {
+ // We can't get edge-triggered behavior here.
+ event_config_require_features(cfg, 0);
+ base = event_base_new_with_config(cfg);
+ }
+ Parameters
+
+ cfg the event configuration object feature a bitfield of one or more event_method_feature values. Replaces values from previous calls to this function.
+
+
+
Returns 0 on success, -1 on failure.
+
See also event_method_feature , event_base_new_with_config()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_config_set_flag
+ (
+ struct event_config *
+ cfg ,
+
+ int
+ flag
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_config_set_max_dispatch_interval
+ (
+ struct event_config *
+ cfg ,
+
+ const struct timeval *
+ max_interval ,
+
+ int
+ max_callbacks ,
+
+ int
+ min_priority
+
+ )
+
+
+
+
+
Record an interval and/or a number of callbacks after which the event base should check for new events.
+
By default, the event base will run as many events are as activated at the highest activated priority before checking for new events. If you configure it by setting max_interval, it will check the time after each callback, and not allow more than max_interval to elapse before checking for new events. If you configure it by setting max_callbacks to a value >= 0, it will run no more than max_callbacks callbacks before checking for new events.
+
This option can decrease the latency of high-priority events, and avoid priority inversions where multiple low-priority events keep us from polling for high-priority events, but at the expense of slightly decreasing the throughput. Use it with caution!
+
Parameters
+
+ cfg The event_base configuration object. max_interval An interval after which Libevent should stop running callbacks and check for more events, or NULL if there should be no such interval. max_callbacks A number of callbacks after which Libevent should stop running callbacks and check for more events, or -1 if there should be no such limit. min_priority A priority below which max_interval and max_callbacks should not be enforced. If this is set to 0, they are enforced for events of every priority; if it's set to 1, they're enforced for events of priority 1 and above, and so on.
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_config_set_num_cpus_hint
+ (
+ struct event_config *
+ cfg ,
+
+ int
+ cpus
+
+ )
+
+
+
+
+
Records a hint for the number of CPUs in the system.
+
This is used for tuning thread pools, etc, for optimal performance. In Libevent 2.0, it is only on Windows, and only when IOCP is in use.
+
Parameters
+
+ cfg the event configuration object cpus the number of cpus
+
+
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_debug_unassign
+ (
+ struct event *
+ )
+
+
+
+
+
When debugging mode is enabled, informs Libevent that an event should no longer be considered as assigned.
+
When debugging mode is not enabled, does nothing.
+
This function must only be called on a non-added event.
+
See also event_enable_debug_mode()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_del
+ (
+ struct event *
+ ev )
+
+
+
+
+
Remove an event from the set of monitored events.
+
The function event_del() will cancel the event in the argument ev. If the event has already executed or has never been added the call will have no effect.
+
Parameters
+
+ ev an event struct to be removed from the working set
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_add()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_enable_debug_logging
+ (
+ ev_uint32_t
+ which )
+
+
+
+
+
Turn on debugging logs and have them sent to the default log handler.
+
This is a global setting; if you are going to call it, you must call this before any calls that create an event-base. You must call it before any multithreaded use of Libevent.
+
Debug logs are verbose.
+
Parameters
+
+ which Controls which debug messages are turned on. This option is unused for now; for forward compatibility, you must pass in the constant "EVENT_DBG_ALL" to turn debugging logs on, or "EVENT_DBG_NONE" to turn debugging logs off.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_enable_debug_mode
+ (
+ void
+ )
+
+
+
+
+
Enable some relatively expensive debugging checks in Libevent that would normally be turned off.
+
Generally, these checks cause code that would otherwise crash mysteriously to fail earlier with an assertion failure. Note that this method MUST be called before any events or event_bases have been created.
+
Debug mode can currently catch the following errors: An event is re-assigned while it is added Any function is called on a non-assigned event
+
Note that debugging mode uses memory to track every event that has been initialized (via event_assign, event_set, or event_new) but not yet released (via event_free or event_debug_unassign). If you want to use debug mode, and you find yourself running out of memory, you will need to use event_debug_unassign to explicitly stop tracking events that are no longer considered set-up.
+
See also event_debug_unassign()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_free
+ (
+ struct event *
+ )
+
+
+
+
+
Deallocate a struct event * returned by event_new() .
+
If the event is pending or active, this function makes it non-pending and non-active first.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_get_assignment
+ (
+ const struct event *
+ event ,
+
+ struct event_base **
+ base_out ,
+
+ evutil_socket_t * fd_out ,
+
+ short *
+ events_out ,
+
+ event_callback_fn * callback_out ,
+
+ void **
+ arg_out
+
+ )
+
+
+
+
+
Extract all of arguments given to construct a given event.
+
The event_base is copied into *base_out, the fd is copied into *fd_out, and so on.
+
If any of the "_out" arguments is NULL, it will be ignored.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_get_priority
+ (
+ const struct event *
+ ev )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL size_t event_get_struct_event_size
+ (
+ void
+ )
+
+
+
+
+
Return the size of struct event that the Libevent library was compiled with.
+
This will be NO GREATER than sizeof(struct event) if you're running with the same version of Libevent that your application was built with, but otherwise might not.
+
Note that it might be SMALLER than sizeof(struct event) if some future version of Libevent adds extra padding to the end of struct event. We might do this to help ensure ABI-compatibility between different versions of Libevent.
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char** event_get_supported_methods
+ (
+ void
+ )
+
+
+
+
+
Gets all event notification mechanisms supported by Libevent.
+
This functions returns the event mechanism in order preferred by Libevent. Note that this list will include all backends that Libevent has compiled-in support for, and will not necessarily check your OS to see whether it has the required resources.
+
Returns an array with pointers to the names of support methods. The end of the array is indicated by a NULL pointer. If an error is encountered NULL is returned.
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* event_get_version
+ (
+ void
+ )
+
+
+
+
+
Get the Libevent version.
+
Note that this will give you the version of the library that you're currently linked against, not the version of the headers that you've compiled against.
+
Returns a string containing the version number of Libevent
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL ev_uint32_t event_get_version_number
+ (
+ void
+ )
+
+
+
+
+
Return a numeric representation of Libevent's version.
+
Note that this will give you the version of the library that you're currently linked against, not the version of the headers you've used to compile.
+
The format uses one byte each for the major, minor, and patchlevel parts of the version number. The low-order byte is unused. For example, version 2.0.1-alpha has a numeric representation of 0x02000100
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_initialized
+ (
+ const struct event *
+ ev )
+
+
+
+
+
Test if an event structure might be initialized.
+
The event_initialized() function can be used to check if an event has been initialized.
+
Warning: This function is only useful for distinguishing a zeroed-out piece of memory from an initialized event, it can easily be confused by uninitialized memory. Thus, it should ONLY be used to distinguish an initialized event from zero.
+
Parameters
+
+ ev an event structure to be tested
+
+
+
Returns 1 if the structure might be initialized, or 0 if it has not been initialized
+
+
+
+
+
◆
+
+
+
+
+
Allocate and assign a new event structure, ready to be added.
+
The function event_new() returns a new event that can be used in future calls to event_add() and event_del() . The fd and events arguments determine which conditions will trigger the event; the callback and callback_arg arguments tell Libevent what to do when the event becomes active.
+
If events contains one of EV_READ, EV_WRITE, or EV_READ|EV_WRITE, then fd is a file descriptor or socket that should get monitored for readiness to read, readiness to write, or readiness for either operation (respectively). If events contains EV_SIGNAL, then fd is a signal number to wait for. If events contains none of those flags, then the event can be triggered only by a timeout or by manual activation with event_active() : In this case, fd must be -1.
+
The EV_PERSIST flag can also be passed in the events argument: it makes event_add() persistent until event_del() is called.
+
The EV_ET flag is compatible with EV_READ and EV_WRITE, and supported only by certain backends. It tells Libevent to use edge-triggered events.
+
The EV_TIMEOUT flag has no effect here.
+
It is okay to have multiple events all listening on the same fds; but they must either all be edge-triggered, or not be edge-triggered at all.
+
When the event becomes active, the event loop will run the provided callback function, with three arguments. The first will be the provided fd value. The second will be a bitfield of the events that triggered: EV_READ, EV_WRITE, or EV_SIGNAL. Here the EV_TIMEOUT flag indicates that a timeout occurred, and EV_ET indicates that an edge-triggered event occurred. The third event will be the callback_arg pointer that you provide.
+
Parameters
+
+ base the event base to which the event should be attached. fd the file descriptor or signal to be monitored, or -1. events desired events to monitor: bitfield of EV_READ, EV_WRITE, EV_SIGNAL, EV_PERSIST, EV_ET. callback callback function to be invoked when the event occurs callback_arg an argument to be passed to the callback function
+
+
+
Returns a newly allocated struct event that must later be freed with event_free() or NULL if an error occurred.
+
See also event_free() , event_add() , event_del() , event_assign()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_pending
+ (
+ const struct event *
+ ev ,
+
+ short
+ events ,
+
+ struct timeval *
+ tv
+
+ )
+
+
+
+
+
Checks if a specific event is pending or scheduled.
+
Parameters
+
+ ev an event struct previously passed to event_add() events the requested event type; any of EV_TIMEOUT|EV_READ| EV_WRITE|EV_SIGNAL tv if this field is not NULL, and the event has a timeout, this field is set to hold the time at which the timeout will expire.
+
+
+
Returns true if the event is pending on any of the events in 'what', (that is to say, it has been added), or 0 if the event is not added.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_priority_set
+ (
+ struct event *
+ ev ,
+
+ int
+ priority
+
+ )
+
+
+
+
+
Assign a priority to an event.
+
Parameters
+
+ ev an event struct priority the new priority to be assigned
+
+
+
Returns 0 if successful, or -1 if an error occurred
+
See also event_priority_init() , event_get_priority()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_reinit
+ (
+ struct event_base *
+ base )
+
+
+
+
+
Reinitialize the event base after a fork.
+
Some event mechanisms do not survive across fork. The event base needs to be reinitialized with the event_reinit() function.
+
Parameters
+
+ base the event base that needs to be re-initialized
+
+
+
Returns 0 if successful, or -1 if some events could not be re-added.
+
See also event_base_new()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_remove_timer
+ (
+ struct event *
+ ev )
+
+
+
+
+
Remove a timer from a pending event without removing the event itself.
+
If the event has a scheduled timeout, this function unschedules it but leaves the event otherwise pending.
+
Parameters
+
+
+
+
Returns 0 on success, or -1 if an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void* event_self_cbarg
+ (
+ void
+ )
+
+
+
+
+
Return a value used to specify that the event itself must be used as the callback argument.
+
The function event_new() takes a callback argument which is passed to the event's callback function. To specify that the argument to be passed to the callback function is the event that event_new() returns, pass in the return value of event_self_cbarg() as the callback argument for event_new() .
+
For example:
+ struct event *ev = event_new(base, sock, events, callback, event_self_cbarg());
+ For consistency with event_new() , it is possible to pass the return value of this function as the callback argument for event_assign() – this achieves the same result as passing the event in directly.
+
Returns a value to be passed as the callback argument to event_new() or event_assign() .
+
See also event_new() , event_assign()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_set_fatal_callback
+ (
+ event_fatal_cb cb )
+
+
+
+
+
Override Libevent's behavior in the event of a fatal internal error.
+
By default, Libevent will call exit(1) if a programming error makes it impossible to continue correct operation. This function allows you to supply another callback instead. Note that if the function is ever invoked, something is wrong with your program, or with Libevent: any subsequent calls to Libevent may result in undefined behavior.
+
Libevent will (almost) always log an EVENT_LOG_ERR message before calling this function; look at the last log message to see why Libevent has died.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_set_log_callback
+ (
+ event_log_cb cb )
+
+
+
+
+
Redirect Libevent's log messages.
+
Parameters
+
+ cb a function taking two arguments: an integer severity between EVENT_LOG_DEBUG and EVENT_LOG_ERR, and a string. If cb is NULL, then the default log is used.
+
+
+
NOTE: The function you provide must not call any other libevent functionality. Doing so can produce undefined behavior.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_set_mem_functions
+ (
+ void *(*)(size_t sz)
+ malloc_fn ,
+
+ void *(*)(void *ptr, size_t sz)
+ realloc_fn ,
+
+ void(*)(void *ptr)
+ free_fn
+
+ )
+
+
+
+
+
Override the functions that Libevent uses for memory management.
+
Usually, Libevent uses the standard libc functions malloc, realloc, and free to allocate memory. Passing replacements for those functions to event_set_mem_functions() overrides this behavior.
+
Note that all memory returned from Libevent will be allocated by the replacement functions rather than by malloc() and realloc(). Thus, if you have replaced those functions, it will not be appropriate to free() memory that you get from Libevent. Instead, you must use the free_fn replacement that you provided.
+
Note also that if you are going to call this function, you should do so before any call to any Libevent function that does allocation. Otherwise, those functions will allocate their memory using malloc(), but then later free it using your provided free_fn.
+
Parameters
+
+ malloc_fn A replacement for malloc. realloc_fn A replacement for realloc free_fn A replacement for free.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void libevent_global_shutdown
+ (
+ void
+ )
+
+
+
+
+
Release up all globally-allocated resources allocated by Libevent.
+
This function does not free developer-controlled resources like event_bases, events, bufferevents, listeners, and so on. It only releases resources like global locks that there is no other way to free.
+
It is not actually necessary to call this function before exit: every resource that it frees would be released anyway on exit. It mainly exists so that resource-leak debugging tools don't see Libevent as holding resources at exit.
+
You should only call this function when no other Libevent functions will be invoked – e.g., when cleanly exiting a program.
+
+
+
+
libevent: event2/event.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_EVENT_H_INCLUDED_
+
28 #define EVENT2_EVENT_H_INCLUDED_
+
+
187 #include <event2/visibility.h>
+
+
+
+
+
+
193 #include <event2/event-config.h>
+
194 #ifdef EVENT__HAVE_SYS_TYPES_H
+
195 #include <sys/types.h>
+
+
197 #ifdef EVENT__HAVE_SYS_TIME_H
+
198 #include <sys/time.h>
+
+
+
+
+
+
+
+
+
220 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
+
277 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
+
296 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
425 #define EVENT_BASE_COUNT_ACTIVE 1U
+
+
428 #define EVENT_BASE_COUNT_VIRTUAL 2U
+
+
431 #define EVENT_BASE_COUNT_ADDED 4U
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
695 const struct timeval *max_interval,
int max_callbacks,
+
+
+
+
+
+
+
+
+
+
+
+
736 #define EVENT_LOG_DEBUG 0
+
737 #define EVENT_LOG_MSG 1
+
738 #define EVENT_LOG_WARN 2
+
739 #define EVENT_LOG_ERR 3
+
+
+
+
744 #define _EVENT_LOG_DEBUG EVENT_LOG_DEBUG
+
745 #define _EVENT_LOG_MSG EVENT_LOG_MSG
+
746 #define _EVENT_LOG_WARN EVENT_LOG_WARN
+
747 #define _EVENT_LOG_ERR EVENT_LOG_ERR
+
+
+
+
+
+
+
+
+
+
+
790 #define EVENT_DBG_ALL 0xffffffffu
+
791 #define EVENT_DBG_NONE 0
+
+
+
+
+
+
+
+
829 #define EVLOOP_ONCE 0x01
+
+
832 #define EVLOOP_NONBLOCK 0x02
+
+
837 #define EVLOOP_NO_EXIT_ON_EMPTY 0x04
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
955 #define EV_TIMEOUT 0x01
+
+
+
+
959 #define EV_WRITE 0x04
+
+
961 #define EV_SIGNAL 0x08
+
+
968 #define EV_PERSIST 0x10
+
+
+
+
979 #define EV_FINALIZE 0x40
+
+
988 #define EV_CLOSED 0x80
+
+
998 #define evtimer_assign(ev, b, cb, arg) \
+
999 event_assign((ev), (b), -1, 0, (cb), (arg))
+
1000 #define evtimer_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg))
+
1001 #define evtimer_add(ev, tv) event_add((ev), (tv))
+
1002 #define evtimer_del(ev) event_del(ev)
+
1003 #define evtimer_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv))
+
1004 #define evtimer_initialized(ev) event_initialized(ev)
+
+
1013 #define evsignal_add(ev, tv) event_add((ev), (tv))
+
1014 #define evsignal_assign(ev, b, x, cb, arg) \
+
1015 event_assign((ev), (b), (x), EV_SIGNAL|EV_PERSIST, cb, (arg))
+
1016 #define evsignal_new(b, x, cb, arg) \
+
1017 event_new((b), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
+
1018 #define evsignal_del(ev) event_del(ev)
+
1019 #define evsignal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv))
+
1020 #define evsignal_initialized(ev) event_initialized(ev)
+
+
1030 #define evuser_new(b, cb, arg) event_new((b), -1, 0, (cb), (arg))
+
1031 #define evuser_del(ev) event_del(ev)
+
1032 #define evuser_pending(ev, tv) event_pending((ev), 0, (tv))
+
1033 #define evuser_initialized(ev) event_initialized(ev)
+
1034 #define evuser_trigger(ev) event_active((ev), 0, 0)
+
+
+
+
1072 EVENT2_EXPORT_SYMBOL
+
+
+
1123 EVENT2_EXPORT_SYMBOL
+
+
+
+
1165 EVENT2_EXPORT_SYMBOL
+
+
+
1174 EVENT2_EXPORT_SYMBOL
+
+
+
+
1212 EVENT2_EXPORT_SYMBOL
+
+
1214 EVENT2_EXPORT_SYMBOL
+
+
1242 EVENT2_EXPORT_SYMBOL
+
+
+
1266 EVENT2_EXPORT_SYMBOL
+
+
+
1278 EVENT2_EXPORT_SYMBOL
+
+
+
1292 EVENT2_EXPORT_SYMBOL
+
+
+
1300 EVENT2_EXPORT_SYMBOL
+
+
1307 EVENT2_EXPORT_SYMBOL
+
+
+
1324 EVENT2_EXPORT_SYMBOL
+
+
+
1340 EVENT2_EXPORT_SYMBOL
+
+
+
1349 EVENT2_EXPORT_SYMBOL
+
+
+
1367 EVENT2_EXPORT_SYMBOL
+
+
+
1373 #define event_get_signal(ev) ((int)event_get_fd(ev))
+
+
1379 EVENT2_EXPORT_SYMBOL
+
+
+
1385 EVENT2_EXPORT_SYMBOL
+
+
+
1391 EVENT2_EXPORT_SYMBOL
+
+
+
1397 EVENT2_EXPORT_SYMBOL
+
+
+
1403 EVENT2_EXPORT_SYMBOL
+
+
+
1410 EVENT2_EXPORT_SYMBOL
+
+
+
1420 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
1438 EVENT2_EXPORT_SYMBOL
+
+
+
1450 EVENT2_EXPORT_SYMBOL
+
+
+
1464 EVENT2_EXPORT_SYMBOL
+
+
+
1468 #define LIBEVENT_VERSION EVENT__VERSION
+
+
1471 #define LIBEVENT_VERSION_NUMBER EVENT__NUMERIC_VERSION
+
+
1474 #define EVENT_MAX_PRIORITIES 256
+
+
1502 EVENT2_EXPORT_SYMBOL
+
+
+
1512 EVENT2_EXPORT_SYMBOL
+
+
+
1523 EVENT2_EXPORT_SYMBOL
+
+
+
1545 EVENT2_EXPORT_SYMBOL
+
+
1547 const struct timeval *duration);
+
+
1549 #if !defined(EVENT__DISABLE_MM_REPLACEMENT) || defined(EVENT_IN_DOXYGEN_)
+
+
1572 EVENT2_EXPORT_SYMBOL
+
+
1574 void *(*malloc_fn)(
size_t sz),
+
1575 void *(*realloc_fn)(
void *ptr,
size_t sz),
+
1576 void (*free_fn)(
void *ptr));
+
1579 #define EVENT_SET_MEM_FUNCTIONS_IMPLEMENTED
+
+
+
1592 EVENT2_EXPORT_SYMBOL
+
+
+
+
1606 EVENT2_EXPORT_SYMBOL
+
+
+
1618 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
1651 EVENT2_EXPORT_SYMBOL
+
+
+
+
1666 EVENT2_EXPORT_SYMBOL
+
+
1668 struct timeval *tv);
+
+
1682 EVENT2_EXPORT_SYMBOL
+
+
+
1699 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL void event_free(struct event *)
Deallocate a struct event * returned by event_new().
const EVENT2_EXPORT_SYMBOL char * event_base_get_signal_method(const struct event_base *eb)
Get the kernel signal handling mechanism used by Libevent.
void(* event_fatal_cb)(int err)
A function to be called if Libevent encounters a fatal internal error.
Definition: event.h:773
EVENT2_EXPORT_SYMBOL int event_base_get_npriorities(struct event_base *eb)
Get the number of different event priorities.
EVENT2_EXPORT_SYMBOL int event_base_get_features(const struct event_base *base)
Return a bitmask of the features implemented by an event base.
EVENT2_EXPORT_SYMBOL int event_base_update_cache_time(struct event_base *base)
Update cached_tv in the 'base' to the current time.
EVENT2_EXPORT_SYMBOL void event_base_active_by_fd(struct event_base *base, evutil_socket_t fd, short events)
Activates all pending events for the given fd and event mask.
EVENT2_EXPORT_SYMBOL struct event * event_new(struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg)
Allocate and assign a new event structure, ready to be added.
EVENT2_EXPORT_SYMBOL int event_del(struct event *ev)
Remove an event from the set of monitored events.
EVENT2_EXPORT_SYMBOL void event_set_mem_functions(void *(*malloc_fn)(size_t sz), void *(*realloc_fn)(void *ptr, size_t sz), void(*free_fn)(void *ptr))
Override the functions that Libevent uses for memory management.
EVENT2_EXPORT_SYMBOL int event_assign(struct event *ev, struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *callback_arg)
Prepare a new, already-allocated event structure to be added.
EVENT2_EXPORT_SYMBOL int event_config_set_num_cpus_hint(struct event_config *cfg, int cpus)
Records a hint for the number of CPUs in the system.
EVENT2_EXPORT_SYMBOL int event_base_once(struct event_base *base, evutil_socket_t fd, short events, event_callback_fn callback, void *arg, const struct timeval *timeout)
Schedule a one-time event.
EVENT2_EXPORT_SYMBOL int event_config_set_max_dispatch_interval(struct event_config *cfg, const struct timeval *max_interval, int max_callbacks, int min_priority)
Record an interval and/or a number of callbacks after which the event base should check for new event...
EVENT2_EXPORT_SYMBOL int event_get_priority(const struct event *ev)
Return the priority of an event.
EVENT2_EXPORT_SYMBOL int event_config_set_flag(struct event_config *cfg, int flag)
Sets one or more flags to configure what parts of the eventual event_base will be initialized,...
const EVENT2_EXPORT_SYMBOL char ** event_get_supported_methods(void)
Gets all event notification mechanisms supported by Libevent.
EVENT2_EXPORT_SYMBOL int event_gettime_monotonic(struct event_base *base, struct timeval *tp)
Query the current monotonic time from the timer for a struct event_base.
EVENT2_EXPORT_SYMBOL void event_set_fatal_callback(event_fatal_cb cb)
Override Libevent's behavior in the event of a fatal internal error.
EVENT2_EXPORT_SYMBOL void event_enable_debug_mode(void)
Enable some relatively expensive debugging checks in Libevent that would normally be turned off.
EVENT2_EXPORT_SYMBOL int event_reinit(struct event_base *base)
Reinitialize the event base after a fork.
EVENT2_EXPORT_SYMBOL struct event_base * event_base_new_with_config(const struct event_config *cfg)
Initialize the event API.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
@ EVENT_BASE_FLAG_NOLOCK
Do not allocate a lock for the event base, even if we have locking set up.
Definition: event.h:548
EVENT2_EXPORT_SYMBOL event_callback_fn event_get_callback(const struct event *ev)
Return the callback assigned to an event.
Structure to represent a single event.
Definition: event.h:276
EVENT2_EXPORT_SYMBOL void event_base_free_nofinalize(struct event_base *)
As event_base_free, but do not run finalizers.
EVENT2_EXPORT_SYMBOL void event_get_assignment(const struct event *event, struct event_base **base_out, evutil_socket_t *fd_out, short *events_out, event_callback_fn *callback_out, void **arg_out)
Extract all of arguments given to construct a given event.
@ EVENT_BASE_FLAG_STARTUP_IOCP
Windows only: enable the IOCP dispatcher at startup.
Definition: event.h:560
EVENT2_EXPORT_SYMBOL int event_priority_set(struct event *ev, int priority)
Assign a priority to an event.
EVENT2_EXPORT_SYMBOL ev_uint32_t event_get_version_number(void)
Return a numeric representation of Libevent's version.
void(* event_log_cb)(int severity, const char *msg)
A callback function used to intercept Libevent's log messages.
Definition: event.h:754
EVENT2_EXPORT_SYMBOL size_t event_get_struct_event_size(void)
Return the size of struct event that the Libevent library was compiled with.
@ EV_FEATURE_O1
Require an event method where having one event triggered among many is [approximately] an O(1) operat...
Definition: event.h:520
EVENT2_EXPORT_SYMBOL short event_get_events(const struct event *ev)
Return the events (EV_READ, EV_WRITE, etc) assigned to an event.
EVENT2_EXPORT_SYMBOL int event_initialized(const struct event *ev)
Test if an event structure might be initialized.
EVENT2_EXPORT_SYMBOL struct event_config * event_config_new(void)
Allocates a new event configuration object.
@ EVENT_BASE_FLAG_USE_SIGNALFD
Use signalfd(2) to handle signals over sigaction/signal.
Definition: event.h:606
EVENT2_EXPORT_SYMBOL void * event_get_callback_arg(const struct event *ev)
Return the callback argument assigned to an event.
EVENT2_EXPORT_SYMBOL void event_active(struct event *ev, int res, short ncalls)
Make an event active.
event_method_feature
A flag used to describe which features an event_base (must) provide.
Definition: event.h:513
void(* event_finalize_callback_fn)(struct event *, void *)
Callback type for event_finalize and event_free_finalize().
Definition: event.h:1180
EVENT2_EXPORT_SYMBOL int event_base_got_exit(struct event_base *eb)
Checks if the event loop was told to exit by event_base_loopexit().
EVENT2_EXPORT_SYMBOL int event_base_get_max_events(struct event_base *eb, unsigned int flags, int clear)
Get the maximum number of events in a given event_base as specified in the flags.
EVENT2_EXPORT_SYMBOL void libevent_global_shutdown(void)
Release up all globally-allocated resources allocated by Libevent.
const EVENT2_EXPORT_SYMBOL char * event_get_version(void)
Get the Libevent version.
EVENT2_EXPORT_SYMBOL evutil_socket_t event_get_fd(const struct event *ev)
Get the socket or signal assigned to an event, or -1 if the event has no socket.
@ EV_FEATURE_ET
Require an event method that allows edge-triggered events with EV_ET.
Definition: event.h:515
EVENT2_EXPORT_SYMBOL int event_del_noblock(struct event *ev)
As event_del(), but never blocks while the event's callback is running in another thread,...
EVENT2_EXPORT_SYMBOL void event_config_free(struct event_config *cfg)
Deallocates all memory associated with an event configuration object.
const EVENT2_EXPORT_SYMBOL char * event_base_get_method(const struct event_base *eb)
Get the kernel event notification mechanism used by Libevent.
event_base_config_flag
A flag passed to event_config_set_flag().
Definition: event.h:541
EVENT2_EXPORT_SYMBOL int event_config_require_features(struct event_config *cfg, int feature)
Enters a required event method feature that the application demands.
EVENT2_EXPORT_SYMBOL void event_base_dump_events(struct event_base *base, FILE *output)
Writes a human-readable description of all inserted and/or active events to a provided stdio stream.
EVENT2_EXPORT_SYMBOL void * event_self_cbarg(void)
Return a value used to specify that the event itself must be used as the callback argument.
EVENT2_EXPORT_SYMBOL const struct timeval * event_base_init_common_timeout(struct event_base *base, const struct timeval *duration)
Prepare an event_base to use a large number of timeouts with the same duration.
EVENT2_EXPORT_SYMBOL int event_base_loop(struct event_base *eb, int flags)
Wait for events to become active, and run their callbacks.
EVENT2_EXPORT_SYMBOL void event_base_active_by_signal(struct event_base *base, int sig)
Activates all pending signals with a given signal number.
EVENT2_EXPORT_SYMBOL int event_base_priority_init(struct event_base *eb, int npriorities)
Set the number of different event priorities.
EVENT2_EXPORT_SYMBOL int event_del_block(struct event *ev)
As event_del(), but always blocks while the event's callback is running in another thread,...
@ EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST
If we are using the epoll backend, this flag says that it is safe to use Libevent's internal change-l...
Definition: event.h:580
EVENT2_EXPORT_SYMBOL int event_base_loopexit(struct event_base *eb, const struct timeval *tv)
Exit the event loop after the specified time.
EVENT2_EXPORT_SYMBOL void event_debug_unassign(struct event *)
When debugging mode is enabled, informs Libevent that an event should no longer be considered as assi...
EVENT2_EXPORT_SYMBOL struct event * event_base_get_running_event(struct event_base *base)
If called from within the callback for an event, returns that event.
EVENT2_EXPORT_SYMBOL void event_base_free(struct event_base *eb)
Deallocate all memory associated with an event_base, and free the base.
EVENT2_EXPORT_SYMBOL int event_pending(const struct event *ev, short events, struct timeval *tv)
Checks if a specific event is pending or scheduled.
Configuration for an event_base.
Definition: event.h:295
EVENT2_EXPORT_SYMBOL int event_remove_timer(struct event *ev)
Remove a timer from a pending event without removing the event itself.
@ EVENT_BASE_FLAG_PRECISE_TIMER
Ordinarily, Libevent implements its time and timeout code using the fastest monotonic timer that we h...
Definition: event.h:587
EVENT2_EXPORT_SYMBOL int event_base_dispatch(struct event_base *base)
Event dispatching loop.
@ EV_FEATURE_EARLY_CLOSE
Require an event method that allows you to use EV_CLOSED to detect connection close without the neces...
Definition: event.h:530
@ EVENT_BASE_FLAG_IGNORE_ENV
Do not check the EVENT_* environment variables when configuring an event_base
Definition: event.h:551
EVENT2_EXPORT_SYMBOL int event_config_avoid_method(struct event_config *cfg, const char *method)
Enters an event method that should be avoided into the configuration.
EVENT2_EXPORT_SYMBOL int event_base_get_num_events(struct event_base *eb, unsigned int flags)
Gets the number of events in event_base, as specified in the flags.
EVENT2_EXPORT_SYMBOL int event_add(struct event *ev, const struct timeval *timeout)
Add an event to the set of pending events.
EVENT2_EXPORT_SYMBOL int event_base_set(struct event_base *eb, struct event *ev)
Associate a different event base with an event.
EVENT2_EXPORT_SYMBOL int event_base_foreach_event(struct event_base *base, event_base_foreach_event_cb fn, void *arg)
Iterate over all added or active events events in an event loop, and invoke a given callback on each ...
EVENT2_EXPORT_SYMBOL void event_enable_debug_logging(ev_uint32_t which)
Turn on debugging logs and have them sent to the default log handler.
int(* event_base_foreach_event_cb)(const struct event_base *, const struct event *, void *)
Callback for iterating events in an event base via event_base_foreach_event.
Definition: event.h:1624
void(* event_callback_fn)(evutil_socket_t, short, void *)
A callback function for an event.
Definition: event.h:1048
@ EVENT_BASE_FLAG_EPOLL_DISALLOW_TIMERFD
With EVENT_BASE_FLAG_PRECISE_TIMER, epoll backend will use timerfd for more accurate timers,...
Definition: event.h:600
@ EV_FEATURE_FDS
Require an event method that allows file descriptors as well as sockets.
Definition: event.h:523
Common convenience functions for cross-platform portability and related socket manipulations.
@ EVENT_BASE_FLAG_NO_CACHE_TIME
Instead of checking the current time every time the event loop is ready to run timeout callbacks,...
Definition: event.h:564
EVENT2_EXPORT_SYMBOL struct event_base * event_base_new(void)
Create and return a new event_base to use with the rest of Libevent.
EVENT2_EXPORT_SYMBOL int event_base_loopcontinue(struct event_base *eb)
Tell the active event_base_loop() to scan for new events immediately.
EVENT2_EXPORT_SYMBOL int event_base_loopbreak(struct event_base *eb)
Abort the active event_base_loop() immediately.
EVENT2_EXPORT_SYMBOL int event_base_got_break(struct event_base *eb)
Checks if the event loop was told to abort immediately by event_base_loopbreak().
EVENT2_EXPORT_SYMBOL struct event_base * event_get_base(const struct event *ev)
Get the event_base associated with an event.
EVENT2_EXPORT_SYMBOL int event_base_gettimeofday_cached(struct event_base *base, struct timeval *tv)
Sets 'tv' to the current time (as returned by gettimeofday()), looking at the cached value in 'base' ...
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
EVENT2_EXPORT_SYMBOL void event_set_log_callback(event_log_cb cb)
Redirect Libevent's log messages.
libevent: event2/event_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Potentially non-threadsafe versions of the functions in event.h : provided only for backwards compatibility.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+EVENT_FD (ev) ((int)event_get_fd (ev)) EVENT_SIGNAL (ev) event_get_signal (ev) evsignal_set (ev, x, cb, arg) event_set ((ev), (x), EV_SIGNAL |EV_PERSIST , (cb), (arg)) evtimer_set (ev, cb, arg) event_set ((ev), -1, 0, (cb), (arg)) Deprecated: These macros are deprecated because their naming is inconsistent with the rest of Libevent.
+
Use the evtimer_* macros instead.
+
timeout_add (ev, tv) event_add ((ev), (tv)) timeout_del (ev) event_del (ev) timeout_initialized (ev) event_initialized (ev) timeout_pending (ev, tv) event_pending ((ev), EV_TIMEOUT , (tv)) timeout_set (ev, cb, arg) event_set ((ev), -1, 0, (cb), (arg)) Deprecated: These macros are deprecated because their naming is inconsistent with the rest of Libevent.
+
Use the evsignal_* macros instead.
+
signal_add (ev, tv) event_add ((ev), (tv)) signal_del (ev) event_del (ev) signal_initialized (ev) event_initialized (ev) signal_pending (ev, tv) event_pending ((ev), EV_SIGNAL , (tv)) signal_set (ev, x, cb, arg) event_set ((ev), (x), EV_SIGNAL |EV_PERSIST , (cb), (arg))
+EVENT2_EXPORT_SYMBOL int event_dispatch (void) Loop to process events. More... const EVENT2_EXPORT_SYMBOL char * event_get_method (void) Get the kernel event notification mechanism used by Libevent. More... EVENT2_EXPORT_SYMBOL struct event_base * event_init (void) Initialize the event API. More... EVENT2_EXPORT_SYMBOL int event_loop (int) Handle events. More... EVENT2_EXPORT_SYMBOL int event_loopbreak (void) Abort the active event_loop() immediately. More... EVENT2_EXPORT_SYMBOL int event_loopexit (const struct timeval *) Exit the event loop after the specified time. More... EVENT2_EXPORT_SYMBOL int event_once (evutil_socket_t , short, void(*)(evutil_socket_t , short, void *), void *, const struct timeval *) Schedule a one-time event to occur. More... EVENT2_EXPORT_SYMBOL int event_priority_init (int) Set the number of different event priorities. More... EVENT2_EXPORT_SYMBOL void event_set (struct event *, evutil_socket_t , short, void(*)(evutil_socket_t , short, void *), void *) Prepare an event structure to be added. More...
+
+
Potentially non-threadsafe versions of the functions in event.h : provided only for backwards compatibility.
+
In the oldest versions of Libevent, event_base was not a first-class structure. Instead, there was a single event base that every function manipulated. Later, when separate event bases were added, the old functions that didn't take an event_base argument needed to work by manipulating the "current" event base. This could lead to thread-safety issues, and obscure, hard-to-diagnose bugs.
+
Deprecated: All functions in this file are by definition deprecated.
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_dispatch
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* event_get_method
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event_base * event_init
+ (
+ void
+ )
+
+
+
+
+
Initialize the event API.
+
The event API needs to be initialized with event_init() before it can be used. Sets the global current base that gets used for events that have no base associated with them.
+
Deprecated: This function is deprecated because it replaces the "current" event_base , and is totally unsafe for multithreaded use. The replacement is event_base_new() .
+
See also event_base_set() , event_base_new()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_loop
+ (
+ int
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_loopbreak
+ (
+ void
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_loopexit
+ (
+ const struct timeval *
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_once
+ (
+ evutil_socket_t ,
+
+
+ short
+ ,
+
+
+ void(*)(evutil_socket_t , short, void *)
+ ,
+
+
+ void *
+ ,
+
+
+ const struct timeval *
+
+
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int event_priority_init
+ (
+ int
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void event_set
+ (
+ struct event *
+ ,
+
+
+ evutil_socket_t ,
+
+
+ short
+ ,
+
+
+ void(*)(evutil_socket_t , short, void *)
+ ,
+
+
+ void *
+
+
+
+ )
+
+
+
+
+
libevent: event2/event_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_EVENT_COMPAT_H_INCLUDED_
+
28 #define EVENT2_EVENT_COMPAT_H_INCLUDED_
+
+
44 #include <event2/visibility.h>
+
+
+
+
+
+
50 #include <event2/event-config.h>
+
51 #ifdef EVENT__HAVE_SYS_TYPES_H
+
52 #include <sys/types.h>
+
+
54 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
148 void (*)(
evutil_socket_t ,
short ,
void *),
void *,
const struct timeval *);
+
+
+
+
+
+
+
+
+
+
+
+
+
186 #define evtimer_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
+
187 #define evsignal_set(ev, x, cb, arg) \
+
188 event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
+
+
+
198 #define timeout_add(ev, tv) event_add((ev), (tv))
+
199 #define timeout_set(ev, cb, arg) event_set((ev), -1, 0, (cb), (arg))
+
200 #define timeout_del(ev) event_del(ev)
+
201 #define timeout_pending(ev, tv) event_pending((ev), EV_TIMEOUT, (tv))
+
202 #define timeout_initialized(ev) event_initialized(ev)
+
+
212 #define signal_add(ev, tv) event_add((ev), (tv))
+
213 #define signal_set(ev, x, cb, arg) \
+
214 event_set((ev), (x), EV_SIGNAL|EV_PERSIST, (cb), (arg))
+
215 #define signal_del(ev) event_del(ev)
+
216 #define signal_pending(ev, tv) event_pending((ev), EV_SIGNAL, (tv))
+
217 #define signal_initialized(ev) event_initialized(ev)
+
+
+
+
222 #define EVENT_FD(ev) ((int)event_get_fd(ev))
+
223 #define EVENT_SIGNAL(ev) event_get_signal(ev)
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int event_dispatch(void)
Loop to process events.
EVENT2_EXPORT_SYMBOL int event_loopbreak(void)
Abort the active event_loop() immediately.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL int event_priority_init(int)
Set the number of different event priorities.
Structure to represent a single event.
Definition: event.h:276
EVENT2_EXPORT_SYMBOL int event_loop(int)
Handle events.
EVENT2_EXPORT_SYMBOL int event_once(evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *, const struct timeval *)
Schedule a one-time event to occur.
EVENT2_EXPORT_SYMBOL struct event_base * event_init(void)
Initialize the event API.
const EVENT2_EXPORT_SYMBOL char * event_get_method(void)
Get the kernel event notification mechanism used by Libevent.
EVENT2_EXPORT_SYMBOL int event_loopexit(const struct timeval *)
Exit the event loop after the specified time.
EVENT2_EXPORT_SYMBOL void event_set(struct event *, evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *)
Prepare an event structure to be added.
Common convenience functions for cross-platform portability and related socket manipulations.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: File List
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented files with brief descriptions:
+
[detail level 1 2 ]
+ ▼ event2 buffer.h Functions for buffering data for network sending or receiving buffer_compat.h Obsolete and deprecated versions of the functions in buffer.h : provided only for backward compatibility bufferevent.h Functions for buffering data for network sending or receiving bufferevent_compat.h Deprecated versions of the functions in bufferevent.h : provided only for backwards compatibility bufferevent_ssl.h OpenSSL support for bufferevents dns.h Provides a few APIs to use for resolving DNS names, and a facility for implementing simple DNS servers dns_compat.h Potentially non-threadsafe versions of the functions in dns.h : provided only for backwards compatibility event.h Core functions for waiting for and receiving events, and using event bases event_compat.h Potentially non-threadsafe versions of the functions in event.h : provided only for backwards compatibility http.h Basic support for HTTP serving http_compat.h Potentially non-threadsafe versions of the functions in http.h : provided only for backwards compatibility listener.h A callback that we invoke when a listener has a new connection rpc.h This header files provides basic support for an RPC server and client rpc_compat.h Deprecated versions of the functions in rpc.h : provided only for backwards compatibility tag.h Helper functions for reading and writing tagged data onto buffers tag_compat.h Obsolete/deprecated functions from tag.h ; provided only for backwards compatibility thread.h Functions for multi-threaded applications using Libevent util.h Common convenience functions for cross-platform portability and related socket manipulations watch.h "Prepare" and "check" watchers
+
+
libevent: Data Fields
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented struct and union fields with links to the struct/union documentation for each field:
+
libevent: Data Fields - Variables
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/globals.html b/globals.html
new file mode 100644
index 0000000..83bfedd
--- /dev/null
+++ b/globals.html
@@ -0,0 +1,369 @@
+
+
+
+libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+DNS_CNAME_CALLBACK
+: dns.h
+
+DNS_ERR_CANCEL
+: dns.h
+
+DNS_ERR_FORMAT
+: dns.h
+
+DNS_ERR_NODATA
+: dns.h
+
+DNS_ERR_NONE
+: dns.h
+
+DNS_ERR_NOTEXIST
+: dns.h
+
+DNS_ERR_NOTIMPL
+: dns.h
+
+DNS_ERR_REFUSED
+: dns.h
+
+DNS_ERR_SERVERFAILED
+: dns.h
+
+DNS_ERR_SHUTDOWN
+: dns.h
+
+DNS_ERR_TIMEOUT
+: dns.h
+
+DNS_ERR_TRUNCATED
+: dns.h
+
+DNS_ERR_UNKNOWN
+: dns.h
+
+DNS_OPTIONS_ALL
+: dns.h
+
+DNS_QUERY_IGNTC
+: dns.h
+
+DNS_QUERY_NO_SEARCH
+: dns.h
+
+DNS_QUERY_USEVC
+: dns.h
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+DNS_CNAME_CALLBACK
+: dns.h
+
+DNS_ERR_CANCEL
+: dns.h
+
+DNS_ERR_FORMAT
+: dns.h
+
+DNS_ERR_NODATA
+: dns.h
+
+DNS_ERR_NONE
+: dns.h
+
+DNS_ERR_NOTEXIST
+: dns.h
+
+DNS_ERR_NOTIMPL
+: dns.h
+
+DNS_ERR_REFUSED
+: dns.h
+
+DNS_ERR_SERVERFAILED
+: dns.h
+
+DNS_ERR_SHUTDOWN
+: dns.h
+
+DNS_ERR_TIMEOUT
+: dns.h
+
+DNS_ERR_TRUNCATED
+: dns.h
+
+DNS_ERR_UNKNOWN
+: dns.h
+
+DNS_OPTIONS_ALL
+: dns.h
+
+DNS_QUERY_IGNTC
+: dns.h
+
+DNS_QUERY_NO_SEARCH
+: dns.h
+
+DNS_QUERY_USEVC
+: dns.h
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/globals_enum.html b/globals_enum.html
new file mode 100644
index 0000000..f6d722c
--- /dev/null
+++ b/globals_enum.html
@@ -0,0 +1,121 @@
+
+
+
+libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/globals_eval.html b/globals_eval.html
new file mode 100644
index 0000000..77bcb61
--- /dev/null
+++ b/globals_eval.html
@@ -0,0 +1,214 @@
+
+
+
+libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+EV_FEATURE_EARLY_CLOSE
+: event.h
+
+EV_FEATURE_ET
+: event.h
+
+EV_FEATURE_FDS
+: event.h
+
+EV_FEATURE_O1
+: event.h
+
+EVBUFFER_EOL_ANY
+: buffer.h
+
+EVBUFFER_EOL_CRLF
+: buffer.h
+
+EVBUFFER_EOL_CRLF_STRICT
+: buffer.h
+
+EVBUFFER_EOL_LF
+: buffer.h
+
+EVBUFFER_EOL_NUL
+: buffer.h
+
+EVBUFFER_PTR_ADD
+: buffer.h
+
+EVBUFFER_PTR_SET
+: buffer.h
+
+EVDNS_SOPT_TCP_IDLE_TIMEOUT
+: dns.h
+
+EVDNS_SOPT_TCP_MAX_CLIENTS
+: dns.h
+
+EVENT_BASE_FLAG_EPOLL_DISALLOW_TIMERFD
+: event.h
+
+EVENT_BASE_FLAG_EPOLL_USE_CHANGELIST
+: event.h
+
+EVENT_BASE_FLAG_IGNORE_ENV
+: event.h
+
+EVENT_BASE_FLAG_NO_CACHE_TIME
+: event.h
+
+EVENT_BASE_FLAG_NOLOCK
+: event.h
+
+EVENT_BASE_FLAG_PRECISE_TIMER
+: event.h
+
+EVENT_BASE_FLAG_STARTUP_IOCP
+: event.h
+
+EVENT_BASE_FLAG_USE_SIGNALFD
+: event.h
+
+EVREQ_HTTP_BUFFER_ERROR
+: http.h
+
+EVREQ_HTTP_DATA_TOO_LONG
+: http.h
+
+EVREQ_HTTP_EOF
+: http.h
+
+EVREQ_HTTP_INVALID_HEADER
+: http.h
+
+EVREQ_HTTP_REQUEST_CANCEL
+: http.h
+
+EVREQ_HTTP_TIMEOUT
+: http.h
+
+EVRPC_CONTINUE
+: rpc.h
+
+EVRPC_INPUT
+: rpc.h
+
+EVRPC_OUTPUT
+: rpc.h
+
+EVRPC_PAUSE
+: rpc.h
+
+EVRPC_TERMINATE
+: rpc.h
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/globals_func_e.html b/globals_func_e.html
new file mode 100644
index 0000000..94e7d3b
--- /dev/null
+++ b/globals_func_e.html
@@ -0,0 +1,1215 @@
+
+
+
+libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/globals_func_l.html b/globals_func_l.html
new file mode 100644
index 0000000..e23a7cd
--- /dev/null
+++ b/globals_func_l.html
@@ -0,0 +1,81 @@
+
+
+
+libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+libevent_global_shutdown()
+: event.h
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:
+
+
+
libevent: Globals
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/http_8h.html b/http_8h.html
new file mode 100644
index 0000000..b17b02e
--- /dev/null
+++ b/http_8h.html
@@ -0,0 +1,3955 @@
+
+
+
+libevent: event2/http.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Basic support for HTTP serving.
+More...
+
#include <event2/util.h >
+
#include <event2/visibility.h>
+
+
Go to the source code of this file.
+
+struct evhttp_ext_method stucture that is passed to (and modified by) the extended method callback function More...
+evhttp_bound_socket_foreach_fn (struct evhttp_bound_socket *, void *) evhttp_ext_method_cb ) (struct evhttp_ext_method *)
+enum evhttp_cmd_type { EVHTTP_REQ_GET = 1 << 0,
+EVHTTP_REQ_POST = 1 << 1,
+EVHTTP_REQ_HEAD = 1 << 2,
+EVHTTP_REQ_PUT = 1 << 3,
+EVHTTP_REQ_DELETE = 1 << 4,
+EVHTTP_REQ_OPTIONS = 1 << 5,
+EVHTTP_REQ_TRACE = 1 << 6,
+EVHTTP_REQ_CONNECT = 1 << 7,
+EVHTTP_REQ_PATCH = 1 << 8,
+EVHTTP_REQ_PROPFIND = 1 << 9,
+EVHTTP_REQ_PROPPATCH =1 << 10,
+EVHTTP_REQ_MKCOL = 1 << 11,
+EVHTTP_REQ_LOCK = 1 << 12,
+EVHTTP_REQ_UNLOCK = 1 << 13,
+EVHTTP_REQ_COPY = 1 << 14,
+EVHTTP_REQ_MOVE = 1 << 15
+ The different request types supported by evhttp. More... enum evhttp_request_error { EVREQ_HTTP_TIMEOUT ,
+EVREQ_HTTP_EOF ,
+EVREQ_HTTP_INVALID_HEADER ,
+EVREQ_HTTP_BUFFER_ERROR ,
+EVREQ_HTTP_REQUEST_CANCEL ,
+EVREQ_HTTP_DATA_TOO_LONG
+ The different error types supported by evhttp. More... evhttp_request_kind { EVHTTP_REQUEST ,
+EVHTTP_RESPONSE
+ } a request object can represent either a request or a reply
+EVENT2_EXPORT_SYMBOL int evhttp_accept_socket (struct evhttp *http, evutil_socket_t fd) Makes an HTTP server accept connections on the specified socket. More... EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_accept_socket_with_handle (struct evhttp *http, evutil_socket_t fd) Like evhttp_accept_socket() , but returns a handle for referencing the socket. More... EVENT2_EXPORT_SYMBOL int evhttp_add_header (struct evkeyvalq *headers, const char *key, const char *value) Adds a header to a list of existing headers. More... EVENT2_EXPORT_SYMBOL int evhttp_add_server_alias (struct evhttp *http, const char *alias) Add a server alias to an http object. More... EVENT2_EXPORT_SYMBOL int evhttp_add_virtual_host (struct evhttp *http, const char *pattern, struct evhttp *vhost) Adds a virtual host to the http server. More... EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_bind_listener (struct evhttp *http, struct evconnlistener *listener) The most low-level evhttp_bind/accept method: takes an evconnlistener, and returns an evhttp_bound_socket. More... EVENT2_EXPORT_SYMBOL int evhttp_bind_socket (struct evhttp *http, const char *address, ev_uint16_t port) Binds an HTTP server on the specified address and port. More... EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_bind_socket_with_handle (struct evhttp *http, const char *address, ev_uint16_t port) Like evhttp_bind_socket() , but returns a handle for referencing the socket. More... evhttp_bound_set_bevcb (struct evhttp_bound_socket *bound, struct bufferevent *(*cb)(struct event_base *, void *), void *cbarg) EVENT2_EXPORT_SYMBOL evutil_socket_t evhttp_bound_socket_get_fd (struct evhttp_bound_socket *bound_socket) Get the raw file descriptor referenced by an evhttp_bound_socket. More... evhttp_bound_socket_get_listener (struct evhttp_bound_socket *bound) Return the listener used to implement a bound socket. EVENT2_EXPORT_SYMBOL void evhttp_cancel_request (struct evhttp_request *req) Cancels a pending HTTP request. More... EVENT2_EXPORT_SYMBOL void evhttp_clear_headers (struct evkeyvalq *headers) Removes all headers from the header list. More... EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_bufferevent_new (struct event_base *base, struct evdns_base *dnsbase, struct bufferevent *bev, const char *address, ev_uint16_t port) Create and return a connection object that can be used to for making HTTP requests. More... EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_bufferevent_unix_new (struct event_base *base, struct bufferevent *bev, const char *path) Create and return a connection object that can be used to for making HTTP requests over an unix domain socket. More... EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_new (struct event_base *base, struct evdns_base *dnsbase, const char *address, ev_uint16_t port) Create and return a connection object that can be used to for making HTTP requests. More... evhttp_connection_free (struct evhttp_connection *evcon) Frees an http connection. EVENT2_EXPORT_SYMBOL void evhttp_connection_free_on_completion (struct evhttp_connection *evcon) Disowns a given connection object. More... EVENT2_EXPORT_SYMBOL const struct sockaddr * evhttp_connection_get_addr (struct evhttp_connection *evcon) Get the remote address associated with this connection. More... event_base * evhttp_connection_get_base (struct evhttp_connection *req) Returns the underlying event_base for this connection. bufferevent * evhttp_connection_get_bufferevent (struct evhttp_connection *evcon) Return the bufferevent that an evhttp_connection is using. evhttp_connection_get_peer (struct evhttp_connection *evcon, const char **address, ev_uint16_t *port) Get the remote address and port associated with this connection. evhttp_connection_get_server (struct evhttp_connection *evcon) Return the HTTP server associated with this connection, or NULL. evhttp_connection_set_closecb (struct evhttp_connection *evcon, void(*)(struct evhttp_connection *, void *), void *) Set a callback for connection close. EVENT2_EXPORT_SYMBOL void evhttp_connection_set_connect_timeout_tv (struct evhttp_connection *evcon, const struct timeval *tv) Sets the connect timeout for this connection. More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_ext_method_cmp (struct evhttp_connection *evcon, evhttp_ext_method_cb cmp) Sets extended method cmp callback for this http connection. More... evhttp_connection_set_family (struct evhttp_connection *evcon, int family) Set family hint for DNS requests. EVENT2_EXPORT_SYMBOL int evhttp_connection_set_flags (struct evhttp_connection *evcon, int flags) Set connection flags. More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_initial_retry_tv (struct evhttp_connection *evcon, const struct timeval *tv) Sets the delay before retrying requests on this connection. More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_local_address (struct evhttp_connection *evcon, const char *address) Sets the IP address from which http connections are made. More... evhttp_connection_set_local_port (struct evhttp_connection *evcon, ev_uint16_t port) sets the local port from which http connections are made evhttp_connection_set_max_body_size (struct evhttp_connection *evcon, ev_ssize_t new_max_body_size) evhttp_connection_set_max_headers_size (struct evhttp_connection *evcon, ev_ssize_t new_max_headers_size) EVENT2_EXPORT_SYMBOL void evhttp_connection_set_read_timeout_tv (struct evhttp_connection *evcon, const struct timeval *tv) Sets the read timeout for this connection. More... evhttp_connection_set_retries (struct evhttp_connection *evcon, int retry_max) Sets the retry limit for this connection - -1 repeats indefinitely. EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout (struct evhttp_connection *evcon, int timeout) Sets the timeout for this connection. More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout_tv (struct evhttp_connection *evcon, const struct timeval *tv) Sets the timeout for this connection for the following events: More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_write_timeout_tv (struct evhttp_connection *evcon, const struct timeval *tv) Sets the write timeout for this connection. More... EVENT2_EXPORT_SYMBOL char * evhttp_decode_uri (const char *uri) Helper function to sort of decode a URI-encoded string. More... EVENT2_EXPORT_SYMBOL void evhttp_del_accept_socket (struct evhttp *http, struct evhttp_bound_socket *bound_socket) Makes an HTTP server stop accepting connections on the specified socket. More... evhttp_del_cb (struct evhttp *, const char *) Removes the callback for a specified URI. EVENT2_EXPORT_SYMBOL char * evhttp_encode_uri (const char *str) Helper function to encode a string for inclusion in a URI. More... const EVENT2_EXPORT_SYMBOL char * evhttp_find_header (const struct evkeyvalq *headers, const char *key) Finds the value belonging to a header. More... EVENT2_EXPORT_SYMBOL void evhttp_foreach_bound_socket (struct evhttp *http, evhttp_bound_socket_foreach_fn *function, void *argument) Applies the function specified in the first argument to all evhttp_bound_sockets associated with "http". More... EVENT2_EXPORT_SYMBOL void evhttp_free (struct evhttp *http) Free the previously created HTTP server. More... EVENT2_EXPORT_SYMBOL int evhttp_get_connection_count (struct evhttp *http) Get the current number of connections. More... EVENT2_EXPORT_SYMBOL char * evhttp_htmlescape (const char *html) Escape HTML character entities in a string. More... EVENT2_EXPORT_SYMBOL int evhttp_make_request (struct evhttp_connection *evcon, struct evhttp_request *req, enum evhttp_cmd_type type, const char *uri) Make an HTTP request over the specified connection. More... EVENT2_EXPORT_SYMBOL struct evhttp * evhttp_new (struct event_base *base) Create a new HTTP server. More... EVENT2_EXPORT_SYMBOL int evhttp_parse_query (const char *uri, struct evkeyvalq *headers) Helper function to parse out arguments in a query. More... EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str (const char *uri, struct evkeyvalq *headers) EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str_flags (const char *uri, struct evkeyvalq *headers, unsigned flags) Helper function to parse out arguments from the query portion of an HTTP URI. More... EVENT2_EXPORT_SYMBOL int evhttp_remove_header (struct evkeyvalq *headers, const char *key) Removes a header from a list of existing headers. More... EVENT2_EXPORT_SYMBOL int evhttp_remove_server_alias (struct evhttp *http, const char *alias) Remove a server alias from an http object. More... EVENT2_EXPORT_SYMBOL int evhttp_remove_virtual_host (struct evhttp *http, struct evhttp *vhost) Removes a virtual host from the http server. More... evhttp_request_free (struct evhttp_request *req) Frees the request object and removes associated events. evhttp_cmd_type evhttp_request_get_command (const struct evhttp_request *req) Returns the request command. EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_request_get_connection (struct evhttp_request *req) Returns the connection object associated with the request or NULL. More... evhttp_request_get_evhttp_uri (const struct evhttp_request *req) Returns the request URI (parsed) const EVENT2_EXPORT_SYMBOL char * evhttp_request_get_host (struct evhttp_request *req) Returns the host associated with the request. More... evbuffer * evhttp_request_get_input_buffer (struct evhttp_request *req) Returns the input buffer. evhttp_request_get_input_headers (struct evhttp_request *req) Returns the input headers. evbuffer * evhttp_request_get_output_buffer (struct evhttp_request *req) Returns the output buffer. evhttp_request_get_output_headers (struct evhttp_request *req) Returns the output headers. evhttp_request_get_response_code (const struct evhttp_request *req) evhttp_request_get_response_code_line (const struct evhttp_request *req) evhttp_request_get_uri (const struct evhttp_request *req) Returns the request URI. evhttp_request_is_owned (struct evhttp_request *req) Returns 1 if the request is owned by the user. EVENT2_EXPORT_SYMBOL struct evhttp_request * evhttp_request_new (void(*cb)(struct evhttp_request *, void *), void *arg) Creates a new request object that needs to be filled in with the request parameters. More... EVENT2_EXPORT_SYMBOL void evhttp_request_own (struct evhttp_request *req) Takes ownership of the request object. More... EVENT2_EXPORT_SYMBOL void evhttp_request_set_chunked_cb (struct evhttp_request *, void(*cb)(struct evhttp_request *, void *)) Enable delivery of chunks to requestor. More... EVENT2_EXPORT_SYMBOL void evhttp_request_set_error_cb (struct evhttp_request *, void(*)(enum evhttp_request_error , void *)) Set a callback for errors. More... EVENT2_EXPORT_SYMBOL void evhttp_request_set_header_cb (struct evhttp_request *, int(*cb)(struct evhttp_request *, void *)) Register callback for additional parsing of request headers. More... EVENT2_EXPORT_SYMBOL void evhttp_request_set_on_complete_cb (struct evhttp_request *req, void(*cb)(struct evhttp_request *, void *), void *cb_arg) Set a callback to be called on request completion of evhttp_send_* function. More... EVENT2_EXPORT_SYMBOL void evhttp_send_error (struct evhttp_request *req, int error, const char *reason) Send an HTML error message to the client. More... EVENT2_EXPORT_SYMBOL void evhttp_send_reply (struct evhttp_request *req, int code, const char *reason, struct evbuffer *databuf) Send an HTML reply to the client. More... EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk (struct evhttp_request *req, struct evbuffer *databuf) Send another data chunk as part of an ongoing chunked reply. More... EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk_with_cb (struct evhttp_request *req, struct evbuffer *databuf, void(*cb)(struct evhttp_connection *, void *), void *arg) Send another data chunk as part of an ongoing chunked reply. More... EVENT2_EXPORT_SYMBOL void evhttp_send_reply_end (struct evhttp_request *req) Complete a chunked reply, freeing the request as appropriate. More... EVENT2_EXPORT_SYMBOL void evhttp_send_reply_start (struct evhttp_request *req, int code, const char *reason) Initiate a reply that uses Transfer-Encoding chunked. More... EVENT2_EXPORT_SYMBOL void evhttp_set_allowed_methods (struct evhttp *http, ev_uint32_t methods) Sets the what HTTP methods are supported in requests accepted by this server, and passed to user callbacks. More... EVENT2_EXPORT_SYMBOL void evhttp_set_bevcb (struct evhttp *http, struct bufferevent *(*cb)(struct event_base *, void *), void *arg) Set a callback used to create new bufferevents for connections to a given evhttp object. More... EVENT2_EXPORT_SYMBOL int evhttp_set_cb (struct evhttp *http, const char *path, void(*cb)(struct evhttp_request *, void *), void *cb_arg) Set a callback for a specified URI. More... EVENT2_EXPORT_SYMBOL void evhttp_set_default_content_type (struct evhttp *http, const char *content_type) Set the value to use for the Content-Type header when none was provided. More... EVENT2_EXPORT_SYMBOL void evhttp_set_errorcb (struct evhttp *http, int(*cb)(struct evhttp_request *req, struct evbuffer *buffer, int error, const char *reason, void *cbarg), void *cbarg) Set a callback to output for any error pages sent for requests of a given evhttp object. More... EVENT2_EXPORT_SYMBOL void evhttp_set_ext_method_cmp (struct evhttp *http, evhttp_ext_method_cb cmp) Sets the callback function which allows HTTP extended methods to be supported by this server. More... EVENT2_EXPORT_SYMBOL int evhttp_set_flags (struct evhttp *http, int flags) Set connection flags for HTTP server. More... EVENT2_EXPORT_SYMBOL void evhttp_set_gencb (struct evhttp *http, void(*cb)(struct evhttp_request *, void *), void *arg) Set a callback for all requests that are not caught by specific callbacks. More... evhttp_set_max_body_size (struct evhttp *http, ev_ssize_t max_body_size) XXX Document. EVENT2_EXPORT_SYMBOL void evhttp_set_max_connections (struct evhttp *http, int max_connections) Set the maximum number of simultaneous connections for this server. More... evhttp_set_max_headers_size (struct evhttp *http, ev_ssize_t max_headers_size) XXX Document. EVENT2_EXPORT_SYMBOL void evhttp_set_newreqcb (struct evhttp *http, int(*cb)(struct evhttp_request *, void *), void *arg) Set a callback which allows the user to note or throttle incoming requests. More... EVENT2_EXPORT_SYMBOL void evhttp_set_read_timeout_tv (struct evhttp *http, const struct timeval *tv) Set read timeout for an HTTP request. More... EVENT2_EXPORT_SYMBOL void evhttp_set_timeout (struct evhttp *http, int timeout) Set the timeout for an HTTP request. More... EVENT2_EXPORT_SYMBOL void evhttp_set_timeout_tv (struct evhttp *http, const struct timeval *tv) Set read and write timeout for an HTTP request. More... EVENT2_EXPORT_SYMBOL void evhttp_set_write_timeout_tv (struct evhttp *http, const struct timeval *tv) Set write timeout for an HTTP request. More... EVENT2_EXPORT_SYMBOL void evhttp_uri_free (struct evhttp_uri *uri) Free all memory allocated for a parsed uri. More... evhttp_uri_get_fragment (const struct evhttp_uri *uri) Return the fragment part of an evhttp_uri (excluding the leading "#"), or NULL if it has no fragment set. const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_host (const struct evhttp_uri *uri) Return the host part of an evhttp_uri, or NULL if it has no host set. More... evhttp_uri_get_path (const struct evhttp_uri *uri) Return the path part of an evhttp_uri, or NULL if it has no path set. evhttp_uri_get_port (const struct evhttp_uri *uri) Return the port part of an evhttp_uri, or -1 if there is no port set. evhttp_uri_get_query (const struct evhttp_uri *uri) Return the query part of an evhttp_uri (excluding the leading "?"), or NULL if it has no query set. evhttp_uri_get_scheme (const struct evhttp_uri *uri) Return the scheme of an evhttp_uri, or NULL if there is no scheme has been set and the evhttp_uri contains a Relative-Ref. evhttp_uri_get_unixsocket (const struct evhttp_uri *uri) Return the unix socket part of an evhttp_uri, or NULL if there is no unix socket set. evhttp_uri_get_userinfo (const struct evhttp_uri *uri) Return the userinfo part of an evhttp_uri, or NULL if it has no userinfo set. EVENT2_EXPORT_SYMBOL char * evhttp_uri_join (struct evhttp_uri *uri, char *buf, size_t limit) Join together the uri parts from parsed data to form a URI-Reference. More... evhttp_uri_new (void) Return a new empty evhttp_uri with no fields set. evhttp_uri_parse (const char *source_uri) Alias for evhttp_uri_parse_with_flags(source_uri, 0) EVENT2_EXPORT_SYMBOL struct evhttp_uri * evhttp_uri_parse_with_flags (const char *source_uri, unsigned flags) Helper function to parse a URI-Reference as specified by RFC3986. More... EVENT2_EXPORT_SYMBOL void evhttp_uri_set_flags (struct evhttp_uri *uri, unsigned flags) Changes the flags set on a given URI. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_fragment (struct evhttp_uri *uri, const char *fragment) Set the fragment of an evhttp_uri, or clear the fragment if fragment==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_host (struct evhttp_uri *uri, const char *host) Set the host of an evhttp_uri, or clear the host if host==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_path (struct evhttp_uri *uri, const char *path) Set the path of an evhttp_uri, or clear the path if path==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_port (struct evhttp_uri *uri, int port) Set the port of an evhttp_uri, or clear the port if port==-1. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_query (struct evhttp_uri *uri, const char *query) Set the query of an evhttp_uri, or clear the query if query==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_scheme (struct evhttp_uri *uri, const char *scheme) Set the scheme of an evhttp_uri, or clear the scheme if scheme==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_unixsocket (struct evhttp_uri *uri, const char *unixsocket) Set the unix socket of an evhttp_uri, or clear the unix socket if unixsocket==NULL. More... EVENT2_EXPORT_SYMBOL int evhttp_uri_set_userinfo (struct evhttp_uri *uri, const char *userinfo) Set the userinfo of an evhttp_uri, or clear the userinfo if userinfo==NULL. More... EVENT2_EXPORT_SYMBOL char * evhttp_uridecode (const char *uri, int decode_plus, size_t *size_out) Helper function to decode a URI-escaped string or HTTP parameter. More... EVENT2_EXPORT_SYMBOL char * evhttp_uriencode (const char *str, ev_ssize_t size, int space_to_plus) As evhttp_encode_uri, but if 'size' is nonnegative, treat the string as being 'size' bytes long. More...
+
+
Basic support for HTTP serving.
+
As Libevent is a library for dealing with event notification and most interesting applications are networked today, I have often found the need to write HTTP code. The following prototypes and definitions provide an application with a minimal interface for making HTTP requests and for creating a very simple HTTP server.
+
+
+
◆
+
+
+
+
+
+ #define EVHTTP_URI_HOST_STRIP_BRACKETS 0x04
+
+
+
+
+
Strip brackets from the IPv6 address and only for evhttp_uri_get_host() , evhttp_uri_join() returns the host with brackets.
+
Thus you can use host part of the evhttp_uri for getaddrinfo().
+
See also also _EVHTTP_URI_HOST_HAS_BRACKETS
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVHTTP_URI_NONCONFORMANT 0x01
+
+
+
+
+
Tolerate URIs that do not conform to RFC3986.
+
Unfortunately, some HTTP clients generate URIs that, according to RFC3986, are not conformant URIs. If you need to support these URIs, you can do so by passing this flag to evhttp_uri_parse_with_flags.
+
Currently, these changes are:
+
+Nonconformant URIs are allowed to contain otherwise unreasonable characters in their path, query, and fragment components.
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVHTTP_URI_QUERY_LAST_VAL 0x02
+
+
+
+
+
Prefer last value over the first from query args.
+
Example: test=123&test=456 Without: test=123 With : test=456
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVHTTP_URI_QUERY_NONCONFORMANT 0x01
+
+
+
+
+
Tolerate queries that are not standard conformant.
+
Here are some examples:
+
+test=123&test2 with with this flag test2 will be present in the output headers
+test=123&&test2=1 will parse the query with this flag
+test=123&=456&test2=1 will parse the queyr with this flag, however there won't be empty key present
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVHTTP_URI_UNIX_SOCKET 0x08
+
+
+
+
+
+
+
◆
+
+
+
+
+
The different request types supported by evhttp.
+
These are as specified in RFC2616, except for:
+PATCH which is specified by RFC5789
+PROPFIND, PROPPATCH, MKCOL, LOCK, UNLOCK, COPY, MOVE which are specified by RFC4918
+
+
By default, only some of these methods are accepted and passed to user callbacks; use evhttp_set_allowed_methods() to change which methods are allowed.
+
+
+
+
+
◆
+
+
+
+
+
The different error types supported by evhttp.
+
See also evhttp_request_set_error_cb()
+
+Enumerator Timeout reached, also.
+See also evhttp_connection_set_timeout() EOF reached.
+Error while reading header, or invalid header.
+Error encountered while reading or writing.
+The evhttp_cancel_request() called on this request.
+Body is greater then evhttp_connection_set_max_body_size()
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_accept_socket
+ (
+ struct evhttp *
+ http ,
+
+ evutil_socket_t fd
+
+ )
+
+
+
+
+
Makes an HTTP server accept connections on the specified socket.
+
This may be useful to create a socket and then fork multiple instances of an http server, or when a socket has been communicated via file descriptor passing in situations where an http servers does not have permissions to bind to a low-numbered port.
+
Can be called multiple times to have the http server listen to multiple different sockets.
+
Parameters
+
+ http a pointer to an evhttp object fd a socket fd that is ready for accepting connections
+
+
+
Returns 0 on success, -1 on failure.
+
See also evhttp_bind_socket()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket* evhttp_accept_socket_with_handle
+ (
+ struct evhttp *
+ http ,
+
+ evutil_socket_t fd
+
+ )
+
+
+
+
+
Like evhttp_accept_socket() , but returns a handle for referencing the socket.
+
The returned pointer is not valid after http is freed.
+
Parameters
+
+ http a pointer to an evhttp object fd a socket fd that is ready for accepting connections
+
+
+
Returns Handle for the socket on success, NULL on failure.
+
See also evhttp_accept_socket() , evhttp_del_accept_socket()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_add_header
+ (
+ struct evkeyvalq *
+ headers ,
+
+ const char *
+ key ,
+
+ const char *
+ value
+
+ )
+
+
+
+
+
Adds a header to a list of existing headers.
+
Parameters
+
+ headers the evkeyvalq object to which to add a header key the name of the header value the value belonging to the header
+
+
+
Returns 0 on success, -1 otherwise.
+
See also evhttp_find_header() , evhttp_clear_headers()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_add_server_alias
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ alias
+
+ )
+
+
+
+
+
Add a server alias to an http object.
+
The http object can be a virtual host or the main server.
+
Parameters
+
+ http the evhttp object alias the alias to add
+
+
+
See also evhttp_add_remove_alias()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_add_virtual_host
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ pattern ,
+
+ struct evhttp *
+ vhost
+
+ )
+
+
+
+
+
Adds a virtual host to the http server.
+
A virtual host is a newly initialized evhttp object that has request callbacks set on it via evhttp_set_cb() or evhttp_set_gencb() . It most not have any listing sockets associated with it.
+
If the virtual host has not been removed by the time that evhttp_free() is called on the main http server, it will be automatically freed, too.
+
It is possible to have hierarchical vhosts. For example: A vhost with the pattern *.example.com may have other vhosts with patterns foo.example.com and bar.example.com associated with it.
+
Parameters
+
+ http the evhttp object to which to add a virtual host pattern the glob pattern against which the hostname is matched. The match is case insensitive and follows otherwise regular shell matching. vhost the virtual host to add the regular http server.
+
+
+
Returns 0 on success, -1 on failure
+
See also evhttp_remove_virtual_host()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket* evhttp_bind_listener
+ (
+ struct evhttp *
+ http ,
+
+ struct evconnlistener *
+ listener
+
+ )
+
+
+
+
+
The most low-level evhttp_bind/accept method: takes an evconnlistener, and returns an evhttp_bound_socket.
+
The listener will be freed when the bound socket is freed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_bind_socket
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
Binds an HTTP server on the specified address and port.
+
Can be called multiple times to bind the same http server to multiple different ports.
+
Parameters
+
+ http a pointer to an evhttp object address a string containing the IP address to listen(2) on port the port number to listen on
+
+
+
Returns 0 on success, -1 on failure.
+
See also evhttp_accept_socket()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket* evhttp_bind_socket_with_handle
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
Like evhttp_bind_socket() , but returns a handle for referencing the socket.
+
The returned pointer is not valid after http is freed.
+
Parameters
+
+ http a pointer to an evhttp object address a string containing the IP address to listen(2) on port the port number to listen on
+
+
+
Returns Handle for the socket on success, NULL on failure.
+
See also evhttp_bind_socket() , evhttp_del_accept_socket()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL evutil_socket_t evhttp_bound_socket_get_fd
+ (
+ struct evhttp_bound_socket *
+ bound_socket )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_cancel_request
+ (
+ struct evhttp_request *
+ req )
+
+
+
+
+
Cancels a pending HTTP request.
+
Cancels an ongoing HTTP request. The callback associated with this request is not executed and the request object is freed. If the request is currently being processed, e.g. it is ongoing, the corresponding evhttp_connection object is going to get reset.
+
A request cannot be canceled if its callback has executed already. A request may be canceled reentrantly from its chunked callback.
+
Parameters
+
+ req the evhttp_request to cancel; req becomes invalid after this call.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_clear_headers
+ (
+ struct evkeyvalq *
+ headers )
+
+
+
+
+
Removes all headers from the header list.
+
Parameters
+
+ headers the evkeyvalq object from which to remove all headers
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evhttp_connection_base_bufferevent_new
+ (
+ struct event_base *
+ base ,
+
+ struct evdns_base *
+ dnsbase ,
+
+ struct bufferevent *
+ bev ,
+
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
Create and return a connection object that can be used to for making HTTP requests.
+
The connection object tries to resolve address and establish the connection when it is given an http request object.
+
Connection also has default timeouts for the following events:
+connect HTTP_CONNECT_TIMEOUT, which is 45 seconds
+read HTTP_READ_TIMEOUT which is 50 seconds
+write HTTP_WRITE_TIMEOUT, which is 50 seconds
+
+
Parameters
+
+ base the event_base to use for handling the connection dnsbase the dns_base to use for resolving host names; if not specified host name resolution will block. bev a bufferevent to use for connecting to the server; if NULL, a socket-based bufferevent will be created. This bufferevent will be freed when the connection closes. It must have no fd set on it. address the address to which to connect port the port to connect to
+
+
+
Returns an evhttp_connection object that can be used for making requests or NULL on error
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evhttp_connection_base_bufferevent_unix_new
+ (
+ struct event_base *
+ base ,
+
+ struct bufferevent *
+ bev ,
+
+ const char *
+ path
+
+ )
+
+
+
+
+
Create and return a connection object that can be used to for making HTTP requests over an unix domain socket.
+
Parameters
+
+ base the event_base to use for handling the connection bev a bufferevent to use for connecting to the server; if NULL, a socket-based bufferevent will be created. This bufferevent will be freed when the connection closes. It must have no fd set on it. path path of unix domain socket
+
+
+
Returns an evhttp_connection object that can be used for making requests
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evhttp_connection_base_new
+ (
+ struct event_base *
+ base ,
+
+ struct evdns_base *
+ dnsbase ,
+
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
Create and return a connection object that can be used to for making HTTP requests.
+
The connection object tries to resolve address and establish the connection when it is given an http request object.
+
Parameters
+
+ base the event_base to use for handling the connection dnsbase the dns_base to use for resolving host names; if not specified host name resolution will block. address the address to which to connect port the port to connect to
+
+
+
Returns an evhttp_connection object that can be used for making requests or NULL on error
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_free_on_completion
+ (
+ struct evhttp_connection *
+ evcon )
+
+
+
+
+
Disowns a given connection object.
+
Can be used to tell libevent to free the connection object after the last request has completed or failed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL const struct sockaddr* evhttp_connection_get_addr
+ (
+ struct evhttp_connection *
+ evcon )
+
+
+
+
+
Get the remote address associated with this connection.
+
extracted from getpeername() OR from nameserver.
+
Returns NULL if getpeername() return non success, or connection is not connected, otherwise it return pointer to struct sockaddr_storage
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_connect_timeout_tv
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Sets the connect timeout for this connection.
+
Parameters
+
+ tv the timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_ext_method_cmp
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ evhttp_ext_method_cb
+ cmp
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_connection_set_flags
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
Set connection flags.
+
See also EVHTTP_CON_*
+
Returns 0 on success, otherwise non zero (for example if flag doesn't supported).
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_initial_retry_tv
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Sets the delay before retrying requests on this connection.
+
This is only used if evhttp_connection_set_retries is used to make the number of retries at least one. Each retry after the first is twice as long as the one before it.
+
Default delay is HTTP_INITIAL_RETRY_TIMEOUT, which is 2 seconds.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_local_address
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const char *
+ address
+
+ )
+
+
+
+
+
Sets the IP address from which http connections are made.
+
Note this resets internal bufferevent fd, so any options that had been installed will be flushed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_read_timeout_tv
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Sets the read timeout for this connection.
+
Parameters
+
+ tv the timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ int
+ timeout
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout_tv
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_write_timeout_tv
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Sets the write timeout for this connection.
+
Parameters
+
+ tv the timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_decode_uri
+ (
+ const char *
+ uri )
+
+
+
+
+
Helper function to sort of decode a URI-encoded string.
+
Unlike evhttp_uridecode, it decodes all plus characters that appear after the first question mark character, but no plusses that occur before. This is not a good way to decode URIs in whole or in part.
+
The returned string must be freed by the caller
+
Deprecated: This function is deprecated; you probably want to use evhttp_uridecode instead.
+
Parameters
+
+
+
+
Returns a newly allocated unencoded URI or NULL on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_del_accept_socket
+ (
+ struct evhttp *
+ http ,
+
+ struct evhttp_bound_socket *
+ bound_socket
+
+ )
+
+
+
+
+
Makes an HTTP server stop accepting connections on the specified socket.
+
This may be useful when a socket has been sent via file descriptor passing and is no longer needed by the current process.
+
If you created this bound socket with evhttp_bind_socket_with_handle or evhttp_accept_socket_with_handle, this function closes the fd you provided. If you created this bound socket with evhttp_bind_listener, this function frees the listener you provided.
+
bound_socket is an invalid pointer after this call returns.
+
Parameters
+
+ http a pointer to an evhttp object bound_socket a handle returned by evhttp_{bind,accept}_socket_with_handle
+
+
+
See also evhttp_bind_socket_with_handle() , evhttp_accept_socket_with_handle()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_encode_uri
+ (
+ const char *
+ str )
+
+
+
+
+
Helper function to encode a string for inclusion in a URI.
+
All characters are replaced by their hex-escaped (%22) equivalents, except for characters explicitly unreserved by RFC3986 – that is, ASCII alphanumeric characters, hyphen, dot, underscore, and tilde.
+
The returned string must be freed by the caller.
+
Parameters
+
+ str an unencoded string
+
+
+
Returns a newly allocated URI-encoded string or NULL on failure
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* evhttp_find_header
+ (
+ const struct evkeyvalq *
+ headers ,
+
+ const char *
+ key
+
+ )
+
+
+
+
+
Finds the value belonging to a header.
+
Parameters
+
+ headers the evkeyvalq object in which to find the header key the name of the header to find
+
+
+
Returns a pointer to the value for the header or NULL if the header could not be found.
+
See also evhttp_add_header() , evhttp_remove_header()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_foreach_bound_socket
+ (
+ struct evhttp *
+ http ,
+
+ evhttp_bound_socket_foreach_fn *
+ function ,
+
+ void *
+ argument
+
+ )
+
+
+
+
+
Applies the function specified in the first argument to all evhttp_bound_sockets associated with "http".
+
The user must not attempt to free or remove any connections, sockets or listeners in the callback "function".
+
Parameters
+
+ http pointer to an evhttp object function function to apply to every bound socket argument pointer value passed to function for every socket iterated
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_free
+ (
+ struct evhttp *
+ http )
+
+
+
+
+
Free the previously created HTTP server.
+
Works only if no requests are currently being served.
+
Parameters
+
+ http the evhttp server object to be freed
+
+
+
See also evhttp_start()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_get_connection_count
+ (
+ struct evhttp *
+ http )
+
+
+
+
+
Get the current number of connections.
+
Returns The current number of connections for this server.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_htmlescape
+ (
+ const char *
+ html )
+
+
+
+
+
Escape HTML character entities in a string.
+
Replaces <, >, ", ' and & with <, >, ", ' and & correspondingly.
+
The returned string needs to be freed by the caller.
+
Parameters
+
+ html an unescaped HTML string
+
+
+
Returns an escaped HTML string or NULL on error
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_make_request
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ struct evhttp_request *
+ req ,
+
+ enum evhttp_cmd_type
+ type ,
+
+ const char *
+ uri
+
+ )
+
+
+
+
+
Make an HTTP request over the specified connection.
+
The connection gets ownership of the request. On failure, the request object is no longer valid as it has been freed.
+
Parameters
+
+ evcon the evhttp_connection object over which to send the request req the previously created and configured request object type the request type EVHTTP_REQ_GET, EVHTTP_REQ_POST, etc. uri the URI associated with the request
+
+
+
Returns 0 on success, -1 on failure
+
See also evhttp_cancel_request()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp* evhttp_new
+ (
+ struct event_base *
+ base )
+
+
+
+
+
Create a new HTTP server.
+
Parameters
+
+ base (optional) the event base to receive the HTTP events
+
+
+
Returns a pointer to a newly initialized evhttp server structure or NULL on error
+
See also evhttp_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_parse_query
+ (
+ const char *
+ uri ,
+
+ struct evkeyvalq *
+ headers
+
+ )
+
+
+
+
+
Helper function to parse out arguments in a query.
+
Parsing a URI like
+
http://foo.com/?q=test&s=some+thing
+
will result in two entries in the key value queue.
+
The first entry is: key="q", value="test" The second entry is: key="s", value="some thing"
+
Deprecated: This function is deprecated as of Libevent 2.0.9. Use evhttp_uri_parse and evhttp_parse_query_str instead.
+
Parameters
+
+ uri the request URI headers the head of the evkeyval queue
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str
+ (
+ const char *
+ uri ,
+
+ struct evkeyvalq *
+ headers
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str_flags
+ (
+ const char *
+ uri ,
+
+ struct evkeyvalq *
+ headers ,
+
+ unsigned
+ flags
+
+ )
+
+
+
+
+
Helper function to parse out arguments from the query portion of an HTTP URI.
+
Parsing a query string like
+
q=test&s=some+thing
+
will result in two entries in the key value queue.
+
The first entry is: key="q", value="test" The second entry is: key="s", value="some thing"
+
Parameters
+
+ uri the query portion of the URI headers the head of the evkeyval queue flags one or more of EVHTTP_URI_QUERY_*
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_remove_header
+ (
+ struct evkeyvalq *
+ headers ,
+
+ const char *
+ key
+
+ )
+
+
+
+
+
Removes a header from a list of existing headers.
+
Parameters
+
+ headers the evkeyvalq object from which to remove a header key the name of the header to remove
+
+
+
Returns 0 if the header was removed, -1 otherwise.
+
See also evhttp_find_header() , evhttp_add_header()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_remove_server_alias
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ alias
+
+ )
+
+
+
+
+
Remove a server alias from an http object.
+
Parameters
+
+ http the evhttp object alias the alias to remove
+
+
+
See also evhttp_add_server_alias()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_remove_virtual_host
+ (
+ struct evhttp *
+ http ,
+
+ struct evhttp *
+ vhost
+
+ )
+
+
+
+
+
Removes a virtual host from the http server.
+
Parameters
+
+ http the evhttp object from which to remove the virtual host vhost the virtual host to remove from the regular http server.
+
+
+
Returns 0 on success, -1 on failure
+
See also evhttp_add_virtual_host()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evhttp_request_get_connection
+ (
+ struct evhttp_request *
+ req )
+
+
+
+
+
Returns the connection object associated with the request or NULL.
+
The user needs to either free the request explicitly or call evhttp_send_reply_end() .
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* evhttp_request_get_host
+ (
+ struct evhttp_request *
+ req )
+
+
+
+
+
Returns the host associated with the request.
+
If a client sends an absolute URI, the host part of that is preferred. Otherwise, the input headers are searched for a Host: header. NULL is returned if no absolute URI or Host: header is provided.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_request* evhttp_request_new
+ (
+ void(*)(struct evhttp_request *, void *)
+ cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Creates a new request object that needs to be filled in with the request parameters.
+
The callback is executed when the request completed or an error occurred.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_request_own
+ (
+ struct evhttp_request *
+ req )
+
+
+
+
+
Takes ownership of the request object.
+
Can be used in a request callback to keep onto the request until evhttp_request_free() is explicitly called by the user.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_request_set_chunked_cb
+ (
+ struct evhttp_request *
+ ,
+
+
+ void(*)(struct evhttp_request *, void *)
+ cb
+
+ )
+
+
+
+
+
Enable delivery of chunks to requestor.
+
Parameters
+
+ cb will be called after every read of data with the same argument as the completion callback. Will never be called on an empty response. May drain the input buffer; it will be drained automatically on return.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_request_set_error_cb
+ (
+ struct evhttp_request *
+ ,
+
+
+ void(*)(enum evhttp_request_error , void *)
+
+
+
+ )
+
+
+
+
+
Set a callback for errors.
+
See also evhttp_request_error for error types.
+
On error, both the error callback and the regular callback will be called, error callback is called before the regular callback.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_request_set_header_cb
+ (
+ struct evhttp_request *
+ ,
+
+
+ int(*)(struct evhttp_request *, void *)
+ cb
+
+ )
+
+
+
+
+
Register callback for additional parsing of request headers.
+
Parameters
+
+ cb will be called after receiving and parsing the full header. It allows analyzing the header and possibly closing the connection by returning a value < 0.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_request_set_on_complete_cb
+ (
+ struct evhttp_request *
+ req ,
+
+ void(*)(struct evhttp_request *, void *)
+ cb ,
+
+ void *
+ cb_arg
+
+ )
+
+
+
+
+
Set a callback to be called on request completion of evhttp_send_* function.
+
The callback function will be called on the completion of the request after the output data has been written and before the evhttp_request object is destroyed. This can be useful for tracking resources associated with a request (ex: timing metrics).
+
Parameters
+
+ req a request object cb callback function that will be called on request completion cb_arg an additional context argument for the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_error
+ (
+ struct evhttp_request *
+ req ,
+
+ int
+ error ,
+
+ const char *
+ reason
+
+ )
+
+
+
+
+
Send an HTML error message to the client.
+
Parameters
+
+ req a request object error the HTTP error code reason a brief explanation of the error. If this is NULL, we'll just use the standard meaning of the error code.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_reply
+ (
+ struct evhttp_request *
+ req ,
+
+ int
+ code ,
+
+ const char *
+ reason ,
+
+ struct evbuffer *
+ databuf
+
+ )
+
+
+
+
+
Send an HTML reply to the client.
+
The body of the reply consists of the data in databuf. After calling evhttp_send_reply() databuf will be empty, but the buffer is still owned by the caller and needs to be deallocated by the caller if necessary.
+
Parameters
+
+ req a request object code the HTTP response code to send reason a brief message to send with the response code databuf the body of the response
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk
+ (
+ struct evhttp_request *
+ req ,
+
+ struct evbuffer *
+ databuf
+
+ )
+
+
+
+
+
Send another data chunk as part of an ongoing chunked reply.
+
The reply chunk consists of the data in databuf. After calling evhttp_send_reply_chunk() databuf will be empty, but the buffer is still owned by the caller and needs to be deallocated by the caller if necessary.
+
Parameters
+
+ req a request object databuf the data chunk to send as part of the reply.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk_with_cb
+ (
+ struct evhttp_request *
+ req ,
+
+ struct evbuffer *
+ databuf ,
+
+ void(*)(struct evhttp_connection *, void *)
+ cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Send another data chunk as part of an ongoing chunked reply.
+
The reply chunk consists of the data in databuf. After calling evhttp_send_reply_chunk() databuf will be empty, but the buffer is still owned by the caller and needs to be deallocated by the caller if necessary.
+
Parameters
+
+ req a request object databuf the data chunk to send as part of the reply. cb callback funcion arg call back's argument.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_reply_end
+ (
+ struct evhttp_request *
+ req )
+
+
+
+
+
Complete a chunked reply, freeing the request as appropriate.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_send_reply_start
+ (
+ struct evhttp_request *
+ req ,
+
+ int
+ code ,
+
+ const char *
+ reason
+
+ )
+
+
+
+
+
Initiate a reply that uses Transfer-Encoding chunked.
+
This allows the caller to stream the reply back to the client and is useful when either not all of the reply data is immediately available or when sending very large replies.
+
The caller needs to supply data chunks with evhttp_send_reply_chunk() and complete the reply by calling evhttp_send_reply_end() .
+
Parameters
+
+ req a request object code the HTTP response code to send reason a brief message to send with the response code
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_allowed_methods
+ (
+ struct evhttp *
+ http ,
+
+ ev_uint32_t
+ methods
+
+ )
+
+
+
+
+
Sets the what HTTP methods are supported in requests accepted by this server, and passed to user callbacks.
+
If not supported they will generate a "405 Method not allowed" response.
+
By default this includes the following methods: GET, POST, HEAD, PUT, DELETE
+
Parameters
+
+ http the http server on which to set the methods methods bit mask constructed from evhttp_cmd_type values
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_bevcb
+ (
+ struct evhttp *
+ http ,
+
+ struct bufferevent *(*)(struct event_base *, void *)
+ cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Set a callback used to create new bufferevents for connections to a given evhttp object.
+
cb is not called if a non-NULL bufferevent was supplied by evhttp_bound_set_bevcb.
+
You can use this to override the default bufferevent type – for example, to make this evhttp object use SSL bufferevents rather than unencrypted ones.
+
New bufferevents must be allocated with no fd set on them.
+
Parameters
+
+ http the evhttp server object for which to set the callback cb the callback to invoke for incoming connections arg an additional context argument for the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_set_cb
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ path ,
+
+ void(*)(struct evhttp_request *, void *)
+ cb ,
+
+ void *
+ cb_arg
+
+ )
+
+
+
+
+
Set a callback for a specified URI.
+
Parameters
+
+ http the http sever on which to set the callback path the path for which to invoke the callback cb the callback function that gets invoked on requesting path cb_arg an additional context argument for the callback
+
+
+
Returns 0 on success, -1 if the callback existed already, -2 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_default_content_type
+ (
+ struct evhttp *
+ http ,
+
+ const char *
+ content_type
+
+ )
+
+
+
+
+
Set the value to use for the Content-Type header when none was provided.
+
If the content type string is NULL, the Content-Type header will not be automatically added.
+
Parameters
+
+ http the http server on which to set the default content type content_type the value for the Content-Type header
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_errorcb
+ (
+ struct evhttp *
+ http ,
+
+ int(*)(struct evhttp_request *req, struct evbuffer *buffer, int error, const char *reason, void *cbarg)
+ cb ,
+
+ void *
+ cbarg
+
+ )
+
+
+
+
+
Set a callback to output for any error pages sent for requests of a given evhttp object.
+
You can use this to override the default error pages sent, allowing such things as multi-lingual support or customization to match other pages.
+
The callback should use the supplied buffer to output the text for an error page. If the callback returns a negative value or doesn't output anything to the buffer, the default error page will be sent instead. The buffer will be automatically be sent when the callback returns, so the callback shouldn't do so itself.
+
Microsoft Internet Explorer may display its own error pages if ones sent by an HTTP server are smaller than certain sizes, depending on the status code. To reliably suppress this feature an error page should be at least 512 bytes in size.
+
Parameters
+
+ http the evhttp server object for which to set the callback cb the callback to invoke to format error pages arg an additional context argument for the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_ext_method_cmp
+ (
+ struct evhttp *
+ http ,
+
+ evhttp_ext_method_cb
+ cmp
+
+ )
+
+
+
+
+
Sets the callback function which allows HTTP extended methods to be supported by this server.
+
The callback should :
+if method field is NULL : set method field according to type field
+else : set type and flags fields according to method string
+return 0 for success (known method / type)
+return -1 for error (unknown method / type)
+
+
evhttp_set_allowed_methods still needs to be called.
+
Parameters
+
+ http the http server on which to add support to the methods cmp the extended method callback
+
+
+
See also evhttp_ext_method
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_set_flags
+ (
+ struct evhttp *
+ http ,
+
+ int
+ flags
+
+ )
+
+
+
+
+
Set connection flags for HTTP server.
+
See also EVHTTP_SERVER_*
+
Returns 0 on success, otherwise non zero (for example if flag doesn't supported).
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_gencb
+ (
+ struct evhttp *
+ http ,
+
+ void(*)(struct evhttp_request *, void *)
+ cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Set a callback for all requests that are not caught by specific callbacks.
+
Invokes the specified callback for all requests that do not match any of the previously specified request paths. This is catchall for requests not specifically configured with evhttp_set_cb() .
+
Parameters
+
+ http the evhttp server object for which to set the callback cb the callback to invoke for any unmatched requests arg an additional context argument for the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_max_connections
+ (
+ struct evhttp *
+ http ,
+
+ int
+ max_connections
+
+ )
+
+
+
+
+
Set the maximum number of simultaneous connections for this server.
+
A value of zero or less disables the limit.
+
Parameters
+
+ http the http server on which to set the max connection limit max_connections the maximum number of simultaneous connections or 0
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_newreqcb
+ (
+ struct evhttp *
+ http ,
+
+ int(*)(struct evhttp_request *, void *)
+ cb ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Set a callback which allows the user to note or throttle incoming requests.
+
The requests are not populated with HTTP level information. They are just associated to a connection.
+
If the callback returns -1, the associated connection is terminated and the request is closed.
+
Parameters
+
+ http the evhttp server object for which to set the callback cb the callback to invoke for incoming connections arg an additional context argument for the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_read_timeout_tv
+ (
+ struct evhttp *
+ http ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Set read timeout for an HTTP request.
+
Parameters
+
+ http an evhttp object tv the timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_timeout
+ (
+ struct evhttp *
+ http ,
+
+ int
+ timeout
+
+ )
+
+
+
+
+
Set the timeout for an HTTP request.
+
Parameters
+
+ http an evhttp object timeout the timeout, in seconds
+
+
+
See also evhttp_set_timeout_tv()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_timeout_tv
+ (
+ struct evhttp *
+ http ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_set_write_timeout_tv
+ (
+ struct evhttp *
+ http ,
+
+ const struct timeval *
+ tv
+
+ )
+
+
+
+
+
Set write timeout for an HTTP request.
+
Parameters
+
+ http an evhttp object tv the timeout, or NULL
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_uri_free
+ (
+ struct evhttp_uri *
+ uri )
+
+
+
+
+
Free all memory allocated for a parsed uri.
+
Only use this for URIs generated by evhttp_uri_parse.
+
Parameters
+
+ uri container with parsed data
+
+
+
See also evhttp_uri_parse()
+
+
+
+
+
◆
+
+
+
+
+
+ const EVENT2_EXPORT_SYMBOL char* evhttp_uri_get_host
+ (
+ const struct evhttp_uri *
+ uri )
+
+
+
+
+
Return the host part of an evhttp_uri, or NULL if it has no host set.
+
The host may either be a regular hostname (conforming to the RFC 3986 "regname" production), or an IPv4 address, or the empty string, or a bracketed IPv6 address, or a bracketed 'IP-Future' address.
+
Note that having a NULL host means that the URI has no authority section, but having an empty-string host means that the URI has an authority section with no host part. For example, "mailto:user@example.com" has a host of NULL, but "file:///etc/motd" has a host of "".
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_uri_join
+ (
+ struct evhttp_uri *
+ uri ,
+
+ char *
+ buf ,
+
+ size_t
+ limit
+
+ )
+
+
+
+
+
Join together the uri parts from parsed data to form a URI-Reference.
+
Note that no escaping of reserved characters is done on the members of the evhttp_uri, so the generated string might not be a valid URI unless the members of evhttp_uri are themselves valid.
+
Parameters
+
+ uri container with parsed data buf destination buffer limit destination buffer size
+
+
+
Returns an joined uri as string or NULL on error
+
See also evhttp_uri_parse()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_uri* evhttp_uri_parse_with_flags
+ (
+ const char *
+ source_uri ,
+
+ unsigned
+ flags
+
+ )
+
+
+
+
+
Helper function to parse a URI-Reference as specified by RFC3986.
+
This function matches the URI-Reference production from RFC3986, which includes both URIs like
+
scheme://[[userinfo]@]foo.com[:port]]/[path][?query][#fragment]
+
and relative-refs like
+
[path][?query][#fragment]
+
Any optional elements portions not present in the original URI are left set to NULL in the resulting evhttp_uri. If no port is specified, the port is set to -1.
+
Note that no decoding is performed on percent-escaped characters in the string; if you want to parse them, use evhttp_uridecode or evhttp_parse_query_str as appropriate.
+
Note also that most URI schemes will have additional constraints that this function does not know about, and cannot check. For example, mailto://www.example.com/cgi-bin/fortune.pl is not a reasonable mailto url, http://www.example.com:99999/ is not a reasonable HTTP URL, and ftp:username@example.com is not a reasonable FTP URL. Nevertheless, all of these URLs conform to RFC3986, and this function accepts all of them as valid.
+
Parameters
+
+ source_uri the request URI flags Zero or more EVHTTP_URI_* flags to affect the behavior of the parser.
+
+
+
Returns uri container to hold parsed data, or NULL if there is error
+
See also evhttp_uri_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_uri_set_flags
+ (
+ struct evhttp_uri *
+ uri ,
+
+ unsigned
+ flags
+
+ )
+
+
+
+
+
Changes the flags set on a given URI.
+
See EVHTTP_URI_* for a list of flags.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_fragment
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ fragment
+
+ )
+
+
+
+
+
Set the fragment of an evhttp_uri, or clear the fragment if fragment==NULL.
+
The fragment should not include a leading "#". Returns 0 on success, -1 if fragment is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_host
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ host
+
+ )
+
+
+
+
+
Set the host of an evhttp_uri, or clear the host if host==NULL.
+
Returns 0 on success, -1 if host is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_path
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ path
+
+ )
+
+
+
+
+
Set the path of an evhttp_uri, or clear the path if path==NULL.
+
Returns 0 on success, -1 if path is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_port
+ (
+ struct evhttp_uri *
+ uri ,
+
+ int
+ port
+
+ )
+
+
+
+
+
Set the port of an evhttp_uri, or clear the port if port==-1.
+
Returns 0 on success, -1 if port is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_query
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ query
+
+ )
+
+
+
+
+
Set the query of an evhttp_uri, or clear the query if query==NULL.
+
The query should not include a leading "?". Returns 0 on success, -1 if query is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_scheme
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ scheme
+
+ )
+
+
+
+
+
Set the scheme of an evhttp_uri, or clear the scheme if scheme==NULL.
+
Returns 0 on success, -1 if scheme is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_unixsocket
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ unixsocket
+
+ )
+
+
+
+
+
Set the unix socket of an evhttp_uri, or clear the unix socket if unixsocket==NULL.
+
Returns 0 on success, -1 if unixsocket is not well-formed
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evhttp_uri_set_userinfo
+ (
+ struct evhttp_uri *
+ uri ,
+
+ const char *
+ userinfo
+
+ )
+
+
+
+
+
Set the userinfo of an evhttp_uri, or clear the userinfo if userinfo==NULL.
+
Returns 0 on success, -1 if userinfo is not well-formed.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_uridecode
+ (
+ const char *
+ uri ,
+
+ int
+ decode_plus ,
+
+ size_t *
+ size_out
+
+ )
+
+
+
+
+
Helper function to decode a URI-escaped string or HTTP parameter.
+
If 'decode_plus' is 1, then we decode the string as an HTTP parameter value, and convert all plus ('+') characters to spaces. If 'decode_plus' is 0, we leave all plus characters unchanged.
+
The returned string must be freed by the caller.
+
Parameters
+
+ uri a URI-encode encoded URI decode_plus determines whether we convert '+' to space. size_out if size_out is not NULL, *size_out is set to the size of the returned string
+
+
+
Returns a newly allocated unencoded URI or NULL on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL char* evhttp_uriencode
+ (
+ const char *
+ str ,
+
+ ev_ssize_t
+ size ,
+
+ int
+ space_to_plus
+
+ )
+
+
+
+
+
As evhttp_encode_uri, but if 'size' is nonnegative, treat the string as being 'size' bytes long.
+
This allows you to encode strings that may contain 0-valued bytes.
+
The returned string must be freed by the caller.
+
Parameters
+
+ str an unencoded string size the length of the string to encode, or -1 if the string is NUL-terminated space_to_plus if true, space characters in 'str' are encoded as +, not %20.
+
+
+
Returns a newly allocate URI-encoded string, or NULL on failure.
+
+
+
+
libevent: event2/http.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_HTTP_H_INCLUDED_
+
28 #define EVENT2_HTTP_H_INCLUDED_
+
+
+
+
32 #include <event2/visibility.h>
+
+
+
+
+
+
+
+
+
+
42 struct evhttp_connection;
+
+
+
56 #define HTTP_CONTINUE 100
+
57 #define HTTP_SWITCH_PROTOCOLS 101
+
58 #define HTTP_PROCESSING 102
+
59 #define HTTP_EARLYHINTS 103
+
+
61 #define HTTP_CREATED 201
+
62 #define HTTP_ACCEPTED 202
+
63 #define HTTP_NONAUTHORITATIVE 203
+
64 #define HTTP_NOCONTENT 204
+
65 #define HTTP_MOVEPERM 301
+
66 #define HTTP_MOVETEMP 302
+
67 #define HTTP_NOTMODIFIED 304
+
68 #define HTTP_BADREQUEST 400
+
69 #define HTTP_UNAUTHORIZED 401
+
70 #define HTTP_PAYMENTREQUIRED 402
+
71 #define HTTP_FORBIDDEN 403
+
72 #define HTTP_NOTFOUND 404
+
73 #define HTTP_BADMETHOD 405
+
74 #define HTTP_ENTITYTOOLARGE 413
+
75 #define HTTP_EXPECTATIONFAILED 417
+
76 #define HTTP_INTERNAL 500
+
77 #define HTTP_NOTIMPLEMENTED 501
+
78 #define HTTP_BADGATEWAY 502
+
79 #define HTTP_SERVUNAVAIL 503
+
+
82 struct evhttp_request;
+
+
84 struct evhttp_bound_socket;
+
85 struct evconnlistener;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
167 struct evhttp_bound_socket *
evhttp_bind_listener (
struct evhttp *http,
struct evconnlistener *listener);
+
+
+
+
+
+
+
+
+
+
+
181 void evhttp_bound_set_bevcb(
struct evhttp_bound_socket *bound,
struct bufferevent * (*cb)(
struct event_base *,
void *),
void *cbarg);
+
+
183 typedef void evhttp_bound_socket_foreach_fn(
struct evhttp_bound_socket *,
void *);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
273 const char *content_type);
+
+
+
+
+
+
+
+
+
+
+
320 void (*cb)(
struct evhttp_request *,
void *),
void *cb_arg);
+
+
+
+
+
+
+
339 void (*cb)(
struct evhttp_request *,
void *),
void *arg);
+
+
+
+
+
+
+
+
+
377 int (*cb)(
struct evhttp_request*,
void *),
void *arg);
+
+
+
+
403 int (*cb)(
struct evhttp_request *req,
struct evbuffer *buffer,
int error,
const char *reason,
void *cbarg),
+
+
+
+
+
430 struct evhttp* vhost);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
507 #define EVHTTP_SERVER_LINGERING_CLOSE 0x0001
+
+
+
+
+
+
+
+
+
+
+
+
+
547 const char *reason,
struct evbuffer *databuf);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
599 void (*cb)(
struct evhttp_connection *,
void *),
void *arg);
+
+
+
+
+
+
+
+
+
+
624 EVHTTP_REQ_GET = 1 << 0,
+
625 EVHTTP_REQ_POST = 1 << 1,
+
626 EVHTTP_REQ_HEAD = 1 << 2,
+
627 EVHTTP_REQ_PUT = 1 << 3,
+
628 EVHTTP_REQ_DELETE = 1 << 4,
+
629 EVHTTP_REQ_OPTIONS = 1 << 5,
+
630 EVHTTP_REQ_TRACE = 1 << 6,
+
631 EVHTTP_REQ_CONNECT = 1 << 7,
+
632 EVHTTP_REQ_PATCH = 1 << 8,
+
633 EVHTTP_REQ_PROPFIND= 1 << 9,
+
634 EVHTTP_REQ_PROPPATCH=1 << 10,
+
635 EVHTTP_REQ_MKCOL = 1 << 11,
+
636 EVHTTP_REQ_LOCK = 1 << 12,
+
637 EVHTTP_REQ_UNLOCK = 1 << 13,
+
638 EVHTTP_REQ_COPY = 1 << 14,
+
639 EVHTTP_REQ_MOVE = 1 << 15,
+
+
+
642 #define EVHTTP_REQ_MAX EVHTTP_REQ_MOVE
+
+
+
+
+
+
+
+
657 #define EVHTTP_METHOD_HAS_BODY 0x0001
+
+
+
+
+
+
685 struct event_base *base,
struct evdns_base *dnsbase,
struct bufferevent * bev,
const char *address, ev_uint16_t port);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
721 void (*cb)(
struct evhttp_request *,
void *),
void *arg);
+
+
+
+
732 void (*cb)(
struct evhttp_request *,
void *));
+
+
+
+
742 int (*cb)(
struct evhttp_request *,
void *));
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
800 void (*cb)(
struct evhttp_request *,
void *),
void *cb_arg);
+
+
+
+
+
+
+
821 struct event_base *base,
struct evdns_base *dnsbase,
+
822 const char *address, ev_uint16_t port);
+
+
+
+
+
+
+
832 #define EVHTTP_CON_REUSE_CONNECTED_ADDR 0x0008
+
+
+
+
836 #define EVHTTP_CON_READ_ON_WRITE_ERROR 0x0010
+
+
838 #define EVHTTP_CON_LINGERING_CLOSE 0x0020
+
+
840 #define EVHTTP_CON_PUBLIC_FLAGS_END 0x100000
+
+
+
+
+
+
+
+
+
+
+
+
+
+
871 evhttp_ext_method_cb cmp);
+
+
+
+
+
+
+
+
+
889 void evhttp_connection_set_max_headers_size(
struct evhttp_connection *evcon,
+
890 ev_ssize_t new_max_headers_size);
+
+
+
893 void evhttp_connection_set_max_body_size(
struct evhttp_connection* evcon,
+
894 ev_ssize_t new_max_body_size);
+
+
+
+
+
+
+
+
+
+
915 const char *address);
+
+
+
+
+
+
+
+
+
+
+
+
947 const struct timeval *tv);
+
+
+
+
956 const struct timeval *tv);
+
+
+
+
965 const struct timeval *tv);
+
+
+
+
974 const struct timeval *tv);
+
+
+
+
987 const struct timeval *tv);
+
+
+
+
+
+
+
+
997 void (*)(
struct evhttp_connection *,
void *),
void *);
+
+
1000 EVENT2_EXPORT_SYMBOL
+
+
1002 const char **address, ev_uint16_t *port);
+
+
1010 EVENT2_EXPORT_SYMBOL
+
1011 const struct sockaddr*
+
+
+
1027 EVENT2_EXPORT_SYMBOL
+
+
1029 struct evhttp_request *req,
+
+
+
1045 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
1054 EVENT2_EXPORT_SYMBOL
+
+
1057 EVENT2_EXPORT_SYMBOL
+
+
1060 EVENT2_EXPORT_SYMBOL
+
+
+
1063 EVENT2_EXPORT_SYMBOL
+
1064 int evhttp_request_get_response_code(
const struct evhttp_request *req);
+
1065 EVENT2_EXPORT_SYMBOL
+
1066 const char * evhttp_request_get_response_code_line(
const struct evhttp_request *req);
+
+
1069 EVENT2_EXPORT_SYMBOL
+
+
1072 EVENT2_EXPORT_SYMBOL
+
+
1075 EVENT2_EXPORT_SYMBOL
+
+
1078 EVENT2_EXPORT_SYMBOL
+
+
1084 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
1098 EVENT2_EXPORT_SYMBOL
+
+
+
+
1110 EVENT2_EXPORT_SYMBOL
+
+
+
1122 EVENT2_EXPORT_SYMBOL
+
1123 int evhttp_add_header (
struct evkeyvalq *headers,
const char *key,
const char *value);
+
+
1130 EVENT2_EXPORT_SYMBOL
+
+
+
+
+
+
1147 EVENT2_EXPORT_SYMBOL
+
+
+
1164 EVENT2_EXPORT_SYMBOL
+
1165 char *
evhttp_uriencode (
const char *str, ev_ssize_t size,
int space_to_plus);
+
+
1181 EVENT2_EXPORT_SYMBOL
+
+
+
1199 EVENT2_EXPORT_SYMBOL
+
+
+
+
1222 EVENT2_EXPORT_SYMBOL
+
+
+
1226 EVENT2_EXPORT_SYMBOL
+
+
+
1243 #define EVHTTP_URI_QUERY_NONCONFORMANT 0x01
+
+
1250 #define EVHTTP_URI_QUERY_LAST_VAL 0x02
+
+
1270 EVENT2_EXPORT_SYMBOL
+
+
+
1284 EVENT2_EXPORT_SYMBOL
+
+
+
1290 EVENT2_EXPORT_SYMBOL
+
+
+
1297 EVENT2_EXPORT_SYMBOL
+
+
+
1302 EVENT2_EXPORT_SYMBOL
+
+
1308 EVENT2_EXPORT_SYMBOL
+
+
1322 EVENT2_EXPORT_SYMBOL
+
+
1326 EVENT2_EXPORT_SYMBOL
+
+
1329 EVENT2_EXPORT_SYMBOL
+
+
1332 EVENT2_EXPORT_SYMBOL
+
+
1336 EVENT2_EXPORT_SYMBOL
+
+
1340 EVENT2_EXPORT_SYMBOL
+
+
+
1345 EVENT2_EXPORT_SYMBOL
+
+
1349 EVENT2_EXPORT_SYMBOL
+
+
1353 EVENT2_EXPORT_SYMBOL
+
+
1357 EVENT2_EXPORT_SYMBOL
+
+
+
1362 EVENT2_EXPORT_SYMBOL
+
+
1366 EVENT2_EXPORT_SYMBOL
+
+
1371 EVENT2_EXPORT_SYMBOL
+
+
1376 EVENT2_EXPORT_SYMBOL
+
+
+
1413 EVENT2_EXPORT_SYMBOL
+
+
+
+
1429 #define EVHTTP_URI_NONCONFORMANT 0x01
+
+
1439 #define EVHTTP_URI_HOST_STRIP_BRACKETS 0x04
+
+
1446 #define EVHTTP_URI_UNIX_SOCKET 0x08
+
+
1449 EVENT2_EXPORT_SYMBOL
+
+
+
1459 EVENT2_EXPORT_SYMBOL
+
+
+
1475 EVENT2_EXPORT_SYMBOL
+
1476 char *
evhttp_uri_join (
struct evhttp_uri *uri,
char *buf,
size_t limit);
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL char * evhttp_decode_uri(const char *uri)
Helper function to sort of decode a URI-encoded string.
EVENT2_EXPORT_SYMBOL void evhttp_request_free(struct evhttp_request *req)
Frees the request object and removes associated events.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_family(struct evhttp_connection *evcon, int family)
Set family hint for DNS requests.
EVENT2_EXPORT_SYMBOL void evhttp_foreach_bound_socket(struct evhttp *http, evhttp_bound_socket_foreach_fn *function, void *argument)
Applies the function specified in the first argument to all evhttp_bound_sockets associated with "htt...
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_ext_method_cmp(struct evhttp_connection *evcon, evhttp_ext_method_cb cmp)
Sets extended method cmp callback for this http connection.
EVENT2_EXPORT_SYMBOL struct evkeyvalq * evhttp_request_get_input_headers(struct evhttp_request *req)
Returns the input headers.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_retries(struct evhttp_connection *evcon, int retry_max)
Sets the retry limit for this connection - -1 repeats indefinitely.
EVENT2_EXPORT_SYMBOL int evhttp_remove_server_alias(struct evhttp *http, const char *alias)
Remove a server alias from an http object.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_write_timeout_tv(struct evhttp_connection *evcon, const struct timeval *tv)
Sets the write timeout for this connection.
EVENT2_EXPORT_SYMBOL struct evconnlistener * evhttp_bound_socket_get_listener(struct evhttp_bound_socket *bound)
Return the listener used to implement a bound socket.
EVENT2_EXPORT_SYMBOL struct evhttp * evhttp_connection_get_server(struct evhttp_connection *evcon)
Return the HTTP server associated with this connection, or NULL.
EVENT2_EXPORT_SYMBOL void evhttp_request_set_on_complete_cb(struct evhttp_request *req, void(*cb)(struct evhttp_request *, void *), void *cb_arg)
Set a callback to be called on request completion of evhttp_send_* function.
EVENT2_EXPORT_SYMBOL const struct sockaddr * evhttp_connection_get_addr(struct evhttp_connection *evcon)
Get the remote address associated with this connection.
EVENT2_EXPORT_SYMBOL struct bufferevent * evhttp_connection_get_bufferevent(struct evhttp_connection *evcon)
Return the bufferevent that an evhttp_connection is using.
EVENT2_EXPORT_SYMBOL void evhttp_set_read_timeout_tv(struct evhttp *http, const struct timeval *tv)
Set read timeout for an HTTP request.
EVENT2_EXPORT_SYMBOL evutil_socket_t evhttp_bound_socket_get_fd(struct evhttp_bound_socket *bound_socket)
Get the raw file descriptor referenced by an evhttp_bound_socket.
EVENT2_EXPORT_SYMBOL void evhttp_set_max_headers_size(struct evhttp *http, ev_ssize_t max_headers_size)
XXX Document.
const EVENT2_EXPORT_SYMBOL char * evhttp_request_get_uri(const struct evhttp_request *req)
Returns the request URI.
EVENT2_EXPORT_SYMBOL void evhttp_send_reply_end(struct evhttp_request *req)
Complete a chunked reply, freeing the request as appropriate.
EVENT2_EXPORT_SYMBOL void evhttp_set_bevcb(struct evhttp *http, struct bufferevent *(*cb)(struct event_base *, void *), void *arg)
Set a callback used to create new bufferevents for connections to a given evhttp object.
EVENT2_EXPORT_SYMBOL int evhttp_connection_set_flags(struct evhttp_connection *evcon, int flags)
Set connection flags.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_userinfo(struct evhttp_uri *uri, const char *userinfo)
Set the userinfo of an evhttp_uri, or clear the userinfo if userinfo==NULL.
EVENT2_EXPORT_SYMBOL void evhttp_clear_headers(struct evkeyvalq *headers)
Removes all headers from the header list.
@ EVREQ_HTTP_EOF
EOF reached.
Definition: http.h:757
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_fragment(struct evhttp_uri *uri, const char *fragment)
Set the fragment of an evhttp_uri, or clear the fragment if fragment==NULL.
EVENT2_EXPORT_SYMBOL void evhttp_set_errorcb(struct evhttp *http, int(*cb)(struct evhttp_request *req, struct evbuffer *buffer, int error, const char *reason, void *cbarg), void *cbarg)
Set a callback to output for any error pages sent for requests of a given evhttp object.
EVENT2_EXPORT_SYMBOL void evhttp_uri_free(struct evhttp_uri *uri)
Free all memory allocated for a parsed uri.
EVENT2_EXPORT_SYMBOL void evhttp_request_set_error_cb(struct evhttp_request *, void(*)(enum evhttp_request_error, void *))
Set a callback for errors.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_port(struct evhttp_uri *uri, int port)
Set the port of an evhttp_uri, or clear the port if port==-1.
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
@ EVREQ_HTTP_BUFFER_ERROR
Error encountered while reading or writing.
Definition: http.h:765
EVENT2_EXPORT_SYMBOL void evhttp_set_allowed_methods(struct evhttp *http, ev_uint32_t methods)
Sets the what HTTP methods are supported in requests accepted by this server, and passed to user call...
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_local_port(struct evhttp_connection *evcon, ev_uint16_t port)
sets the local port from which http connections are made
EVENT2_EXPORT_SYMBOL void evhttp_set_timeout_tv(struct evhttp *http, const struct timeval *tv)
Set read and write timeout for an HTTP request.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_query(const struct evhttp_uri *uri)
Return the query part of an evhttp_uri (excluding the leading "?"), or NULL if it has no query set.
EVENT2_EXPORT_SYMBOL int evhttp_remove_header(struct evkeyvalq *headers, const char *key)
Removes a header from a list of existing headers.
EVENT2_EXPORT_SYMBOL int evhttp_add_virtual_host(struct evhttp *http, const char *pattern, struct evhttp *vhost)
Adds a virtual host to the http server.
EVENT2_EXPORT_SYMBOL void evhttp_send_reply_start(struct evhttp_request *req, int code, const char *reason)
Initiate a reply that uses Transfer-Encoding chunked.
EVENT2_EXPORT_SYMBOL void evhttp_set_max_body_size(struct evhttp *http, ev_ssize_t max_body_size)
XXX Document.
EVENT2_EXPORT_SYMBOL int evhttp_add_server_alias(struct evhttp *http, const char *alias)
Add a server alias to an http object.
EVENT2_EXPORT_SYMBOL void evhttp_send_reply(struct evhttp_request *req, int code, const char *reason, struct evbuffer *databuf)
Send an HTML reply to the client.
EVENT2_EXPORT_SYMBOL int evhttp_make_request(struct evhttp_connection *evcon, struct evhttp_request *req, enum evhttp_cmd_type type, const char *uri)
Make an HTTP request over the specified connection.
EVENT2_EXPORT_SYMBOL int evhttp_set_cb(struct evhttp *http, const char *path, void(*cb)(struct evhttp_request *, void *), void *cb_arg)
Set a callback for a specified URI.
evhttp_request_error
The different error types supported by evhttp.
Definition: http.h:749
EVENT2_EXPORT_SYMBOL int evhttp_set_flags(struct evhttp *http, int flags)
Set connection flags for HTTP server.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_read_timeout_tv(struct evhttp_connection *evcon, const struct timeval *tv)
Sets the read timeout for this connection.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_local_address(struct evhttp_connection *evcon, const char *address)
Sets the IP address from which http connections are made.
EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str_flags(const char *uri, struct evkeyvalq *headers, unsigned flags)
Helper function to parse out arguments from the query portion of an HTTP URI.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_connect_timeout_tv(struct evhttp_connection *evcon, const struct timeval *tv)
Sets the connect timeout for this connection.
EVENT2_EXPORT_SYMBOL struct event_base * evhttp_connection_get_base(struct evhttp_connection *req)
Returns the underlying event_base for this connection.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_query(struct evhttp_uri *uri, const char *query)
Set the query of an evhttp_uri, or clear the query if query==NULL.
EVENT2_EXPORT_SYMBOL void evhttp_set_newreqcb(struct evhttp *http, int(*cb)(struct evhttp_request *, void *), void *arg)
Set a callback which allows the user to note or throttle incoming requests.
EVENT2_EXPORT_SYMBOL char * evhttp_uri_join(struct evhttp_uri *uri, char *buf, size_t limit)
Join together the uri parts from parsed data to form a URI-Reference.
@ EVREQ_HTTP_REQUEST_CANCEL
The evhttp_cancel_request() called on this request.
Definition: http.h:769
@ EVREQ_HTTP_INVALID_HEADER
Error while reading header, or invalid header.
Definition: http.h:761
EVENT2_EXPORT_SYMBOL int evhttp_uri_get_port(const struct evhttp_uri *uri)
Return the port part of an evhttp_uri, or -1 if there is no port set.
EVENT2_EXPORT_SYMBOL void evhttp_set_timeout(struct evhttp *http, int timeout)
Set the timeout for an HTTP request.
An opaque type for handling buffered IO.
Definition: bufferevent.h:114
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_closecb(struct evhttp_connection *evcon, void(*)(struct evhttp_connection *, void *), void *)
Set a callback for connection close.
EVENT2_EXPORT_SYMBOL void evhttp_request_own(struct evhttp_request *req)
Takes ownership of the request object.
EVENT2_EXPORT_SYMBOL int evhttp_get_connection_count(struct evhttp *http)
Get the current number of connections.
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_bufferevent_new(struct event_base *base, struct evdns_base *dnsbase, struct bufferevent *bev, const char *address, ev_uint16_t port)
Create and return a connection object that can be used to for making HTTP requests.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_path(const struct evhttp_uri *uri)
Return the path part of an evhttp_uri, or NULL if it has no path set.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_path(struct evhttp_uri *uri, const char *path)
Set the path of an evhttp_uri, or clear the path if path==NULL.
EVENT2_EXPORT_SYMBOL int evhttp_accept_socket(struct evhttp *http, evutil_socket_t fd)
Makes an HTTP server accept connections on the specified socket.
EVENT2_EXPORT_SYMBOL struct evbuffer * evhttp_request_get_input_buffer(struct evhttp_request *req)
Returns the input buffer.
EVENT2_EXPORT_SYMBOL int evhttp_remove_virtual_host(struct evhttp *http, struct evhttp *vhost)
Removes a virtual host from the http server.
EVENT2_EXPORT_SYMBOL void evhttp_free(struct evhttp *http)
Free the previously created HTTP server.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_host(struct evhttp_uri *uri, const char *host)
Set the host of an evhttp_uri, or clear the host if host==NULL.
stucture that is passed to (and modified by) the extended method callback function
Definition: http.h:651
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_initial_retry_tv(struct evhttp_connection *evcon, const struct timeval *tv)
Sets the delay before retrying requests on this connection.
EVENT2_EXPORT_SYMBOL struct evbuffer * evhttp_request_get_output_buffer(struct evhttp_request *req)
Returns the output buffer.
const EVENT2_EXPORT_SYMBOL char * evhttp_request_get_host(struct evhttp_request *req)
Returns the host associated with the request.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_userinfo(const struct evhttp_uri *uri)
Return the userinfo part of an evhttp_uri, or NULL if it has no userinfo set.
EVENT2_EXPORT_SYMBOL enum evhttp_cmd_type evhttp_request_get_command(const struct evhttp_request *req)
Returns the request command.
EVENT2_EXPORT_SYMBOL struct evhttp * evhttp_new(struct event_base *base)
Create a new HTTP server.
EVENT2_EXPORT_SYMBOL int evhttp_request_is_owned(struct evhttp_request *req)
Returns 1 if the request is owned by the user.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout(struct evhttp_connection *evcon, int timeout)
Sets the timeout for this connection.
EVENT2_EXPORT_SYMBOL struct evhttp_request * evhttp_request_new(void(*cb)(struct evhttp_request *, void *), void *arg)
Creates a new request object that needs to be filled in with the request parameters.
EVENT2_EXPORT_SYMBOL void evhttp_connection_free_on_completion(struct evhttp_connection *evcon)
Disowns a given connection object.
EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_bind_socket_with_handle(struct evhttp *http, const char *address, ev_uint16_t port)
Like evhttp_bind_socket(), but returns a handle for referencing the socket.
EVENT2_EXPORT_SYMBOL int evhttp_parse_query(const char *uri, struct evkeyvalq *headers)
Helper function to parse out arguments in a query.
EVENT2_EXPORT_SYMBOL struct evhttp_uri * evhttp_uri_new(void)
Return a new empty evhttp_uri with no fields set.
EVENT2_EXPORT_SYMBOL int evhttp_bind_socket(struct evhttp *http, const char *address, ev_uint16_t port)
Binds an HTTP server on the specified address and port.
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_bufferevent_unix_new(struct event_base *base, struct bufferevent *bev, const char *path)
Create and return a connection object that can be used to for making HTTP requests over an unix domai...
EVENT2_EXPORT_SYMBOL void evhttp_set_write_timeout_tv(struct evhttp *http, const struct timeval *tv)
Set write timeout for an HTTP request.
EVENT2_EXPORT_SYMBOL struct evhttp_uri * evhttp_uri_parse_with_flags(const char *source_uri, unsigned flags)
Helper function to parse a URI-Reference as specified by RFC3986.
EVENT2_EXPORT_SYMBOL void evhttp_del_accept_socket(struct evhttp *http, struct evhttp_bound_socket *bound_socket)
Makes an HTTP server stop accepting connections on the specified socket.
EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk(struct evhttp_request *req, struct evbuffer *databuf)
Send another data chunk as part of an ongoing chunked reply.
evhttp_cmd_type
The different request types supported by evhttp.
Definition: http.h:623
evhttp_request_kind
a request object can represent either a request or a reply
Definition: http.h:660
EVENT2_EXPORT_SYMBOL struct evhttp_uri * evhttp_uri_parse(const char *source_uri)
Alias for evhttp_uri_parse_with_flags(source_uri, 0)
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_timeout_tv(struct evhttp_connection *evcon, const struct timeval *tv)
Sets the timeout for this connection for the following events:
EVENT2_EXPORT_SYMBOL void evhttp_request_set_header_cb(struct evhttp_request *, int(*cb)(struct evhttp_request *, void *))
Register callback for additional parsing of request headers.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_unixsocket(const struct evhttp_uri *uri)
Return the unix socket part of an evhttp_uri, or NULL if there is no unix socket set.
EVENT2_EXPORT_SYMBOL void evhttp_request_set_chunked_cb(struct evhttp_request *, void(*cb)(struct evhttp_request *, void *))
Enable delivery of chunks to requestor.
EVENT2_EXPORT_SYMBOL void evhttp_connection_free(struct evhttp_connection *evcon)
Frees an http connection.
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_base_new(struct event_base *base, struct evdns_base *dnsbase, const char *address, ev_uint16_t port)
Create and return a connection object that can be used to for making HTTP requests.
@ EVREQ_HTTP_DATA_TOO_LONG
Body is greater then evhttp_connection_set_max_body_size()
Definition: http.h:773
EVENT2_EXPORT_SYMBOL void evhttp_set_default_content_type(struct evhttp *http, const char *content_type)
Set the value to use for the Content-Type header when none was provided.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_fragment(const struct evhttp_uri *uri)
Return the fragment part of an evhttp_uri (excluding the leading "#"), or NULL if it has no fragment ...
EVENT2_EXPORT_SYMBOL void evhttp_connection_get_peer(struct evhttp_connection *evcon, const char **address, ev_uint16_t *port)
Get the remote address and port associated with this connection.
EVENT2_EXPORT_SYMBOL void evhttp_set_max_connections(struct evhttp *http, int max_connections)
Set the maximum number of simultaneous connections for this server.
EVENT2_EXPORT_SYMBOL int evhttp_add_header(struct evkeyvalq *headers, const char *key, const char *value)
Adds a header to a list of existing headers.
EVENT2_EXPORT_SYMBOL void evhttp_uri_set_flags(struct evhttp_uri *uri, unsigned flags)
Changes the flags set on a given URI.
EVENT2_EXPORT_SYMBOL int evhttp_parse_query_str(const char *uri, struct evkeyvalq *headers)
EVENT2_EXPORT_SYMBOL void evhttp_send_error(struct evhttp_request *req, int error, const char *reason)
Send an HTML error message to the client.
@ EVREQ_HTTP_TIMEOUT
Timeout reached, also.
Definition: http.h:753
EVENT2_EXPORT_SYMBOL char * evhttp_encode_uri(const char *str)
Helper function to encode a string for inclusion in a URI.
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_unixsocket(struct evhttp_uri *uri, const char *unixsocket)
Set the unix socket of an evhttp_uri, or clear the unix socket if unixsocket==NULL.
EVENT2_EXPORT_SYMBOL char * evhttp_uridecode(const char *uri, int decode_plus, size_t *size_out)
Helper function to decode a URI-escaped string or HTTP parameter.
EVENT2_EXPORT_SYMBOL void evhttp_cancel_request(struct evhttp_request *req)
Cancels a pending HTTP request.
EVENT2_EXPORT_SYMBOL const struct evhttp_uri * evhttp_request_get_evhttp_uri(const struct evhttp_request *req)
Returns the request URI (parsed)
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_scheme(const struct evhttp_uri *uri)
Return the scheme of an evhttp_uri, or NULL if there is no scheme has been set and the evhttp_uri con...
EVENT2_EXPORT_SYMBOL int evhttp_uri_set_scheme(struct evhttp_uri *uri, const char *scheme)
Set the scheme of an evhttp_uri, or clear the scheme if scheme==NULL.
EVENT2_EXPORT_SYMBOL struct evkeyvalq * evhttp_request_get_output_headers(struct evhttp_request *req)
Returns the output headers.
const EVENT2_EXPORT_SYMBOL char * evhttp_find_header(const struct evkeyvalq *headers, const char *key)
Finds the value belonging to a header.
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_request_get_connection(struct evhttp_request *req)
Returns the connection object associated with the request or NULL.
EVENT2_EXPORT_SYMBOL void evhttp_set_gencb(struct evhttp *http, void(*cb)(struct evhttp_request *, void *), void *arg)
Set a callback for all requests that are not caught by specific callbacks.
Common convenience functions for cross-platform portability and related socket manipulations.
EVENT2_EXPORT_SYMBOL char * evhttp_uriencode(const char *str, ev_ssize_t size, int space_to_plus)
As evhttp_encode_uri, but if 'size' is nonnegative, treat the string as being 'size' bytes long.
EVENT2_EXPORT_SYMBOL void evhttp_set_ext_method_cmp(struct evhttp *http, evhttp_ext_method_cb cmp)
Sets the callback function which allows HTTP extended methods to be supported by this server.
EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_bind_listener(struct evhttp *http, struct evconnlistener *listener)
The most low-level evhttp_bind/accept method: takes an evconnlistener, and returns an evhttp_bound_so...
EVENT2_EXPORT_SYMBOL void evhttp_send_reply_chunk_with_cb(struct evhttp_request *req, struct evbuffer *databuf, void(*cb)(struct evhttp_connection *, void *), void *arg)
Send another data chunk as part of an ongoing chunked reply.
const EVENT2_EXPORT_SYMBOL char * evhttp_uri_get_host(const struct evhttp_uri *uri)
Return the host part of an evhttp_uri, or NULL if it has no host set.
EVENT2_EXPORT_SYMBOL char * evhttp_htmlescape(const char *html)
Escape HTML character entities in a string.
EVENT2_EXPORT_SYMBOL struct evhttp_bound_socket * evhttp_accept_socket_with_handle(struct evhttp *http, evutil_socket_t fd)
Like evhttp_accept_socket(), but returns a handle for referencing the socket.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
EVENT2_EXPORT_SYMBOL int evhttp_del_cb(struct evhttp *, const char *)
Removes the callback for a specified URI.
libevent: event2/http_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Potentially non-threadsafe versions of the functions in http.h : provided only for backwards compatibility.
+More...
+
#include <event2/event-config.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_new (const char *address, ev_uint16_t port) A connection object that can be used to for making HTTP requests. More... EVENT2_EXPORT_SYMBOL void evhttp_connection_set_base (struct evhttp_connection *evcon, struct event_base *base) Associates an event base with the connection - can only be called on a freshly created connection object that has not been used yet. More... EVENT2_EXPORT_SYMBOL struct evhttp * evhttp_start (const char *address, ev_uint16_t port) Start an HTTP server on the specified address and port. More...
+
+
Potentially non-threadsafe versions of the functions in http.h : provided only for backwards compatibility.
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evhttp_connection_new
+ (
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
A connection object that can be used to for making HTTP requests.
+
The connection object tries to establish the connection when it is given an http request object.
+
Deprecated: It does not allow an event base to be specified
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evhttp_connection_set_base
+ (
+ struct evhttp_connection *
+ evcon ,
+
+ struct event_base *
+ base
+
+ )
+
+
+
+
+
Associates an event base with the connection - can only be called on a freshly created connection object that has not been used yet.
+
Deprecated: XXXX Why?
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp* evhttp_start
+ (
+ const char *
+ address ,
+
+ ev_uint16_t
+ port
+
+ )
+
+
+
+
+
Start an HTTP server on the specified address and port.
+
Deprecated: It does not allow an event base to be specified
+
Parameters
+
+ address the address to which the HTTP server should be bound port the port number on which the HTTP server should listen
+
+
+
Returns a pointer to a newly initialized evhttp server structure or NULL on error
+
+
+
+
libevent: event2/http_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_HTTP_COMPAT_H_INCLUDED_
+
28 #define EVENT2_HTTP_COMPAT_H_INCLUDED_
+
+
+
+
+
+
41 #include <event2/event-config.h>
+
42 #ifdef EVENT__HAVE_SYS_TYPES_H
+
43 #include <sys/types.h>
+
+
45 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
+
+
+
+
+
63 struct evhttp *
evhttp_start (
const char *address, ev_uint16_t port);
+
+
+
+
74 const char *address, ev_uint16_t port);
+
+
+
+
+
+
+
88 #define evhttp_request_uri evhttp_request_get_uri
+
+
+
+
+
+
+
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evhttp_connection_new(const char *address, ev_uint16_t port)
A connection object that can be used to for making HTTP requests.
EVENT2_EXPORT_SYMBOL struct evhttp * evhttp_start(const char *address, ev_uint16_t port)
Start an HTTP server on the specified address and port.
EVENT2_EXPORT_SYMBOL void evhttp_connection_set_base(struct evhttp_connection *evcon, struct event_base *base)
Associates an event base with the connection - can only be called on a freshly created connection obj...
Common convenience functions for cross-platform portability and related socket manipulations.
libevent: Main Page
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Libevent is an event notification library for developing scalable network servers. The Libevent API provides a mechanism to execute a callback function when a specific event occurs on a file descriptor or after a timeout has been reached. Furthermore, Libevent also support callbacks due to signals or regular timeouts.
+
Libevent is meant to replace the event loop found in event driven network servers. An application just needs to call event_base_dispatch() and then add or remove events dynamically without having to change the event loop.
+
Currently, Libevent supports /dev/poll, kqueue(2), select(2), poll(2), epoll(4), and evports. The internal event mechanism is completely independent of the exposed event API, and a simple update of Libevent can provide new functionality without having to redesign the applications. As a result, Libevent allows for portable application development and provides the most scalable event notification mechanism available on an operating system. Libevent can also be used for multithreaded programs. Libevent should compile on Linux, *BSD, Mac OS X, Solaris and, Windows.
+
+
Every program that uses Libevent must include the <event2/event.h > header, and pass the -levent flag to the linker. (You can instead link -levent_core if you only want the main event and buffered IO-based code, and don't want to link any protocol code.)
+
+
Before you call any other Libevent functions, you need to set up the library. If you're going to use Libevent from multiple threads in a multithreaded application, you need to initialize thread support – typically by using evthread_use_pthreads() or evthread_use_windows_threads() . See <event2/thread.h > for more information.
+
This is also the point where you can replace Libevent's memory management functions with event_set_mem_functions, and enable debug mode with event_enable_debug_mode() .
+
+
Next, you need to create an event_base structure, using event_base_new() or event_base_new_with_config() . The event_base is responsible for keeping track of which events are "pending" (that is to say, being watched to see if they become active) and which events are "active". Every event is associated with a single event_base .
+
+
For each file descriptor that you wish to monitor, you must create an event structure with event_new() . (You may also declare an event structure and call event_assign() to initialize the members of the structure.) To enable notification, you add the structure to the list of monitored events by calling event_add() . The event structure must remain allocated as long as it is active, so it should generally be allocated on the heap.
+
+
Finally, you call event_base_dispatch() to loop and dispatch events. You can also use event_base_loop() for more fine-grained control.
+
Currently, only one thread can be dispatching a given event_base at a time. If you want to run events in multiple threads at once, you can either have a single event_base whose events add work to a work queue, or you can create multiple event_base objects.
+
+
Libevent provides a buffered I/O abstraction on top of the regular event callbacks. This abstraction is called a bufferevent. A bufferevent provides input and output buffers that get filled and drained automatically. The user of a buffered event no longer deals directly with the I/O, but instead is reading from input and writing to output buffers.
+
Once initialized via bufferevent_socket_new() , the bufferevent structure can be used repeatedly with bufferevent_enable() and bufferevent_disable() . Instead of reading and writing directly to a socket, you would call bufferevent_read() and bufferevent_write() .
+
When read enabled the bufferevent will try to read from the file descriptor and call the read callback. The write callback is executed whenever the output buffer is drained below the write low watermark, which is 0 by default.
+
See <event2/bufferevent*.h> for more information.
+
+
Libevent can also be used to create timers that invoke a callback after a certain amount of time has expired. The evtimer_new() macro returns an event struct to use as a timer. To activate the timer, call evtimer_add(). Timers can be deactivated by calling evtimer_del(). (These macros are thin wrappers around event_new() , event_add() , and event_del() ; you can also use those instead.)
+
+
Libevent provides an asynchronous DNS resolver that should be used instead of the standard DNS resolver functions. See the <event2/dns.h > functions for more detail.
+
+
Libevent provides a very simple event-driven HTTP server that can be embedded in your program and used to service HTTP requests.
+
To use this capability, you need to include the <event2/http.h > header in your program. See that header for more information.
+
+
Libevent provides a framework for creating RPC servers and clients. It takes care of marshaling and unmarshaling all data structures.
+
+
To browse the complete documentation of the libevent API, click on any of the following links.
+
event2/event.h The primary libevent header
+
event2/thread.h Functions for use by multithreaded programs
+
event2/buffer.h and event2/bufferevent.h Buffer management for network reading and writing
+
event2/util.h Utility functions for portable nonblocking network code
+
event2/dns.h Asynchronous DNS resolution
+
event2/http.h An embedded libevent-based HTTP server
+
event2/rpc.h A framework for creating RPC servers and clients
+
event2/watch.h "Prepare" and "check" watchers.
+
+
+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""," "],thead:[1,""],col:[2,""],tr:[2,""],td:[3,""],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.width
i?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t(""),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidth
t.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element
+},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/**
+ * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler
+ * Licensed under MIT
+ * @author Ariel Flesler
+ * @version 2.1.2
+ */
+;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017
+ * http://www.smartmenus.org/
+ * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$});
\ No newline at end of file
diff --git a/listener_8h.html b/listener_8h.html
new file mode 100644
index 0000000..5525e47
--- /dev/null
+++ b/listener_8h.html
@@ -0,0 +1,442 @@
+
+
+
+libevent: event2/listener.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A callback that we invoke when a listener has a new connection.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event.h >
+
+
Go to the source code of this file.
+
+#define LEV_OPT_BIND_IPV4_AND_IPV6 (1u<<9) Flag: Indicates that the listener wants to work only in both IPv4 and IPv6 socket. More... #define LEV_OPT_BIND_IPV6ONLY (1u<<8) Flag: Indicates that the listener wants to work only in IPv6 socket. More... LEV_OPT_CLOSE_ON_EXEC (1u<<2) Flag: Indicates that we should set the close-on-exec flag, if possible. LEV_OPT_CLOSE_ON_FREE (1u<<1) Flag: Indicates that freeing the listener should close the underlying socket. #define LEV_OPT_DEFERRED_ACCEPT (1u<<6) Flag: Indicates that the listener should defer accept() until data is available, if possible. More... #define LEV_OPT_DISABLED (1u<<5) Flag: Indicates that the listener should be created in disabled state. More... LEV_OPT_LEAVE_SOCKETS_BLOCKING (1u<<0) Flag: Indicates that we should not make incoming sockets nonblocking before passing them to the callback. LEV_OPT_REUSEABLE (1u<<3) Flag: Indicates that we should disable the timeout (if any) between when this socket is closed and when we can listen again on the same port. #define LEV_OPT_REUSEABLE_PORT (1u<<7) Flag: Indicates that we ask to allow multiple servers (processes or threads) to bind to the same port if they each set the option. More... LEV_OPT_THREADSAFE (1u<<4) Flag: Indicates that the listener should be locked so it's safe to use from multiple threadcs at once.
+evconnlistener_cb ) (struct evconnlistener *, evutil_socket_t , struct sockaddr *, int socklen, void *) typedef void(* evconnlistener_errorcb ) (struct evconnlistener *, void *) A callback that we invoke when a listener encounters a non-retriable error. More...
+evconnlistener_disable (struct evconnlistener *lev) Stop listening for connections on an evconnlistener. evconnlistener_enable (struct evconnlistener *lev) Re-enable an evconnlistener that has been disabled. evconnlistener_free (struct evconnlistener *lev) Disable and deallocate an evconnlistener. event_base * evconnlistener_get_base (struct evconnlistener *lev) Return an evconnlistener's associated event_base . evutil_socket_t evconnlistener_get_fd (struct evconnlistener *lev) Return the socket that an evconnlistner is listening on. EVENT2_EXPORT_SYMBOL struct evconnlistener * evconnlistener_new (struct event_base *base, evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, evutil_socket_t fd) Allocate a new evconnlistener object to listen for incoming TCP connections on a given file descriptor. More... EVENT2_EXPORT_SYMBOL struct evconnlistener * evconnlistener_new_bind (struct event_base *base, evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, const struct sockaddr *sa, int socklen) Allocate a new evconnlistener object to listen for incoming TCP connections on a given address. More... evconnlistener_set_cb (struct evconnlistener *lev, evconnlistener_cb cb, void *arg) Change the callback on the listener to cb and its user_data to arg. evconnlistener_set_error_cb (struct evconnlistener *lev, evconnlistener_errorcb errorcb) Set an evconnlistener's error callback.
+
+
A callback that we invoke when a listener has a new connection.
+
Parameters
+
+ listener The evconnlistener fd The new file descriptor addr The source address of the connection socklen The length of addr user_arg the pointer passed to evconnlistener_new()
+
+
+
+
+
◆
+
+
+
+
+
+ #define LEV_OPT_BIND_IPV4_AND_IPV6 (1u<<9)
+
+
+
+
+
Flag: Indicates that the listener wants to work only in both IPv4 and IPv6 socket.
+
This flag exists as copmlement to LEV_OPT_BIND_IPV6ONLY to account for the different default behaviour on Windows so that the code can explicitly request the socket to support both modes without having to rely on the default option.
+
+
+
+
+
◆
+
+
+
+
+
+ #define LEV_OPT_BIND_IPV6ONLY (1u<<8)
+
+
+
+
+
Flag: Indicates that the listener wants to work only in IPv6 socket.
+
According to RFC3493 and most Linux distributions, default value is to work in IPv4-mapped mode. If there is a requirement to bind same port on same ip addresses but different handlers for both IPv4 and IPv6, it is required to set IPV6_V6ONLY socket option to be sure that the code works as expected without affected by bindv6only sysctl setting in system.
+
This socket option on Windows is instead enabled by default.
+
+
+
+
+
◆
+
+
+
+
+
+ #define LEV_OPT_DEFERRED_ACCEPT (1u<<6)
+
+
+
+
+
Flag: Indicates that the listener should defer accept() until data is available, if possible.
+
Ignored on platforms that do not support this.
+
This option can help performance for protocols where the client transmits immediately after connecting. Do not use this option if your protocol doesn't start out with the client transmitting data, since in that case this option will sometimes cause the kernel to never tell you about the connection.
+
This option is only supported by evconnlistener_new_bind() : it can't work with evconnlistener_new_fd(), since the listener needs to be told to use the option before it is actually bound.
+
+
+
+
+
◆
+
+
+
+
+
+ #define LEV_OPT_DISABLED (1u<<5)
+
+
+
+
+
Flag: Indicates that the listener should be created in disabled state.
+
Use evconnlistener_enable() to enable it later.
+
+
+
+
+
◆
+
+
+
+
+
+ #define LEV_OPT_REUSEABLE_PORT (1u<<7)
+
+
+
+
+
Flag: Indicates that we ask to allow multiple servers (processes or threads) to bind to the same port if they each set the option.
+
SO_REUSEPORT is what most people would expect SO_REUSEADDR to be, however SO_REUSEPORT does not imply SO_REUSEADDR.
+
This is only available on Linux and kernel 3.9+
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evconnlistener_errorcb) (struct evconnlistener *, void *)
+
+
+
+
+
A callback that we invoke when a listener encounters a non-retriable error.
+
Parameters
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evconnlistener* evconnlistener_new
+ (
+ struct event_base *
+ base ,
+
+ evconnlistener_cb
+ cb ,
+
+ void *
+ ptr ,
+
+ unsigned
+ flags ,
+
+ int
+ backlog ,
+
+ evutil_socket_t fd
+
+ )
+
+
+
+
+
Allocate a new evconnlistener object to listen for incoming TCP connections on a given file descriptor.
+
Parameters
+
+ base The event base to associate the listener with. cb A callback to be invoked when a new connection arrives. If the callback is NULL, the listener will be treated as disabled until the callback is set. ptr A user-supplied pointer to give to the callback. flags Any number of LEV_OPT_* flags backlog Passed to the listen() call to determine the length of the acceptable connection backlog. Set to -1 for a reasonable default. Set to 0 if the socket is already listening. fd The file descriptor to listen on. It must be a nonblocking file descriptor, and it should already be bound to an appropriate port and address.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evconnlistener* evconnlistener_new_bind
+ (
+ struct event_base *
+ base ,
+
+ evconnlistener_cb
+ cb ,
+
+ void *
+ ptr ,
+
+ unsigned
+ flags ,
+
+ int
+ backlog ,
+
+ const struct sockaddr *
+ sa ,
+
+ int
+ socklen
+
+ )
+
+
+
+
+
Allocate a new evconnlistener object to listen for incoming TCP connections on a given address.
+
Parameters
+
+ base The event base to associate the listener with. cb A callback to be invoked when a new connection arrives. If the callback is NULL, the listener will be treated as disabled until the callback is set. ptr A user-supplied pointer to give to the callback. flags Any number of LEV_OPT_* flags backlog Passed to the listen() call to determine the length of the acceptable connection backlog. Set to -1 for a reasonable default. sa The address to listen for connections on. socklen The length of the address.
+
+
+
+
+
+
libevent: event2/listener.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_LISTENER_H_INCLUDED_
+
28 #define EVENT2_LISTENER_H_INCLUDED_
+
+
30 #include <event2/visibility.h>
+
+
+
+
+
+
+
+
+
39 struct evconnlistener;
+
+
51 typedef void (*evconnlistener_cb)(
struct evconnlistener *,
evutil_socket_t ,
struct sockaddr *,
int socklen,
void *);
+
+
+
+
63 #define LEV_OPT_LEAVE_SOCKETS_BLOCKING (1u<<0)
+
+
66 #define LEV_OPT_CLOSE_ON_FREE (1u<<1)
+
+
68 #define LEV_OPT_CLOSE_ON_EXEC (1u<<2)
+
+
71 #define LEV_OPT_REUSEABLE (1u<<3)
+
+
74 #define LEV_OPT_THREADSAFE (1u<<4)
+
+
77 #define LEV_OPT_DISABLED (1u<<5)
+
+
91 #define LEV_OPT_DEFERRED_ACCEPT (1u<<6)
+
+
100 #define LEV_OPT_REUSEABLE_PORT (1u<<7)
+
+
112 #define LEV_OPT_BIND_IPV6ONLY (1u<<8)
+
+
121 #define LEV_OPT_BIND_IPV4_AND_IPV6 (1u<<9)
+
+
+
+
142 evconnlistener_cb cb,
void *ptr,
unsigned flags,
int backlog,
+
+
+
+
161 evconnlistener_cb cb,
void *ptr,
unsigned flags,
int backlog,
+
162 const struct sockaddr *sa,
int socklen);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
191 evconnlistener_cb cb,
void *arg);
+
+
+
+
+
+
+
+
+
+
+
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL evutil_socket_t evconnlistener_get_fd(struct evconnlistener *lev)
Return the socket that an evconnlistner is listening on.
EVENT2_EXPORT_SYMBOL struct evconnlistener * evconnlistener_new(struct event_base *base, evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, evutil_socket_t fd)
Allocate a new evconnlistener object to listen for incoming TCP connections on a given file descripto...
Core functions for waiting for and receiving events, and using event bases.
EVENT2_EXPORT_SYMBOL struct evconnlistener * evconnlistener_new_bind(struct event_base *base, evconnlistener_cb cb, void *ptr, unsigned flags, int backlog, const struct sockaddr *sa, int socklen)
Allocate a new evconnlistener object to listen for incoming TCP connections on a given address.
void(* evconnlistener_errorcb)(struct evconnlistener *, void *)
A callback that we invoke when a listener encounters a non-retriable error.
Definition: listener.h:59
EVENT2_EXPORT_SYMBOL int evconnlistener_disable(struct evconnlistener *lev)
Stop listening for connections on an evconnlistener.
EVENT2_EXPORT_SYMBOL void evconnlistener_free(struct evconnlistener *lev)
Disable and deallocate an evconnlistener.
EVENT2_EXPORT_SYMBOL void evconnlistener_set_cb(struct evconnlistener *lev, evconnlistener_cb cb, void *arg)
Change the callback on the listener to cb and its user_data to arg.
EVENT2_EXPORT_SYMBOL struct event_base * evconnlistener_get_base(struct evconnlistener *lev)
Return an evconnlistener's associated event_base.
EVENT2_EXPORT_SYMBOL int evconnlistener_enable(struct evconnlistener *lev)
Re-enable an evconnlistener that has been disabled.
EVENT2_EXPORT_SYMBOL void evconnlistener_set_error_cb(struct evconnlistener *lev, evconnlistener_errorcb errorcb)
Set an evconnlistener's error callback.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: Related Pages
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all related documentation pages:
+
libevent: event2/rpc.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This header files provides basic support for an RPC server and client.
+More...
+
#include <event2/util.h >
+
#include <event2/visibility.h>
+
+
Go to the source code of this file.
+
+#define EVRPC_GENERATE (rpcname, reqstruct, rplystruct) Generates the code for receiving and sending an RPC message. More... #define EVRPC_HEADER (rpcname, reqstruct, rplystruct) Creates the definitions and prototypes for an RPC. More... #define EVRPC_MAKE_CTX (rpcname, reqstruct, rplystruct, pool, request, reply, cb, cbarg) Creates a context structure that contains rpc specific information. More... #define EVRPC_MAKE_REQUEST (name, pool, request, reply, cb, cbarg) evrpc_send_request_##name((pool), (request), (reply), (cb), (cbarg)) launches an RPC and sends it to the server More... #define EVRPC_REGISTER (base, name, request, reply, callback, cbarg) register RPCs with the HTTP Server More... #define EVRPC_REQUEST_DONE (rpc_req) Creates the reply to an RPC request. More... #define EVRPC_REQUEST_HTTP (rpc_req) (rpc_req)->http_req Provides access to the HTTP request object underlying an RPC. More... #define EVRPC_STRUCT (rpcname) struct evrpc_req__##rpcname The type of a specific RPC Message. More... #define EVRPC_UNREGISTER (base, name) evrpc_unregister_rpc((base), #name) Unregisters an already registered RPC. More... EVTAG_ARRAY_ADD (msg, member) (*(msg)->base->member##_add)(msg) Allocates a new entry in the array and returns it. EVTAG_ARRAY_ADD_VALUE (msg, member, value) (*(msg)->base->member##_add)((msg), (value)) Adds a value to an array. EVTAG_ARRAY_GET (msg, member, offset, pvalue) (*(msg)->base->member##_get)((msg), (offset), (pvalue)) Gets a variable at the specified offset from the array. EVTAG_ARRAY_LEN (msg, member) ((msg)->member##_length) Returns the number of entries in the array. #define EVTAG_ASSIGN (msg, member, value) (*(msg)->base->member##_assign)((msg), (value)) Assigns a value to the member in the message. More... #define EVTAG_ASSIGN_WITH_LEN (msg, member, value, len) (*(msg)->base->member##_assign)((msg), (value), (len)) Assigns a value to the member in the message. More... #define EVTAG_GET (msg, member, pvalue) (*(msg)->base->member##_get)((msg), (pvalue)) Returns the value for a member. More... #define EVTAG_GET_WITH_LEN (msg, member, pvalue, plen) (*(msg)->base->member##_get)((msg), (pvalue), (plen)) Returns the value for a member. More... #define EVTAG_HAS (msg, member) ((msg)->member##_set == 1) Determines if the member has been set in the message. More... #define INPUT EVRPC_INPUT Deprecated alias for EVRPC_INPUT. More... #define OUTPUT EVRPC_OUTPUT Deprecated alias for EVRPC_OUTPUT. More...
+EVENT2_EXPORT_SYMBOL void * evrpc_add_hook (void *vbase, enum EVRPC_HOOK_TYPE hook_type, int(*cb)(void *, struct evhttp_request *, struct evbuffer *, void *), void *cb_arg) adds a processing hook to either an rpc base or rpc pool More... EVENT2_EXPORT_SYMBOL void evrpc_free (struct evrpc_base *base) Frees the evrpc base. More... evrpc_get_reply (struct evrpc_req_generic *req) evrpc_get_request (struct evrpc_req_generic *req) accessors for request and reply EVENT2_EXPORT_SYMBOL int evrpc_hook_add_meta (void *ctx, const char *key, const void *data, size_t data_size) adds meta data to request More... EVENT2_EXPORT_SYMBOL int evrpc_hook_find_meta (void *ctx, const char *key, void **data, size_t *data_size) retrieves meta data previously associated More... EVENT2_EXPORT_SYMBOL struct evhttp_connection * evrpc_hook_get_connection (void *ctx) returns the connection object associated with the request More... EVENT2_EXPORT_SYMBOL struct evrpc_base * evrpc_init (struct evhttp *server) Creates a new rpc base from which RPC requests can be received. More... EVENT2_EXPORT_SYMBOL int evrpc_make_request (struct evrpc_request_wrapper *ctx) Makes an RPC request based on the provided context. More... evrpc_make_request_ctx (struct evrpc_pool *pool, void *request, void *reply, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *), void(*cb)(struct evrpc_status *, void *, void *, void *), void *cbarg) use EVRPC_GENERATE instead EVENT2_EXPORT_SYMBOL void evrpc_pool_add_connection (struct evrpc_pool *pool, struct evhttp_connection *evcon) Adds a connection over which rpc can be dispatched to the pool. More... EVENT2_EXPORT_SYMBOL void evrpc_pool_free (struct evrpc_pool *pool) frees an rpc connection pool More... EVENT2_EXPORT_SYMBOL struct evrpc_pool * evrpc_pool_new (struct event_base *base) creates an rpc connection pool More... EVENT2_EXPORT_SYMBOL void evrpc_pool_remove_connection (struct evrpc_pool *pool, struct evhttp_connection *evcon) Removes a connection from the pool. More... EVENT2_EXPORT_SYMBOL void evrpc_pool_set_timeout (struct evrpc_pool *pool, int timeout_in_secs) Sets the timeout in secs after which a request has to complete. More... EVENT2_EXPORT_SYMBOL int evrpc_register_generic (struct evrpc_base *base, const char *name, void(*callback)(struct evrpc_req_generic *, void *), void *cbarg, void *(*req_new)(void *), void *req_new_arg, void(*req_free)(void *), int(*req_unmarshal)(void *, struct evbuffer *), void *(*rpl_new)(void *), void *rpl_new_arg, void(*rpl_free)(void *), int(*rpl_complete)(void *), void(*rpl_marshal)(struct evbuffer *, void *)) Function for registering a generic RPC with the RPC base. More... EVENT2_EXPORT_SYMBOL int evrpc_register_rpc (struct evrpc_base *, struct evrpc *, void(*)(struct evrpc_req_generic *, void *), void *) Low level function for registering an RPC with a server. More... EVENT2_EXPORT_SYMBOL int evrpc_remove_hook (void *vbase, enum EVRPC_HOOK_TYPE hook_type, void *handle) removes a previously added hook More... evrpc_request_done (struct evrpc_req_generic *req) completes the server response to an rpc request evrpc_request_get_pool (struct evrpc_request_wrapper *ctx) accessors for obscure and undocumented functionality evrpc_request_set_cb (struct evrpc_request_wrapper *ctx, void(*cb)(struct evrpc_status *, void *request, void *reply, void *arg), void *cb_arg) evrpc_request_set_pool (struct evrpc_request_wrapper *ctx, struct evrpc_pool *pool) EVENT2_EXPORT_SYMBOL int evrpc_resume_request (void *vbase, void *ctx, enum EVRPC_HOOK_RESULT res) resume a paused request More... EVENT2_EXPORT_SYMBOL int evrpc_send_request_generic (struct evrpc_pool *pool, void *request, void *reply, void(*cb)(struct evrpc_status *, void *, void *, void *), void *cb_arg, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *)) Function for sending a generic RPC request. More... evrpc_unregister_rpc (struct evrpc_base *base, const char *name)
+
+
This header files provides basic support for an RPC server and client.
+
To support RPCs in a server, every supported RPC command needs to be defined and registered.
+
EVRPC_HEADER(SendCommand, Request, Reply) ;
+
SendCommand is the name of the RPC command. Request is the name of a structure generated by event_rpcgen.py. It contains all parameters relating to the SendCommand RPC. The server needs to fill in the Reply structure. Reply is the name of a structure generated by event_rpcgen.py. It contains the answer to the RPC.
+
To register an RPC with an HTTP server, you need to first create an RPC base with:
+
struct evrpc_base *base = evrpc_init(http);
+
A specific RPC can then be registered with
+
EVRPC_REGISTER(base, SendCommand, Request, Reply, FunctionCB, arg) ;
+
when the server receives an appropriately formatted RPC, the user callback is invoked. The callback needs to fill in the reply structure.
+
void FunctionCB(EVRPC_STRUCT(SendCommand)* rpc, void *arg);
+
To send the reply, call EVRPC_REQUEST_DONE(rpc) ;
+
See the regression test for an example.
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_GENERATE
+ (
+
+ rpcname,
+
+
+
+ reqstruct,
+
+
+
+ rplystruct
+
+
+ )
+
+
+
+
Value: int evrpc_send_request_##rpcname(struct evrpc_pool *pool, \
+
struct reqstruct *request, struct rplystruct *reply, \
+
void (*cb)(struct evrpc_status *, \
+
struct reqstruct *, struct rplystruct *, void *cbarg), \
+
void *cbarg) { \
+
+
(void (*)(struct evrpc_status *, void *, void *, void *))cb, \
+
cbarg, \
+
#rpcname, \
+
(
void (*)(
struct evbuffer *,
void *))reqstruct##_marshal, \
+
(void (*)(void *))rplystruct##_clear, \
+
(
int (*)(
void *,
struct evbuffer *))rplystruct##_unmarshal); \
+
}
+
+
Generates the code for receiving and sending an RPC message.
+
EVRPC_GENERATE is used to create the code corresponding to sending and receiving a particular RPC message
+
Parameters
+
+ rpcname the name of the RPC reqstruct the name of the RPC request structure rplystruct the name of the RPC reply structure
+
+
+
See also EVRPC_HEADER()
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_HEADER
+ (
+
+ rpcname,
+
+
+
+ reqstruct,
+
+
+
+ rplystruct
+
+
+ )
+
+
+
+
Value:
+
struct evrpc_hook_meta *hook_meta; \
+
struct reqstruct* request; \
+
struct rplystruct* reply; \
+
struct evrpc* rpc; \
+
struct evhttp_request* http_req; \
+
+
}; \
+
EVENT2_EXPORT_SYMBOL \
+
int evrpc_send_request_##rpcname(struct evrpc_pool *, \
+
struct reqstruct *, struct rplystruct *, \
+
void (*)(struct evrpc_status *, \
+
struct reqstruct *, struct rplystruct *, void *cbarg), \
+
void *);
+
+
Creates the definitions and prototypes for an RPC.
+
You need to use EVRPC_HEADER to create structures and function prototypes needed by the server and client implementation. The structures have to be defined in an .rpc file and converted to source code via event_rpcgen.py
+
Parameters
+
+ rpcname the name of the RPC reqstruct the name of the RPC request structure rplystruct the name of the RPC reply structure
+
+
+
See also EVRPC_GENERATE()
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_MAKE_CTX
+ (
+
+ rpcname,
+
+
+
+ reqstruct,
+
+
+
+ rplystruct,
+
+
+
+ pool,
+
+
+
+ request,
+
+
+
+ reply,
+
+
+
+ cb,
+
+
+
+ cbarg
+
+
+ )
+
+
+
+
Value:
+
#rpcname, \
+
(
void (*)(
struct evbuffer *,
void *))reqstruct##_marshal, \
+
(void (*)(void *))rplystruct##_clear, \
+
(
int (*)(
void *,
struct evbuffer *))rplystruct##_unmarshal, \
+
(void (*)(struct evrpc_status *, void *, void *, void *))cb, \
+
cbarg)
+
+
Creates a context structure that contains rpc specific information.
+
EVRPC_MAKE_CTX is used to populate a RPC specific context that contains information about marshaling the RPC data types.
+
Parameters
+
+ rpcname the name of the RPC reqstruct the name of the RPC request structure rplystruct the name of the RPC reply structure pool the evrpc_pool over which to make the request request a pointer to the RPC request structure object reply a pointer to the RPC reply structure object cb the callback function to call when the RPC has completed cbarg the argument to supply to the callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_MAKE_REQUEST
+ (
+
+ name,
+
+
+
+ pool,
+
+
+
+ request,
+
+
+
+ reply,
+
+
+
+ cb,
+
+
+
+ cbarg
+
+
+ )
+ evrpc_send_request_##name((pool), (request), (reply), (cb), (cbarg))
+
+
+
+
+
launches an RPC and sends it to the server
+
EVRPC_MAKE_REQUEST() is used by the client to send an RPC to the server.
+
Parameters
+
+ name the name of the RPC pool the evrpc_pool that contains the connection objects over which the request should be sent. request a pointer to the RPC request structure - it contains the data to be sent to the server. reply a pointer to the RPC reply structure. It is going to be filled if the request was answered successfully cb the callback to invoke when the RPC request has been answered cbarg an additional argument to be passed to the client
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_REGISTER
+ (
+
+ base,
+
+
+
+ name,
+
+
+
+ request,
+
+
+
+ reply,
+
+
+
+ callback,
+
+
+
+ cbarg
+
+
+ )
+
+
+
+
Value:
+
(void (*)(struct evrpc_req_generic *, void *))callback, cbarg, \
+
(void *(*)(void *))request##_new_with_arg, NULL, \
+
(void (*)(void *))request##_free, \
+
(
int (*)(
void *,
struct evbuffer *))request##_unmarshal, \
+
(void *(*)(void *))reply##_new_with_arg, NULL, \
+
(void (*)(void *))reply##_free, \
+
(int (*)(void *))reply##_complete, \
+
(
void (*)(
struct evbuffer *,
void *))reply##_marshal)
+
+
register RPCs with the HTTP Server
+
registers a new RPC with the HTTP server, each RPC needs to have a unique name under which it can be identified.
+
Parameters
+
+ base the evrpc_base structure in which the RPC should be registered. name the name of the RPC request the name of the RPC request structure reply the name of the RPC reply structure callback the callback that should be invoked when the RPC is received. The callback has the following prototype void (callback)(EVRPC_STRUCT(Message) rpc, void *arg) cbarg an additional parameter that can be passed to the callback. The parameter can be used to carry around state.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_REQUEST_DONE
+ (
+
+ rpc_req )
+
+
+
+
Value: do { \
+
struct evrpc_req_generic *req_ = (struct evrpc_req_generic *)(rpc_req); \
+
evrpc_request_done(req_); \
+
} while (0)
+
+
Creates the reply to an RPC request.
+
EVRPC_REQUEST_DONE is used to answer a request; the reply is expected to have been filled in. The request and reply pointers become invalid after this call has finished.
+
Parameters
+
+ rpc_req the rpc request structure provided to the server callback
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_REQUEST_HTTP
+ (
+
+ rpc_req )
+ (rpc_req)->http_req
+
+
+
+
+
Provides access to the HTTP request object underlying an RPC.
+
Access to the underlying http object; can be used to look at headers or for getting the remote ip address
+
Parameters
+
+ rpc_req the rpc request structure provided to the server callback
+
+
+
Returns an struct evhttp_request object that can be inspected for HTTP headers or sender information.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_STRUCT
+ (
+
+ rpcname )
+ struct evrpc_req__##rpcname
+
+
+
+
+
The type of a specific RPC Message.
+
Parameters
+
+ rpcname the name of the RPC message
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVRPC_UNREGISTER
+ (
+
+ base,
+
+
+
+ name
+
+
+ )
+ evrpc_unregister_rpc((base), #name)
+
+
+
+
+
Unregisters an already registered RPC.
+
Parameters
+
+ base the evrpc_base object from which to unregister an RPC name the name of the rpc to unregister
+
+
+
Returns -1 on error or 0 when successful.
+
See also EVRPC_REGISTER()
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVTAG_ASSIGN
+ (
+
+ msg,
+
+
+
+ member,
+
+
+
+ value
+
+
+ )
+ (*(msg)->base->member##_assign)((msg), (value))
+
+
+
+
+
Assigns a value to the member in the message.
+
Parameters
+
+ msg the message to which to assign a value member the name of the member variable value the value to assign
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVTAG_ASSIGN_WITH_LEN
+ (
+
+ msg,
+
+
+
+ member,
+
+
+
+ value,
+
+
+
+ len
+
+
+ )
+ (*(msg)->base->member##_assign)((msg), (value), (len))
+
+
+
+
+
Assigns a value to the member in the message.
+
Parameters
+
+ msg the message to which to assign a value member the name of the member variable value the value to assign len the length of the value
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVTAG_GET
+ (
+
+ msg,
+
+
+
+ member,
+
+
+
+ pvalue
+
+
+ )
+ (*(msg)->base->member##_get)((msg), (pvalue))
+
+
+
+
+
Returns the value for a member.
+
Parameters
+
+ msg the message from which to get the value member the name of the member variable pvalue a pointer to the variable to hold the value
+
+
+
Returns 0 on success, -1 otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVTAG_GET_WITH_LEN
+ (
+
+ msg,
+
+
+
+ member,
+
+
+
+ pvalue,
+
+
+
+ plen
+
+
+ )
+ (*(msg)->base->member##_get)((msg), (pvalue), (plen))
+
+
+
+
+
Returns the value for a member.
+
Parameters
+
+ msg the message from which to get the value member the name of the member variable pvalue a pointer to the variable to hold the value plen a pointer to the length of the value
+
+
+
Returns 0 on success, -1 otherwise.
+
+
+
+
+
◆
+
+
+
+
+
+ #define EVTAG_HAS
+ (
+
+ msg,
+
+
+
+ member
+
+
+ )
+ ((msg)->member##_set == 1)
+
+
+
+
+
Determines if the member has been set in the message.
+
Parameters
+
+ msg the message to inspect member the member variable to test for presences
+
+
+
Returns 1 if it's present or 0 otherwise.
+
+
+
+
+
◆
+
+
+
+
+
Deprecated alias for EVRPC_INPUT.
+
Not available on windows, where it conflicts with platform headers.
+
+
+
+
+
◆
+
+
+
+
+
Deprecated alias for EVRPC_OUTPUT.
+
Not available on windows, where it conflicts with platform headers.
+
+
+
+
+
+
◆
+
+
+
+
+
Return value from hook processing functions.
+
+Enumerator indicates the rpc should be terminated
+continue processing the rpc
+pause processing request until resumed
+
+
+
+
+
+
◆
+
+
+
+
+
Hooks for changing the input and output of RPCs; this can be used to implement compression, authentication, encryption, ...
+
+Enumerator apply the function to an input hook
+apply the function to an output hook
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void* evrpc_add_hook
+ (
+ void *
+ vbase ,
+
+ enum EVRPC_HOOK_TYPE
+ hook_type ,
+
+ int(*)(void *, struct evhttp_request *, struct evbuffer *, void *)
+ cb ,
+
+ void *
+ cb_arg
+
+ )
+
+
+
+
+
adds a processing hook to either an rpc base or rpc pool
+
If a hook returns TERMINATE, the processing is aborted. On CONTINUE, the request is immediately processed after the hook returns. If the hook returns PAUSE, request processing stops until evrpc_resume_request() has been called.
+
The add functions return handles that can be used for removing hooks.
+
Parameters
+
+ vbase a pointer to either struct evrpc_base or struct evrpc_pool hook_type either INPUT or OUTPUT cb the callback to call when the hook is activated cb_arg an additional argument for the callback
+
+
+
Returns a handle to the hook so it can be removed later
+
See also evrpc_remove_hook()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evrpc_free
+ (
+ struct evrpc_base *
+ base )
+
+
+
+
+
Frees the evrpc base.
+
For now, you are responsible for making sure that no rpcs are ongoing.
+
Parameters
+
+ base the evrpc_base object to be freed
+
+
+
See also evrpc_init
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_hook_add_meta
+ (
+ void *
+ ctx ,
+
+ const char *
+ key ,
+
+ const void *
+ data ,
+
+ size_t
+ data_size
+
+ )
+
+
+
+
+
adds meta data to request
+
evrpc_hook_add_meta() allows hooks to add meta data to a request. for a client request, the meta data can be inserted by an outgoing request hook and retrieved by the incoming request hook.
+
Parameters
+
+ ctx the context provided to the hook call key a NUL-terminated c-string data the data to be associated with the key data_size the size of the data
+
+
+
Returns 0 on success or -1 on failure (in case of memory allocation failures)
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_hook_find_meta
+ (
+ void *
+ ctx ,
+
+ const char *
+ key ,
+
+ void **
+ data ,
+
+ size_t *
+ data_size
+
+ )
+
+
+
+
+
retrieves meta data previously associated
+
evrpc_hook_find_meta() can be used to retrieve meta data associated to a request by a previous hook.
Parameters
+
+ ctx the context provided to the hook call key a NUL-terminated c-string data pointer to a data pointer that will contain the retrieved data data_size pointer to the size of the data
+
+
+
Returns 0 on success or -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evhttp_connection* evrpc_hook_get_connection
+ (
+ void *
+ ctx )
+
+
+
+
+
returns the connection object associated with the request
+
Parameters
+
+ ctx the context provided to the hook call
+
+
+
Returns a pointer to the evhttp_connection object or NULL if an error occurred
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evrpc_base* evrpc_init
+ (
+ struct evhttp *
+ server )
+
+
+
+
+
Creates a new rpc base from which RPC requests can be received.
+
Parameters
+
+ server a pointer to an existing HTTP server
+
+
+
Returns a newly allocated evrpc_base struct or NULL if an error occurred
+
See also evrpc_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_make_request
+ (
+ struct evrpc_request_wrapper *
+ ctx )
+
+
+
+
+
Makes an RPC request based on the provided context.
+
This is a low-level function and should not be used directly unless a custom context object is provided. Use EVRPC_MAKE_REQUEST() instead.
+
Parameters
+
+
+
+
Returns 0 on success, -1 otherwise.
+
See also EVRPC_MAKE_REQUEST() , EVRPC_MAKE_CTX()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evrpc_pool_add_connection
+ (
+ struct evrpc_pool *
+ pool ,
+
+ struct evhttp_connection *
+ evcon
+
+ )
+
+
+
+
+
Adds a connection over which rpc can be dispatched to the pool.
+
The connection object must have been newly created.
+
Parameters
+
+ pool the pool to which to add the connection evcon the connection to add to the pool.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evrpc_pool_free
+ (
+ struct evrpc_pool *
+ pool )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evrpc_pool* evrpc_pool_new
+ (
+ struct event_base *
+ base )
+
+
+
+
+
creates an rpc connection pool
+
a pool has a number of connections associated with it. rpc requests are always made via a pool.
+
Parameters
+
+ base a pointer to an struct event_based object; can be left NULL in singled-threaded applications
+
+
+
Returns a newly allocated struct evrpc_pool object or NULL if an error occurred
+
See also evrpc_pool_free()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evrpc_pool_remove_connection
+ (
+ struct evrpc_pool *
+ pool ,
+
+ struct evhttp_connection *
+ evcon
+
+ )
+
+
+
+
+
Removes a connection from the pool.
+
The connection object must have been newly created.
+
Parameters
+
+ pool the pool from which to remove the connection evcon the connection to remove from the pool.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evrpc_pool_set_timeout
+ (
+ struct evrpc_pool *
+ pool ,
+
+ int
+ timeout_in_secs
+
+ )
+
+
+
+
+
Sets the timeout in secs after which a request has to complete.
+
The RPC is completely aborted if it does not complete by then. Setting the timeout to 0 means that it never timeouts and can be used to implement callback type RPCs.
+
Any connection already in the pool will be updated with the new timeout. Connections added to the pool after set_timeout has be called receive the pool timeout only if no timeout has been set for the connection itself.
+
Parameters
+
+ pool a pointer to a struct evrpc_pool object timeout_in_secs the number of seconds after which a request should timeout and a failure be returned to the callback.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_register_generic
+ (
+ struct evrpc_base *
+ base ,
+
+ const char *
+ name ,
+
+ void(*)(struct evrpc_req_generic *, void *)
+ callback ,
+
+ void *
+ cbarg ,
+
+ void *(*)(void *)
+ req_new ,
+
+ void *
+ req_new_arg ,
+
+ void(*)(void *)
+ req_free ,
+
+ int(*)(void *, struct evbuffer *)
+ req_unmarshal ,
+
+ void *(*)(void *)
+ rpl_new ,
+
+ void *
+ rpl_new_arg ,
+
+ void(*)(void *)
+ rpl_free ,
+
+ int(*)(void *)
+ rpl_complete ,
+
+ void(*)(struct evbuffer *, void *)
+ rpl_marshal
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_register_rpc
+ (
+ struct evrpc_base *
+ ,
+
+
+ struct evrpc *
+ ,
+
+
+ void(*)(struct evrpc_req_generic *, void *)
+ ,
+
+
+ void *
+
+
+
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_remove_hook
+ (
+ void *
+ vbase ,
+
+ enum EVRPC_HOOK_TYPE
+ hook_type ,
+
+ void *
+ handle
+
+ )
+
+
+
+
+
removes a previously added hook
+
Parameters
+
+ vbase a pointer to either struct evrpc_base or struct evrpc_pool hook_type either INPUT or OUTPUT handle a handle returned by evrpc_add_hook()
+
+
+
Returns 1 on success or 0 on failure
+
See also evrpc_add_hook()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_resume_request
+ (
+ void *
+ vbase ,
+
+ void *
+ ctx ,
+
+ enum EVRPC_HOOK_RESULT
+ res
+
+ )
+
+
+
+
+
resume a paused request
+
Parameters
+
+ vbase a pointer to either struct evrpc_base or struct evrpc_pool ctx the context pointer provided to the original hook call
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evrpc_send_request_generic
+ (
+ struct evrpc_pool *
+ pool ,
+
+ void *
+ request ,
+
+ void *
+ reply ,
+
+ void(*)(struct evrpc_status *, void *, void *, void *)
+ cb ,
+
+ void *
+ cb_arg ,
+
+ const char *
+ rpcname ,
+
+ void(*)(struct evbuffer *, void *)
+ req_marshal ,
+
+ void(*)(void *)
+ rpl_clear ,
+
+ int(*)(void *, struct evbuffer *)
+ rpl_unmarshal
+
+ )
+
+
+
+
+
EVENT2_EXPORT_SYMBOL struct evrpc_request_wrapper * evrpc_make_request_ctx(struct evrpc_pool *pool, void *request, void *reply, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *), void(*cb)(struct evrpc_status *, void *, void *, void *), void *cbarg)
use EVRPC_GENERATE instead
EVENT2_EXPORT_SYMBOL int evrpc_register_generic(struct evrpc_base *base, const char *name, void(*callback)(struct evrpc_req_generic *, void *), void *cbarg, void *(*req_new)(void *), void *req_new_arg, void(*req_free)(void *), int(*req_unmarshal)(void *, struct evbuffer *), void *(*rpl_new)(void *), void *rpl_new_arg, void(*rpl_free)(void *), int(*rpl_complete)(void *), void(*rpl_marshal)(struct evbuffer *, void *))
Function for registering a generic RPC with the RPC base.
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
EVENT2_EXPORT_SYMBOL int evrpc_send_request_generic(struct evrpc_pool *pool, void *request, void *reply, void(*cb)(struct evrpc_status *, void *, void *, void *), void *cb_arg, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *))
Function for sending a generic RPC request.
#define EVRPC_STRUCT(rpcname)
The type of a specific RPC Message.
Definition: rpc.h:159
libevent: event2/rpc.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_RPC_H_INCLUDED_
+
28 #define EVENT2_RPC_H_INCLUDED_
+
+
+
+
32 #include <event2/visibility.h>
+
+
+
+
+
+
80 #define EVTAG_HAS(msg, member) \
+
81 ((msg)->member##_set == 1)
+
+
83 #ifndef EVENT2_RPC_COMPAT_H_INCLUDED_
+
+
92 #define EVTAG_ASSIGN(msg, member, value) \
+
93 (*(msg)->base->member##_assign)((msg), (value))
+
+
102 #define EVTAG_ASSIGN_WITH_LEN(msg, member, value, len) \
+
103 (*(msg)->base->member##_assign)((msg), (value), (len))
+
+
112 #define EVTAG_GET(msg, member, pvalue) \
+
113 (*(msg)->base->member##_get)((msg), (pvalue))
+
+
123 #define EVTAG_GET_WITH_LEN(msg, member, pvalue, plen) \
+
124 (*(msg)->base->member##_get)((msg), (pvalue), (plen))
+
+
+
+
131 #define EVTAG_ARRAY_ADD_VALUE(msg, member, value) \
+
132 (*(msg)->base->member##_add)((msg), (value))
+
+
136 #define EVTAG_ARRAY_ADD(msg, member) \
+
137 (*(msg)->base->member##_add)(msg)
+
+
141 #define EVTAG_ARRAY_GET(msg, member, offset, pvalue) \
+
142 (*(msg)->base->member##_get)((msg), (offset), (pvalue))
+
+
146 #define EVTAG_ARRAY_LEN(msg, member) ((msg)->member##_length)
+
+
+
+
+
151 struct evrpc_req_generic;
+
152 struct evrpc_request_wrapper;
+
+
+
159 #define EVRPC_STRUCT(rpcname) struct evrpc_req__##rpcname
+
+
161 struct evhttp_request;
+
+
163 struct evrpc_hook_meta;
+
+
176 #define EVRPC_HEADER(rpcname, reqstruct, rplystruct) \
+
177 EVRPC_STRUCT(rpcname) { \
+
178 struct evrpc_hook_meta *hook_meta; \
+
179 struct reqstruct* request; \
+
180 struct rplystruct* reply; \
+
+
182 struct evhttp_request* http_req; \
+
183 struct evbuffer* rpc_data; \
+
+
185 EVENT2_EXPORT_SYMBOL \
+
186 int evrpc_send_request_##rpcname(struct evrpc_pool *, \
+
187 struct reqstruct *, struct rplystruct *, \
+
188 void (*)(struct evrpc_status *, \
+
189 struct reqstruct *, struct rplystruct *, void *cbarg), \
+
+
+
+
+
+
+
197 struct evrpc_pool *pool,
void *request,
void *reply,
+
+
199 void (*req_marshal)(
struct evbuffer *,
void *),
+
200 void (*rpl_clear)(
void *),
+
201 int (*rpl_unmarshal)(
void *,
struct evbuffer *),
+
202 void (*cb)(
struct evrpc_status *,
void *,
void *,
void *),
+
+
+
219 #define EVRPC_MAKE_CTX(rpcname, reqstruct, rplystruct, \
+
220 pool, request, reply, cb, cbarg) \
+
221 evrpc_make_request_ctx(pool, request, reply, \
+
+
223 (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \
+
224 (void (*)(void *))rplystruct##_clear, \
+
225 (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal, \
+
226 (void (*)(struct evrpc_status *, void *, void *, void *))cb, \
+
+
+
239 #define EVRPC_GENERATE(rpcname, reqstruct, rplystruct) \
+
240 int evrpc_send_request_##rpcname(struct evrpc_pool *pool, \
+
241 struct reqstruct *request, struct rplystruct *reply, \
+
242 void (*cb)(struct evrpc_status *, \
+
243 struct reqstruct *, struct rplystruct *, void *cbarg), \
+
+
245 return evrpc_send_request_generic(pool, request, reply, \
+
246 (void (*)(struct evrpc_status *, void *, void *, void *))cb, \
+
+
+
249 (void (*)(struct evbuffer *, void *))reqstruct##_marshal, \
+
250 (void (*)(void *))rplystruct##_clear, \
+
251 (int (*)(void *, struct evbuffer *))rplystruct##_unmarshal); \
+
+
+
263 #define EVRPC_REQUEST_HTTP(rpc_req) (rpc_req)->http_req
+
+
+
+
+
+
+
+
273 void *evrpc_get_reply(
struct evrpc_req_generic *req);
+
+
283 #define EVRPC_REQUEST_DONE(rpc_req) do { \
+
284 struct evrpc_req_generic *req_ = (struct evrpc_req_generic *)(rpc_req); \
+
285 evrpc_request_done(req_); \
+
+
+
+
+
+
+
+
+
+
301 struct evrpc_base *
evrpc_init (
struct evhttp *server);
+
+
+
+
+
330 #define EVRPC_REGISTER(base, name, request, reply, callback, cbarg) \
+
331 evrpc_register_generic(base, #name, \
+
332 (void (*)(struct evrpc_req_generic *, void *))callback, cbarg, \
+
333 (void *(*)(void *))request##_new_with_arg, NULL, \
+
334 (void (*)(void *))request##_free, \
+
335 (int (*)(void *, struct evbuffer *))request##_unmarshal, \
+
336 (void *(*)(void *))reply##_new_with_arg, NULL, \
+
337 (void (*)(void *))reply##_free, \
+
338 (int (*)(void *))reply##_complete, \
+
339 (void (*)(struct evbuffer *, void *))reply##_marshal)
+
+
+
+
350 void (*)(
struct evrpc_req_generic*,
void *),
void *);
+
+
360 #define EVRPC_UNREGISTER(base, name) evrpc_unregister_rpc((base), #name)
+
+
+
363 int evrpc_unregister_rpc(
struct evrpc_base *base,
const char *name);
+
+
+
+
+
+
369 struct evhttp_connection;
+
+
+
387 #define EVRPC_MAKE_REQUEST(name, pool, request, reply, cb, cbarg) \
+
388 evrpc_send_request_##name((pool), (request), (reply), (cb), (cbarg))
+
+
+
+
+
+
+
+
+
+
+
+
435 struct evhttp_connection *evcon);
+
+
+
+
447 struct evhttp_connection *evcon);
+
+
+
+
+
+
+
+
+
+
+
+
480 #define INPUT EVRPC_INPUT
+
+
483 #define OUTPUT EVRPC_OUTPUT
+
+
+
+
+
+
+
+
+
+
+
+
515 int (*cb)(
void *,
struct evhttp_request *,
struct evbuffer *,
void *),
+
+
+
+
+
+
+
+
+
+
+
+
+
553 const void *data,
size_t data_size);
+
+
+
+
567 void **data,
size_t *data_size);
+
+
+
+
+
+
+
588 void *request,
void *reply,
+
589 void (*cb)(
struct evrpc_status *,
void *,
void *,
void *),
+
+
+
592 void (*req_marshal)(
struct evbuffer *,
void *),
+
593 void (*rpl_clear)(
void *),
+
594 int (*rpl_unmarshal)(
void *,
struct evbuffer *));
+
+
+
+
605 void (*callback)(
struct evrpc_req_generic *,
void *),
void *cbarg,
+
606 void *(*req_new)(
void *),
void *req_new_arg,
void (*req_free)(
void *),
+
607 int (*req_unmarshal)(
void *,
struct evbuffer *),
+
608 void *(*rpl_new)(
void *),
void *rpl_new_arg,
void (*rpl_free)(
void *),
+
609 int (*rpl_complete)(
void *),
+
610 void (*rpl_marshal)(
struct evbuffer *,
void *));
+
+
+
+
+
616 void evrpc_request_set_pool(
struct evrpc_request_wrapper *ctx,
+
617 struct evrpc_pool *pool);
+
+
619 void evrpc_request_set_cb(
struct evrpc_request_wrapper *ctx,
+
620 void (*cb)(
struct evrpc_status*,
void *request,
void *reply,
void *arg),
+
+
+
+
+
+
+
+
@ EVRPC_TERMINATE
indicates the rpc should be terminated
Definition: rpc.h:491
EVENT2_EXPORT_SYMBOL void evrpc_request_done(struct evrpc_req_generic *req)
completes the server response to an rpc request
EVENT2_EXPORT_SYMBOL void evrpc_pool_set_timeout(struct evrpc_pool *pool, int timeout_in_secs)
Sets the timeout in secs after which a request has to complete.
@ EVRPC_INPUT
apply the function to an input hook
Definition: rpc.h:473
EVENT2_EXPORT_SYMBOL struct evrpc_request_wrapper * evrpc_make_request_ctx(struct evrpc_pool *pool, void *request, void *reply, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *), void(*cb)(struct evrpc_status *, void *, void *, void *), void *cbarg)
use EVRPC_GENERATE instead
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL int evrpc_hook_find_meta(void *ctx, const char *key, void **data, size_t *data_size)
retrieves meta data previously associated
EVRPC_HOOK_RESULT
Return value from hook processing functions.
Definition: rpc.h:490
@ EVRPC_CONTINUE
continue processing the rpc
Definition: rpc.h:492
EVENT2_EXPORT_SYMBOL int evrpc_remove_hook(void *vbase, enum EVRPC_HOOK_TYPE hook_type, void *handle)
removes a previously added hook
EVENT2_EXPORT_SYMBOL void evrpc_pool_remove_connection(struct evrpc_pool *pool, struct evhttp_connection *evcon)
Removes a connection from the pool.
EVENT2_EXPORT_SYMBOL int evrpc_register_generic(struct evrpc_base *base, const char *name, void(*callback)(struct evrpc_req_generic *, void *), void *cbarg, void *(*req_new)(void *), void *req_new_arg, void(*req_free)(void *), int(*req_unmarshal)(void *, struct evbuffer *), void *(*rpl_new)(void *), void *rpl_new_arg, void(*rpl_free)(void *), int(*rpl_complete)(void *), void(*rpl_marshal)(struct evbuffer *, void *))
Function for registering a generic RPC with the RPC base.
EVENT2_EXPORT_SYMBOL void * evrpc_add_hook(void *vbase, enum EVRPC_HOOK_TYPE hook_type, int(*cb)(void *, struct evhttp_request *, struct evbuffer *, void *), void *cb_arg)
adds a processing hook to either an rpc base or rpc pool
EVENT2_EXPORT_SYMBOL void evrpc_pool_free(struct evrpc_pool *pool)
frees an rpc connection pool
EVENT2_EXPORT_SYMBOL int evrpc_hook_add_meta(void *ctx, const char *key, const void *data, size_t data_size)
adds meta data to request
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
EVENT2_EXPORT_SYMBOL struct evrpc_pool * evrpc_pool_new(struct event_base *base)
creates an rpc connection pool
EVENT2_EXPORT_SYMBOL int evrpc_make_request(struct evrpc_request_wrapper *ctx)
Makes an RPC request based on the provided context.
EVENT2_EXPORT_SYMBOL struct evrpc_pool * evrpc_request_get_pool(struct evrpc_request_wrapper *ctx)
accessors for obscure and undocumented functionality
EVENT2_EXPORT_SYMBOL void evrpc_free(struct evrpc_base *base)
Frees the evrpc base.
EVENT2_EXPORT_SYMBOL int evrpc_resume_request(void *vbase, void *ctx, enum EVRPC_HOOK_RESULT res)
resume a paused request
@ EVRPC_OUTPUT
apply the function to an output hook
Definition: rpc.h:474
EVENT2_EXPORT_SYMBOL int evrpc_send_request_generic(struct evrpc_pool *pool, void *request, void *reply, void(*cb)(struct evrpc_status *, void *, void *, void *), void *cb_arg, const char *rpcname, void(*req_marshal)(struct evbuffer *, void *), void(*rpl_clear)(void *), int(*rpl_unmarshal)(void *, struct evbuffer *))
Function for sending a generic RPC request.
@ EVRPC_PAUSE
pause processing request until resumed
Definition: rpc.h:493
EVENT2_EXPORT_SYMBOL struct evhttp_connection * evrpc_hook_get_connection(void *ctx)
returns the connection object associated with the request
EVENT2_EXPORT_SYMBOL struct evrpc_base * evrpc_init(struct evhttp *server)
Creates a new rpc base from which RPC requests can be received.
EVENT2_EXPORT_SYMBOL void evrpc_pool_add_connection(struct evrpc_pool *pool, struct evhttp_connection *evcon)
Adds a connection over which rpc can be dispatched to the pool.
EVENT2_EXPORT_SYMBOL void * evrpc_get_request(struct evrpc_req_generic *req)
accessors for request and reply
EVENT2_EXPORT_SYMBOL int evrpc_register_rpc(struct evrpc_base *, struct evrpc *, void(*)(struct evrpc_req_generic *, void *), void *)
Low level function for registering an RPC with a server.
Common convenience functions for cross-platform portability and related socket manipulations.
EVRPC_HOOK_TYPE
Hooks for changing the input and output of RPCs; this can be used to implement compression,...
Definition: rpc.h:472
libevent: event2/rpc_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Deprecated versions of the functions in rpc.h : provided only for backwards compatibility.
+More...
+
+
Go to the source code of this file.
+
+EVTAG_LEN (msg, member) ((msg)->member##_length) backwards compatible accessors that work only with gcc
+
+
Deprecated versions of the functions in rpc.h : provided only for backwards compatibility.
+
libevent: event2/rpc_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_RPC_COMPAT_H_INCLUDED_
+
28 #define EVENT2_RPC_COMPAT_H_INCLUDED_
+
+
+
+
+
+
42 #if defined(__GNUC__) && !defined(__STRICT_ANSI__)
+
+
+
+
+
+
48 #define EVTAG_ASSIGN(msg, member, args...) \
+
49 (*(msg)->base->member##_assign)(msg, ## args)
+
50 #define EVTAG_GET(msg, member, args...) \
+
51 (*(msg)->base->member##_get)(msg, ## args)
+
52 #define EVTAG_ADD(msg, member, args...) \
+
53 (*(msg)->base->member##_add)(msg, ## args)
+
+
55 #define EVTAG_LEN(msg, member) ((msg)->member##_length)
+
+
+
+
+
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
do a search
+ {
+ this.Search();
+ }
+ }
+
+ this.OnSearchSelectKey = function(evt)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==40 && this.searchIndex0) // Up
+ {
+ this.searchIndex--;
+ this.OnSelectItem(this.searchIndex);
+ }
+ else if (e.keyCode==13 || e.keyCode==27)
+ {
+ this.OnSelectItem(this.searchIndex);
+ this.CloseSelectionWindow();
+ this.DOMSearchField().focus();
+ }
+ return false;
+ }
+
+ // --------- Actions
+
+ // Closes the results window.
+ this.CloseResultsWindow = function()
+ {
+ this.DOMPopupSearchResultsWindow().style.display = 'none';
+ this.DOMSearchClose().style.display = 'none';
+ this.Activate(false);
+ }
+
+ this.CloseSelectionWindow = function()
+ {
+ this.DOMSearchSelectWindow().style.display = 'none';
+ }
+
+ // Performs a search.
+ this.Search = function()
+ {
+ this.keyTimeout = 0;
+
+ // strip leading whitespace
+ var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
+
+ var code = searchValue.toLowerCase().charCodeAt(0);
+ var idxChar = searchValue.substr(0, 1).toLowerCase();
+ if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair
+ {
+ idxChar = searchValue.substr(0, 2);
+ }
+
+ var resultsPage;
+ var resultsPageWithSearch;
+ var hasResultsPage;
+
+ var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar);
+ if (idx!=-1)
+ {
+ var hexCode=idx.toString(16);
+ resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
+ resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
+ hasResultsPage = true;
+ }
+ else // nothing available for this search term
+ {
+ resultsPage = this.resultsPath + '/nomatches.html';
+ resultsPageWithSearch = resultsPage;
+ hasResultsPage = false;
+ }
+
+ window.frames.MSearchResults.location = resultsPageWithSearch;
+ var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
+
+ if (domPopupSearchResultsWindow.style.display!='block')
+ {
+ var domSearchBox = this.DOMSearchBox();
+ this.DOMSearchClose().style.display = 'inline';
+ if (this.insideFrame)
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ domPopupSearchResultsWindow.style.position = 'relative';
+ domPopupSearchResultsWindow.style.display = 'block';
+ var width = document.body.clientWidth - 8; // the -8 is for IE :-(
+ domPopupSearchResultsWindow.style.width = width + 'px';
+ domPopupSearchResults.style.width = width + 'px';
+ }
+ else
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth;
+ var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1;
+ domPopupSearchResultsWindow.style.display = 'block';
+ left -= domPopupSearchResults.offsetWidth;
+ domPopupSearchResultsWindow.style.top = top + 'px';
+ domPopupSearchResultsWindow.style.left = left + 'px';
+ }
+ }
+
+ this.lastSearchValue = searchValue;
+ this.lastResultsPage = resultsPage;
+ }
+
+ // -------- Activation Functions
+
+ // Activates or deactivates the search panel, resetting things to
+ // their default values if necessary.
+ this.Activate = function(isActive)
+ {
+ if (isActive || // open it
+ this.DOMPopupSearchResultsWindow().style.display == 'block'
+ )
+ {
+ this.DOMSearchBox().className = 'MSearchBoxActive';
+
+ var searchField = this.DOMSearchField();
+
+ if (searchField.value == this.searchLabel) // clear "Search" term upon entry
+ {
+ searchField.value = '';
+ this.searchActive = true;
+ }
+ }
+ else if (!isActive) // directly remove the panel
+ {
+ this.DOMSearchBox().className = 'MSearchBoxInactive';
+ this.DOMSearchField().value = this.searchLabel;
+ this.searchActive = false;
+ this.lastSearchValue = ''
+ this.lastResultsPage = '';
+ }
+ }
+}
+
+// -----------------------------------------------------------------------
+
+// The class that handles everything on the search results page.
+function SearchResults(name)
+{
+ // The number of matches from the last run of .
+ this.lastMatchCount = 0;
+ this.lastKey = 0;
+ this.repeatOn = false;
+
+ // Toggles the visibility of the passed element ID.
+ this.FindChildElement = function(id)
+ {
+ var parentElement = document.getElementById(id);
+ var element = parentElement.firstChild;
+
+ while (element && element!=parentElement)
+ {
+ if (element.nodeName == 'DIV' && element.className == 'SRChildren')
+ {
+ return element;
+ }
+
+ if (element.nodeName == 'DIV' && element.hasChildNodes())
+ {
+ element = element.firstChild;
+ }
+ else if (element.nextSibling)
+ {
+ element = element.nextSibling;
+ }
+ else
+ {
+ do
+ {
+ element = element.parentNode;
+ }
+ while (element && element!=parentElement && !element.nextSibling);
+
+ if (element && element!=parentElement)
+ {
+ element = element.nextSibling;
+ }
+ }
+ }
+ }
+
+ this.Toggle = function(id)
+ {
+ var element = this.FindChildElement(id);
+ if (element)
+ {
+ if (element.style.display == 'block')
+ {
+ element.style.display = 'none';
+ }
+ else
+ {
+ element.style.display = 'block';
+ }
+ }
+ }
+
+ // Searches for the passed string. If there is no parameter,
+ // it takes it from the URL query.
+ //
+ // Always returns true, since other documents may try to call it
+ // and that may or may not be possible.
+ this.Search = function(search)
+ {
+ if (!search) // get search word from URL
+ {
+ search = window.location.search;
+ search = search.substring(1); // Remove the leading '?'
+ search = unescape(search);
+ }
+
+ search = search.replace(/^ +/, ""); // strip leading spaces
+ search = search.replace(/ +$/, ""); // strip trailing spaces
+ search = search.toLowerCase();
+ search = convertToId(search);
+
+ var resultRows = document.getElementsByTagName("div");
+ var matches = 0;
+
+ var i = 0;
+ while (i < resultRows.length)
+ {
+ var row = resultRows.item(i);
+ if (row.className == "SRResult")
+ {
+ var rowMatchName = row.id.toLowerCase();
+ rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
+
+ if (search.length<=rowMatchName.length &&
+ rowMatchName.substr(0, search.length)==search)
+ {
+ row.style.display = 'block';
+ matches++;
+ }
+ else
+ {
+ row.style.display = 'none';
+ }
+ }
+ i++;
+ }
+ document.getElementById("Searching").style.display='none';
+ if (matches == 0) // no results
+ {
+ document.getElementById("NoMatches").style.display='block';
+ }
+ else // at least one result
+ {
+ document.getElementById("NoMatches").style.display='none';
+ }
+ this.lastMatchCount = matches;
+ return true;
+ }
+
+ // return the first item with index index or higher that is visible
+ this.NavNext = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index++;
+ }
+ return focusItem;
+ }
+
+ this.NavPrev = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index--;
+ }
+ return focusItem;
+ }
+
+ this.ProcessKeys = function(e)
+ {
+ if (e.type == "keydown")
+ {
+ this.repeatOn = false;
+ this.lastKey = e.keyCode;
+ }
+ else if (e.type == "keypress")
+ {
+ if (!this.repeatOn)
+ {
+ if (this.lastKey) this.repeatOn = true;
+ return false; // ignore first keypress after keydown
+ }
+ }
+ else if (e.type == "keyup")
+ {
+ this.lastKey = 0;
+ this.repeatOn = false;
+ }
+ return this.lastKey!=0;
+ }
+
+ this.Nav = function(evt,itemIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ var newIndex = itemIndex-1;
+ var focusItem = this.NavPrev(newIndex);
+ if (focusItem)
+ {
+ var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
+ if (child && child.style.display == 'block') // children visible
+ {
+ var n=0;
+ var tmpElem;
+ while (1) // search for last child
+ {
+ tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
+ if (tmpElem)
+ {
+ focusItem = tmpElem;
+ }
+ else // found it!
+ {
+ break;
+ }
+ n++;
+ }
+ }
+ }
+ if (focusItem)
+ {
+ focusItem.focus();
+ }
+ else // return focus to search field
+ {
+ parent.document.getElementById("MSearchField").focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = itemIndex+1;
+ var focusItem;
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem && elem.style.display == 'block') // children visible
+ {
+ focusItem = document.getElementById('Item'+itemIndex+'_c0');
+ }
+ if (!focusItem) focusItem = this.NavNext(newIndex);
+ if (focusItem) focusItem.focus();
+ }
+ else if (this.lastKey==39) // Right
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'block';
+ }
+ else if (this.lastKey==37) // Left
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'none';
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+
+ this.NavChild = function(evt,itemIndex,childIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ if (childIndex>0)
+ {
+ var newIndex = childIndex-1;
+ document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
+ }
+ else // already at first child, jump to parent
+ {
+ document.getElementById('Item'+itemIndex).focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = childIndex+1;
+ var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
+ if (!elem) // last child, jump to parent next parent
+ {
+ elem = this.NavNext(itemIndex+1);
+ }
+ if (elem)
+ {
+ elem.focus();
+ }
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+}
+
+function setKeyActions(elem,action)
+{
+ elem.setAttribute('onkeydown',action);
+ elem.setAttribute('onkeypress',action);
+ elem.setAttribute('onkeyup',action);
+}
+
+function setClassAttr(elem,attr)
+{
+ elem.setAttribute('class',attr);
+ elem.setAttribute('className',attr);
+}
+
+function createResults()
+{
+ var results = document.getElementById("SRResults");
+ for (var e=0; e
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
libevent: bufferevent Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An opaque type for handling buffered IO.
+ More...
+
+
#include <bufferevent.h >
+
+
An opaque type for handling buffered IO.
+
See also event2/bufferevent.h
+
The documentation for this struct was generated from the following file:
+
libevent: evbuffer Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the network.
+ More...
+
+
#include <buffer.h >
+
+
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the network.
+
See also event2/event.h for more information
+
The documentation for this struct was generated from the following file:
+
libevent: evbuffer_cb_info Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Structure passed to an evbuffer_cb_func evbuffer callback.
+ More...
+
+
#include <buffer.h >
+
+n_added The number of bytes added since callbacks were last invoked. n_deleted The number of bytes removed since callbacks were last invoked. orig_size The number of bytes in this evbuffer when callbacks were last invoked.
+
+
Structure passed to an evbuffer_cb_func evbuffer callback.
+
See also evbuffer_cb_func , evbuffer_add_cb()
+
The documentation for this struct was generated from the following file:
+
libevent: evbuffer_iovec Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a single extent of memory inside an evbuffer.
+ More...
+
+
#include <buffer.h >
+
+iov_base The start of the extent of memory. iov_len The length of the extent of memory.
+
+
Describes a single extent of memory inside an evbuffer.
+
Used for direct-access functions.
+
See also evbuffer_reserve_space , evbuffer_commit_space , evbuffer_peek
+
The documentation for this struct was generated from the following file:
+
libevent: evbuffer_ptr Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Pointer to a position within an evbuffer.
+ More...
+
+
#include <buffer.h >
+
+
+ void * chain
+ size_t pos_in_chain } internal_ pos
+
+
Pointer to a position within an evbuffer.
+
Used when repeatedly searching through a buffer. Calling any function that modifies or re-packs the buffer contents may invalidate all evbuffer_ptrs for that buffer. Do not modify or contruct these values except with evbuffer_ptr_set.
+
An evbuffer_ptr can represent any position from the start of a buffer up to a position immediately after the end of a buffer.
+
See also evbuffer_ptr_set()
+
The documentation for this struct was generated from the following file:
+
libevent: event Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Structure to represent a single event.
+ More...
+
+
#include <event.h >
+
+
Structure to represent a single event.
+
An event can have some underlying condition it represents: a socket becoming readable or writeable (or both), or a signal becoming raised. (An event that represents no underlying condition is still useful: you can use one to implement a timer, or to communicate between threads.)
+
Generally, you can create events with event_new() , then make them pending with event_add() . As your event_base runs, it will run the callbacks of an events whose conditions are triggered. When you no longer want the event, free it with event_free() .
+
In more depth:
+
An event may be "pending" (one whose condition we are watching), "active" (one whose condition has triggered and whose callback is about to run), neither, or both. Events come into existence via event_assign() or event_new() , and are then neither active nor pending.
+
To make an event pending, pass it to event_add() . When doing so, you can also set a timeout for the event.
+
Events become active during an event_base_loop() call when either their condition has triggered, or when their timeout has elapsed. You can also activate an event manually using event_active() . The even_base loop will run the callbacks of active events; after it has done so, it marks them as no longer active.
+
You can make an event non-pending by passing it to event_del() . This also makes the event non-active.
+
Events can be "persistent" or "non-persistent". A non-persistent event becomes non-pending as soon as it is triggered: thus, it only runs at most once per call to event_add() . A persistent event remains pending even when it becomes active: you'll need to event_del() it manually in order to make it non-pending. When a persistent event with a timeout becomes active, its timeout is reset: this means you can use persistent events to implement periodic timeouts.
+
This should be treated as an opaque structure; you should never read or write any of its fields directly. For backward compatibility with old code, it is defined in the event2/event_struct.h header; including this header may make your code incompatible with other versions of Libevent.
+
See also event_new() , event_free() , event_assign() , event_get_assignment() , event_add() , event_del() , event_active() , event_pending() , event_get_fd() , event_get_base() , event_get_events() , event_get_callback() , event_get_callback_arg() , event_priority_set()
+
The documentation for this struct was generated from the following file:
+
libevent: event_base Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Structure to hold information and state for a Libevent dispatch loop.
+ More...
+
+
#include <event.h >
+
+
Structure to hold information and state for a Libevent dispatch loop.
+
The event_base lies at the center of Libevent; every application will have one. It keeps track of all pending and active events, and notifies your application of the active ones.
+
This is an opaque structure; you can allocate one using event_base_new() or event_base_new_with_config() .
+
See also event_base_new() , event_base_free() , event_base_loop() , event_base_new_with_config()
+
The documentation for this struct was generated from the following file:
+
libevent: event_config Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Configuration for an event_base .
+ More...
+
+
#include <event.h >
+
+
Configuration for an event_base .
+
There are many options that can be used to alter the behavior and implementation of an event_base . To avoid having to pass them all in a complex many-argument constructor, we provide an abstract data type where you set up configuration information before passing it to event_base_new_with_config() .
+
See also event_config_new() , event_config_free() , event_base_new_with_config() , event_config_avoid_method() , event_config_require_features() , event_config_set_flag() , event_config_set_num_cpus_hint()
+
The documentation for this struct was generated from the following file:
+
libevent: evhttp_ext_method Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
stucture that is passed to (and modified by) the extended method callback function
+ More...
+
+
#include <http.h >
+
+flags method type
+
+
stucture that is passed to (and modified by) the extended method callback function
+
See also evhttp_set_ext_method_cmp
+evhttp_connection_set_ext_method_cmp
+
The documentation for this struct was generated from the following file:
+
libevent: evthread_condition_callbacks Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This structure describes the interface a threading library uses for condition variables.
+ More...
+
+
#include <thread.h >
+
+
+
This structure describes the interface a threading library uses for condition variables.
+
It's used to tell evthread_set_condition_callbacks how to use locking on this platform.
+
+
+
◆
+
+
+
+
+
+ void*(* evthread_condition_callbacks::alloc_condition) (unsigned condtype)
+
+
+
+
+
Function to allocate and initialize a new condition variable.
+
Returns the condition variable on success, and NULL on failure. The 'condtype' argument will be 0 with this API version.
+
+
+
+
+
◆
+
+
+
+
+
+ int evthread_condition_callbacks::condition_api_version
+
+
+
+
+
The current version of the conditions API.
+
Set this to EVTHREAD_CONDITION_API_VERSION
+
+
+
+
+
◆
+
+
+
+
+
+ int(* evthread_condition_callbacks::signal_condition) (void *cond, int broadcast)
+
+
+
+
+
Function to signal a condition variable.
+
If 'broadcast' is 1, all threads waiting on 'cond' should be woken; otherwise, only on one thread is worken. Should return 0 on success, -1 on failure. This function will only be called while holding the associated lock for the condition.
+
+
+
+
+
◆
+
+
+
+
+
+ int(* evthread_condition_callbacks::wait_condition) (void *cond, void *lock, const struct timeval *timeout)
+
+
+
+
+
Function to wait for a condition variable.
+
The lock 'lock' will be held when this function is called; should be released while waiting for the condition to be come signalled, and should be held again when this function returns. If timeout is provided, it is interval of seconds to wait for the event to become signalled; if it is NULL, the function should wait indefinitely.
+
The function should return -1 on error; 0 if the condition was signalled, or 1 on a timeout.
+
+
+
+
The documentation for this struct was generated from the following file:
+
libevent: evthread_lock_callbacks Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This structure describes the interface a threading library uses for locking.
+ More...
+
+
#include <thread.h >
+
+void *(* alloc )(unsigned locktype) Function to allocate and initialize new lock of type 'locktype'. More... free )(void *lock , unsigned locktype) Funtion to release all storage held in 'lock', which was created with type 'locktype'. int(* lock )(unsigned mode, void *lock) Acquire an already-allocated lock at 'lock' with mode 'mode'. More... int lock_api_version The current version of the locking API. More... unsigned supported_locktypes Which kinds of locks does this version of the locking API support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and EVTHREAD_LOCKTYPE_READWRITE. More... int(* unlock )(unsigned mode, void *lock ) Release a lock at 'lock' using mode 'mode'. More...
+
+
This structure describes the interface a threading library uses for locking.
+
It's used to tell evthread_set_lock_callbacks() how to use locking on this platform.
+
+
+
◆
+
+
+
+
+
+ void*(* evthread_lock_callbacks::alloc) (unsigned locktype)
+
+
+
+
+
Function to allocate and initialize new lock of type 'locktype'.
+
Returns NULL on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ int(* evthread_lock_callbacks::lock) (unsigned mode, void *lock)
+
+
+
+
+
Acquire an already-allocated lock at 'lock' with mode 'mode'.
+
Returns 0 on success, and nonzero on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ int evthread_lock_callbacks::lock_api_version
+
+
+
+
+
The current version of the locking API.
+
Set this to EVTHREAD_LOCK_API_VERSION
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned evthread_lock_callbacks::supported_locktypes
+
+
+
+
+
Which kinds of locks does this version of the locking API support? A bitfield of EVTHREAD_LOCKTYPE_RECURSIVE and EVTHREAD_LOCKTYPE_READWRITE.
+
(Note that RECURSIVE locks are currently mandatory, and READWRITE locks are not currently used.)
+
+
+
+
+
◆
+
+
+
+
+
+ int(* evthread_lock_callbacks::unlock) (unsigned mode, void *lock )
+
+
+
+
+
Release a lock at 'lock' using mode 'mode'.
+
Returns 0 on success, and nonzero on failure.
+
+
+
+
The documentation for this struct was generated from the following file:
+
libevent: evutil_addrinfo Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A definition of struct addrinfo for systems that lack it.
+ More...
+
+
#include <util.h >
+
+ai_addr ai_addrlen ai_canonname ai_family ai_flags evutil_addrinfo * ai_next ai_protocol ai_socktype
+
+
A definition of struct addrinfo for systems that lack it.
+
(This is just an alias for struct addrinfo if the system defines struct addrinfo.)
+
The documentation for this struct was generated from the following file:
+
libevent: evutil_monotonic_timer Struct Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Structure to hold information about a monotonic timer.
+ More...
+
+
#include <util.h >
+
+
The documentation for this struct was generated from the following file:
+
libevent: event2/tag.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Helper functions for reading and writing tagged data onto buffers.
+More...
+
#include <event2/visibility.h>
+
#include <event2/event-config.h>
+
#include <event2/util.h >
+
+
Go to the source code of this file.
+
+evtag_consume (struct evbuffer *evbuf) EVENT2_EXPORT_SYMBOL void evtag_encode_int (struct evbuffer *evbuf, ev_uint32_t number) Encode an integer and store it in an evbuffer. More... evtag_encode_int64 (struct evbuffer *evbuf, ev_uint64_t number) evtag_init (void) evtag_marshal (struct evbuffer *evbuf, ev_uint32_t tag, const void *data, ev_uint32_t len) evtag_marshal_buffer (struct evbuffer *evbuf, ev_uint32_t tag, struct evbuffer *data) evtag_marshal_int (struct evbuffer *evbuf, ev_uint32_t tag, ev_uint32_t integer) evtag_marshal_int64 (struct evbuffer *evbuf, ev_uint32_t tag, ev_uint64_t integer) evtag_marshal_string (struct evbuffer *buf, ev_uint32_t tag, const char *string) evtag_marshal_timeval (struct evbuffer *evbuf, ev_uint32_t tag, struct timeval *tv) evtag_payload_length (struct evbuffer *evbuf, ev_uint32_t *plength) evtag_peek (struct evbuffer *evbuf, ev_uint32_t *ptag) evtag_peek_length (struct evbuffer *evbuf, ev_uint32_t *plength) evtag_unmarshal (struct evbuffer *src, ev_uint32_t *ptag, struct evbuffer *dst) evtag_unmarshal_fixed (struct evbuffer *src, ev_uint32_t need_tag, void *data, size_t len) EVENT2_EXPORT_SYMBOL int evtag_unmarshal_header (struct evbuffer *evbuf, ev_uint32_t *ptag) Unmarshals the header and returns the length of the payload. More... evtag_unmarshal_int (struct evbuffer *evbuf, ev_uint32_t need_tag, ev_uint32_t *pinteger) evtag_unmarshal_int64 (struct evbuffer *evbuf, ev_uint32_t need_tag, ev_uint64_t *pinteger) evtag_unmarshal_string (struct evbuffer *evbuf, ev_uint32_t need_tag, char **pstring) evtag_unmarshal_timeval (struct evbuffer *evbuf, ev_uint32_t need_tag, struct timeval *ptv)
+
+
Helper functions for reading and writing tagged data onto buffers.
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evtag_encode_int
+ (
+ struct evbuffer *
+ evbuf ,
+
+ ev_uint32_t
+ number
+
+ )
+
+
+
+
+
Encode an integer and store it in an evbuffer.
+
We encode integers by nybbles; the first nibble contains the number of significant nibbles - 1; this allows us to encode up to 64-bit integers. This function is byte-order independent.
+
Parameters
+
+ evbuf evbuffer to store the encoded number number a 32-bit integer
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evtag_unmarshal_header
+ (
+ struct evbuffer *
+ evbuf ,
+
+ ev_uint32_t *
+ ptag
+
+ )
+
+
+
+
+
Unmarshals the header and returns the length of the payload.
+
Parameters
+
+ evbuf the buffer from which to unmarshal data ptag a pointer in which the tag id is being stored
+
+
+
Returns -1 on failure or the number of bytes in the remaining payload.
+
+
+
+
libevent: event2/tag.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_TAG_H_INCLUDED_
+
28 #define EVENT2_TAG_H_INCLUDED_
+
+
36 #include <event2/visibility.h>
+
+
+
+
+
+
42 #include <event2/event-config.h>
+
43 #ifdef EVENT__HAVE_SYS_TYPES_H
+
44 #include <sys/types.h>
+
+
46 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
62 void evtag_init(
void );
+
+
+
+
+
+
75 void evtag_marshal(
struct evbuffer *evbuf, ev_uint32_t tag,
const void *data,
+
+
+
78 void evtag_marshal_buffer(
struct evbuffer *evbuf, ev_uint32_t tag,
+
+
+
+
+
+
94 void evtag_encode_int64(
struct evbuffer *evbuf, ev_uint64_t number);
+
+
+
97 void evtag_marshal_int(
struct evbuffer *evbuf, ev_uint32_t tag,
+
+
+
100 void evtag_marshal_int64(
struct evbuffer *evbuf, ev_uint32_t tag,
+
101 ev_uint64_t integer);
+
+
+
104 void evtag_marshal_string(
struct evbuffer *buf, ev_uint32_t tag,
+
+
+
+
108 void evtag_marshal_timeval(
struct evbuffer *evbuf, ev_uint32_t tag,
+
+
+
+
112 int evtag_unmarshal(
struct evbuffer *src, ev_uint32_t *ptag,
+
+
+
115 int evtag_peek(
struct evbuffer *evbuf, ev_uint32_t *ptag);
+
+
117 int evtag_peek_length(
struct evbuffer *evbuf, ev_uint32_t *plength);
+
+
119 int evtag_payload_length(
struct evbuffer *evbuf, ev_uint32_t *plength);
+
+
121 int evtag_consume(
struct evbuffer *evbuf);
+
+
+
124 int evtag_unmarshal_int(
struct evbuffer *evbuf, ev_uint32_t need_tag,
+
125 ev_uint32_t *pinteger);
+
+
127 int evtag_unmarshal_int64(
struct evbuffer *evbuf, ev_uint32_t need_tag,
+
128 ev_uint64_t *pinteger);
+
+
+
131 int evtag_unmarshal_fixed(
struct evbuffer *src, ev_uint32_t need_tag,
+
132 void *data,
size_t len);
+
+
+
135 int evtag_unmarshal_string(
struct evbuffer *evbuf, ev_uint32_t need_tag,
+
+
+
+
139 int evtag_unmarshal_timeval(
struct evbuffer *evbuf, ev_uint32_t need_tag,
+
140 struct timeval *ptv);
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evtag_unmarshal_header(struct evbuffer *evbuf, ev_uint32_t *ptag)
Unmarshals the header and returns the length of the payload.
An evbuffer is an opaque data type for efficiently buffering data to be sent or received on the netwo...
Definition: buffer.h:97
EVENT2_EXPORT_SYMBOL void evtag_encode_int(struct evbuffer *evbuf, ev_uint32_t number)
Encode an integer and store it in an evbuffer.
Common convenience functions for cross-platform portability and related socket manipulations.
libevent: event2/tag_compat.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Obsolete/deprecated functions from tag.h ; provided only for backwards compatibility.
+More...
+
+
Go to the source code of this file.
+
+Deprecated: These macros are deprecated because their names don't follow Libevent's naming conventions.
+
Use evtag_encode_int and evtag_encode_int64 instead.
+
encode_int (evbuf, number) evtag_encode_int ((evbuf), (number)) encode_int64 (evbuf, number) evtag_encode_int64((evbuf), (number))
+
+
Obsolete/deprecated functions from tag.h ; provided only for backwards compatibility.
+
libevent: event2/tag_compat.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #ifndef EVENT2_TAG_COMPAT_H_INCLUDED_
+
28 #define EVENT2_TAG_COMPAT_H_INCLUDED_
+
+
45 #define encode_int(evbuf, number) evtag_encode_int((evbuf), (number))
+
46 #define encode_int64(evbuf, number) evtag_encode_int64((evbuf), (number))
+
+
+
libevent: event2/thread.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Functions for multi-threaded applications using Libevent.
+More...
+
#include <event2/visibility.h>#include <event2/event-config.h>
+
Go to the source code of this file.
+
+EVTHREAD_CONDITION_API_VERSION 1 EVTHREAD_LOCK_API_VERSION 1 EVTHREAD_PTHREAD_PRIO_INHERIT 0x01 EVTHREAD_USE_PTHREADS_IMPLEMENTED 1 Defined if Libevent was built with support for evthread_use_pthreads() EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1 Defined if Libevent was built with support for evthread_use_windows_threads() EVTHREAD_READ 0x08 A flag passed to a locking callback when the lock was allocated as a read-write lock, and we want to acquire or release the lock for reading. EVTHREAD_TRY 0x10 A flag passed to a locking callback when we don't want to block waiting for the lock; if we can't get the lock immediately, we will instead return nonzero from the locking callback. EVTHREAD_WRITE 0x04 A flag passed to a locking callback when the lock was allocated as a read-write lock, and we want to acquire or release the lock for writing. EVTHREAD_LOCKTYPE_READWRITE 2 #define EVTHREAD_LOCKTYPE_RECURSIVE 1 A recursive lock is one that can be acquired multiple times at once by the same thread. More...
+
+
Functions for multi-threaded applications using Libevent.
+
When using a multi-threaded application in which multiple threads add and delete events from a single event base, Libevent needs to lock its data structures.
+
Like the memory-management function hooks, all of the threading functions must be set up before an event_base is created if you want the base to use them.
+
Most programs will either be using Windows threads or Posix threads. You can configure Libevent to use one of these evthread_use_windows_threads() or evthread_use_pthreads() respectively. If you're using another threading library, you'll need to configure threading functions manually using evthread_set_lock_callbacks() and evthread_set_condition_callbacks() .
+
+
+
◆
+
+
+
+
+
+ #define EVTHREAD_LOCKTYPE_RECURSIVE 1
+
+
+
+
+
A recursive lock is one that can be acquired multiple times at once by the same thread.
+
No other process can allocate the lock until the thread that has been holding it has unlocked it as many times as it locked it.
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evthread_enable_lock_debugging
+ (
+ void
+ )
+
+
+
+
+
Enable debugging wrappers around the current lock callbacks.
+
If Libevent makes one of several common locking errors, exit with an assertion failure.
+
If you're going to call this function, you must do so before any locks are allocated.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evthread_make_base_notifiable
+ (
+ struct event_base *
+ base )
+
+
+
+
+
Make sure it's safe to tell an event base to wake up from another thread or a signal handler.
+
You shouldn't need to call this by hand; configuring the base with thread support should be necessary and sufficient.
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
Sets a group of functions that Libevent should use for condition variables.
+
For full information on the required callback API, see the documentation for the individual members of evthread_condition_callbacks .
+
Note that if you're using Windows or the Pthreads threading library, you probably shouldn't call this function; instead, use evthread_use_windows_threads() or evthread_use_pthreads() if you can.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evthread_set_id_callback
+ (
+ unsigned long(*)(void)
+ id_fn )
+
+
+
+
+
Sets the function for determining the thread id.
+
Parameters
+
+ id_fn the identify function Libevent should invoke to determine the identity of a thread.
+
+
+
+
+
+
+
◆
+
+
+
+
+
Sets a group of functions that Libevent should use for locking.
+
For full information on the required callback API, see the documentation for the individual members of evthread_lock_callbacks .
+
Note that if you're using Windows or the Pthreads threading library, you probably shouldn't call this function; instead, use evthread_use_windows_threads() or evthread_use_posix_threads() if you can.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evthread_use_pthreads
+ (
+ void
+ )
+
+
+
+
+
Sets up Libevent for use with Pthreads locking and thread ID functions.
+
Unavailable if Libevent is not build for use with pthreads. Requires libraries to link against Libevent_pthreads as well as Libevent.
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evthread_use_pthreads_with_flags
+ (
+ int
+ flags )
+
+
+
+
+
Sets up Libevent for use with Pthreads locking and thread ID functions.
+
Use evthread_use_pthreads_with_flags() to use Pthreads locking, taking the specified flags under consideration.
+
Parameters
+
+ flags the flags to apply when setting up Pthreads locking.
+
+
+
See also EVTHREAD_PTHREAD_*
+
Returns 0 on success, -1 on failure.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evthread_use_windows_threads
+ (
+ void
+ )
+
+
+
+
+
Sets up Libevent for use with Windows builtin locking and thread ID functions.
+
Unavailable if Libevent is not built for Windows.
+
Returns 0 on success, -1 on failure.
+
+
+
+
libevent: event2/thread.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #ifndef EVENT2_THREAD_H_INCLUDED_
+
27 #define EVENT2_THREAD_H_INCLUDED_
+
+
49 #include <event2/visibility.h>
+
+
+
+
+
+
55 #include <event2/event-config.h>
+
+
64 #define EVTHREAD_WRITE 0x04
+
+
67 #define EVTHREAD_READ 0x08
+
+
71 #define EVTHREAD_TRY 0x10
+
+
74 #if !defined(EVENT__DISABLE_THREAD_SUPPORT) || defined(EVENT_IN_DOXYGEN_)
+
+
76 #define EVTHREAD_LOCK_API_VERSION 1
+
+
85 #define EVTHREAD_LOCKTYPE_RECURSIVE 1
+
+
+
88 #define EVTHREAD_LOCKTYPE_READWRITE 2
+
+
+
+
+
109 void *(*alloc)(
unsigned locktype);
+
+
+
+
+
+
+
+
+
132 #define EVTHREAD_CONDITION_API_VERSION 1
+
+
+
+
+
+
148 void *(*alloc_condition)(
unsigned condtype);
+
+
+
+
169 const struct timeval *timeout);
+
+
+
+
+
+
+
+
+
192 unsigned long (*id_fn)(
void ));
+
+
194 #if (defined(_WIN32) && !defined(EVENT__DISABLE_THREAD_SUPPORT)) || defined(EVENT_IN_DOXYGEN_)
+
+
+
+
204 #define EVTHREAD_USE_WINDOWS_THREADS_IMPLEMENTED 1
+
+
+
207 #if defined(EVENT__HAVE_PTHREADS) || defined(EVENT_IN_DOXYGEN_)
+
+
+
+
+
+
+
218 #define EVTHREAD_PTHREAD_PRIO_INHERIT 0x01
+
+
+
+
+
232 #define EVTHREAD_USE_PTHREADS_IMPLEMENTED 1
+
+
+
+
+
+
+
+
+
+
248 void evthread_enable_lock_debuging(
void );
+
+
+
+
+
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL int evthread_set_lock_callbacks(const struct evthread_lock_callbacks *)
Sets a group of functions that Libevent should use for locking.
EVENT2_EXPORT_SYMBOL void evthread_enable_lock_debugging(void)
Enable debugging wrappers around the current lock callbacks.
This structure describes the interface a threading library uses for condition variables.
Definition: thread.h:140
EVENT2_EXPORT_SYMBOL void evthread_set_id_callback(unsigned long(*id_fn)(void))
Sets the function for determining the thread id.
int lock_api_version
The current version of the locking API.
Definition: thread.h:98
int(* lock)(unsigned mode, void *lock)
Acquire an already-allocated lock at 'lock' with mode 'mode'.
Definition: thread.h:115
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
int(* signal_condition)(void *cond, int broadcast)
Function to signal a condition variable.
Definition: thread.h:157
unsigned supported_locktypes
Which kinds of locks does this version of the locking API support? A bitfield of EVTHREAD_LOCKTYPE_RE...
Definition: thread.h:106
EVENT2_EXPORT_SYMBOL int evthread_set_condition_callbacks(const struct evthread_condition_callbacks *)
Sets a group of functions that Libevent should use for condition variables.
int(* wait_condition)(void *cond, void *lock, const struct timeval *timeout)
Function to wait for a condition variable.
Definition: thread.h:168
int(* unlock)(unsigned mode, void *lock)
Release a lock at 'lock' using mode 'mode'.
Definition: thread.h:118
EVENT2_EXPORT_SYMBOL int evthread_use_pthreads_with_flags(int flags)
Sets up Libevent for use with Pthreads locking and thread ID functions.
This structure describes the interface a threading library uses for locking.
Definition: thread.h:95
void(* free_condition)(void *cond)
Function to free a condition variable.
Definition: thread.h:150
int condition_api_version
The current version of the conditions API.
Definition: thread.h:143
EVENT2_EXPORT_SYMBOL int evthread_use_pthreads(void)
Sets up Libevent for use with Pthreads locking and thread ID functions.
void(* free)(void *lock, unsigned locktype)
Funtion to release all storage held in 'lock', which was created with type 'locktype'.
Definition: thread.h:112
EVENT2_EXPORT_SYMBOL int evthread_make_base_notifiable(struct event_base *base)
Make sure it's safe to tell an event base to wake up from another thread or a signal handler.
EVENT2_EXPORT_SYMBOL int evthread_use_windows_threads(void)
Sets up Libevent for use with Windows builtin locking and thread ID functions.
libevent: event2/util.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Common convenience functions for cross-platform portability and related socket manipulations.
+More...
+
#include <event2/visibility.h>#include <event2/event-config.h>#include <stdarg.h>#include <sys/socket.h>#include <time.h>
+
Go to the source code of this file.
+
+EV_MONOT_FALLBACK 2 EV_MONOT_PRECISE 1 ev_socklen_t socklen_t EVUTIL_CLOSESOCKET (s) evutil_closesocket (s) evutil_offsetof (type, field) ((off_t)(&((type *)0)->field)) Replacement for offsetof on platforms that don't define it. #define evutil_socket_t int A type wide enough to hold the output of "socket()" or "accept()". More... #define evutil_timercmp (tvp, uvp, cmp) Return true iff the tvp is related to uvp according to the relational operator cmp. More... evutil_timerisset (tvp) ((tvp)->tv_sec || (tvp)->tv_usec) Integer type definitions for types that are supposed to be defined in the C99-specified stdint.h.
+
Shamefully, some platforms do not include stdint.h, so we need to replace it. (If you are on a platform like this, your C headers are now over 10 years out of date. You should bug them to do something about this.)
+
We define:
+
+ev_uint64_t, ev_uint32_t, ev_uint16_t, ev_uint8_t
+unsigned integer types of exactly 64, 32, 16, and 8 bits respectively.
+ev_int64_t, ev_int32_t, ev_int16_t, ev_int8_t
+signed integer types of exactly 64, 32, 16, and 8 bits respectively.
+ev_uintptr_t, ev_intptr_t
+unsigned/signed integers large enough to hold a pointer without loss of bits.
+ev_ssize_t
+A signed type of the same size as size_t
+ev_off_t
+A signed type typically used to represent offsets within a (potentially large) file
+
+
ev_int16_t ... ev_int32_t ... ev_int64_t ... ev_int8_t ... ev_intptr_t ev_int32_t ev_off_t ... ev_ssize_t ssize_t ev_uint16_t ... ev_uint32_t ... ev_uint64_t ... ev_uint8_t ... ev_uintptr_t ev_uint32_t These macros hold the largest or smallest values possible for the ev_[u]int*_t types.
+
EV_INT16_MAX ((ev_int16_t) 0x7fffL) EV_INT16_MIN ((-EV_INT16_MAX) - 1) EV_INT32_MAX ((ev_int32_t) 0x7fffffffL) EV_INT32_MIN ((-EV_INT32_MAX) - 1) EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL) EV_INT64_MIN ((-EV_INT64_MAX) - 1) EV_INT8_MAX 127 EV_INT8_MIN ((-EV_INT8_MAX) - 1) EV_UINT16_MAX ((ev_uint16_t)0xffffUL) EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL) EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL) EV_UINT8_MAX 255 EV_SIZE_MAX ... EV_SSIZE_MAX ... EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1) These functions are needed for making programs compatible between Windows and Unix-like platforms.
+
You see, Winsock handles socket errors differently from the rest of the world. Elsewhere, a socket error is like any other error and is stored in errno. But winsock functions require you to retrieve the error with a special function, and don't let you use strerror for the error codes. And handling EWOULDBLOCK is ... different.
+
EVUTIL_INVALID_SOCKET -1 EVUTIL_SET_SOCKET_ERROR (errcode) ... Replace the most recent socket error with errcode. #define EVUTIL_SOCKET_ERROR () ... Return the most recent socket error. More... evutil_socket_error_to_string (errcode) ... Convert a socket error to a string. evutil_socket_geterror (sock) ... Return the most recent socket error to occur on sock. !_WIN32
+
We define replacements for timeradd, timersub, timerclear, timercmp, and timerisset.
+
#define evutil_timeradd (tvp, uvp, vvp) evutil_timerclear (tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0 #define evutil_timersub (tvp, uvp, vvp) These values are possible error codes for evutil_getaddrinfo() and related functions.
+
EVUTIL_AI_ADDRCONFIG 0x40000 EVUTIL_AI_ALL 0x20000 EVUTIL_AI_CANONNAME 0x2000 EVUTIL_AI_NUMERICHOST 0x4000 EVUTIL_AI_NUMERICSERV 0x8000 EVUTIL_AI_PASSIVE 0x1000 EVUTIL_AI_V4MAPPED 0x10000 EVUTIL_EAI_ADDRFAMILY -901 EVUTIL_EAI_AGAIN -902 EVUTIL_EAI_BADFLAGS -903 EVUTIL_EAI_CANCEL -90001 EVUTIL_EAI_FAIL -904 EVUTIL_EAI_FAMILY -905 EVUTIL_EAI_MEMORY -906 EVUTIL_EAI_NODATA -907 EVUTIL_EAI_NONAME -908 EVUTIL_EAI_SERVICE -909 EVUTIL_EAI_SOCKTYPE -910 EVUTIL_EAI_SYSTEM -911
+EVENT2_EXPORT_SYMBOL int evutil_ascii_strcasecmp (const char *str1, const char *str2) As strcasecmp, but always compares the characters in locale-independent ASCII. More... EVENT2_EXPORT_SYMBOL int evutil_ascii_strncasecmp (const char *str1, const char *str2, size_t n) As strncasecmp, but always compares the characters in locale-independent ASCII. More... EVENT2_EXPORT_SYMBOL int evutil_closesocket (evutil_socket_t sock) Do the platform-specific call needed to close a socket returned from socket() or accept(). More... evutil_configure_monotonic_time (struct evutil_monotonic_timer *timer, int flags) Set up a struct evutil_monotonic_timer ; flags can include EV_MONOT_PRECISE and EV_MONOT_FALLBACK. EVENT2_EXPORT_SYMBOL int evutil_date_rfc1123 (char *date, const size_t datelen, const struct tm *tm) Format a date string using RFC 1123 format (used in HTTP). More... evutil_freeaddrinfo (struct evutil_addrinfo *ai) Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo. evutil_gai_strerror (int err) EVENT2_EXPORT_SYMBOL int evutil_getaddrinfo (const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res) This function clones getaddrinfo for systems that don't have it. More... EVENT2_EXPORT_SYMBOL int evutil_gettime_monotonic (struct evutil_monotonic_timer *timer, struct timeval *tp) Query the current monotonic time from a struct evutil_monotonic_timer previously configured with evutil_configure_monotonic_time() . More... evutil_gettimeofday (struct timeval *tv, struct timezone *tz) evutil_inet_ntop (int af, const void *src, char *dst, size_t len) Replacement for inet_ntop for platforms which lack it. evutil_inet_pton (int af, const char *src, void *dst) Replacement for inet_pton for platforms which lack it. EVENT2_EXPORT_SYMBOL int evutil_inet_pton_scope (int af, const char *src, void *dst, unsigned *indexp) Variation of inet_pton that also parses IPv6 scopes. More... EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_ipv6only (evutil_socket_t sock) Set ipv6 only bind socket option to make listener work only in ipv6 sockets. More... EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_not_ipv6only (evutil_socket_t sock) Set ipv6 only bind socket option to make listener work in both ipv4 and ipv6 sockets. More... EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable (evutil_socket_t sock) Do platform-specific operations to make a listener socket reusable. More... EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable_port (evutil_socket_t sock) Do platform-specific operations to make a listener port reusable. More... EVENT2_EXPORT_SYMBOL int evutil_make_socket_closeonexec (evutil_socket_t sock) Do platform-specific operations as needed to close a socket upon a successful execution of one of the exec*() functions. More... EVENT2_EXPORT_SYMBOL int evutil_make_socket_nonblocking (evutil_socket_t sock) Do platform-specific operations as needed to make a socket nonblocking. More... EVENT2_EXPORT_SYMBOL int evutil_make_tcp_listen_socket_deferred (evutil_socket_t sock) Do platform-specific operations, if possible, to make a tcp listener socket defer accept()s until there is data to read. More... evutil_monotonic_timer_free (struct evutil_monotonic_timer *timer) Free a struct evutil_monotonic_timer that was allocated using evutil_monotonic_timer_new() . EVENT2_EXPORT_SYMBOL struct evutil_monotonic_timer * evutil_monotonic_timer_new (void) Allocate a new struct evutil_monotonic_timer for use with the evutil_configure_monotonic_time() and evutil_gettime_monotonic() functions. More... EVENT2_EXPORT_SYMBOL int evutil_parse_sockaddr_port (const char *str, struct sockaddr *out, int *outlen) Parse an IPv4 or IPv6 address, with optional port, from a string. More... EVENT2_EXPORT_SYMBOL void evutil_secure_rng_add_bytes (const char *dat, size_t datlen) Seed the random number generator with extra random bytes. More... EVENT2_EXPORT_SYMBOL void evutil_secure_rng_get_bytes (void *buf, size_t n) Generate n bytes of secure pseudorandom data, and store them in buf. More... EVENT2_EXPORT_SYMBOL int evutil_secure_rng_init (void) Seed the secure random number generator if needed, and return 0 on success or -1 on failure. More... EVENT2_EXPORT_SYMBOL int evutil_secure_rng_set_urandom_device_file (char *fname) Set a filename to use in place of /dev/urandom for seeding the secure PRNG. More... EVENT2_EXPORT_SYMBOL int evutil_set_tcp_keepalive (evutil_socket_t sock, int on, int timeout) Do platform-specific operations to set/unset TCP keep-alive options TCP_KEEPIDLE, TCP_KEEPINTVL and TCP_KEEPCNT on a socket. More... evutil_snprintf (char *buf, size_t buflen, const char *format,...) Replacement for snprintf to get consistent behavior on platforms for which the return value of snprintf does not conform to C99. EVENT2_EXPORT_SYMBOL int evutil_sockaddr_cmp (const struct sockaddr *sa1, const struct sockaddr *sa2, int include_port) Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 preceeds sa2, or greater than 0 if sa1 follows sa2. More... EVENT2_EXPORT_SYMBOL int evutil_socketpair (int d, int type, int protocol, evutil_socket_t sv[2]) Create two new sockets that are connected to each other. More... EVENT2_EXPORT_SYMBOL ev_int64_t evutil_strtoll (const char *s, char **endptr, int base) Parse a 64-bit value from a string. More... evutil_vsnprintf (char *buf, size_t buflen, const char *format, va_list ap) Replacement for vsnprintf to get consistent behavior on platforms for which the return value of snprintf does not conform to C99.
+
+
Common convenience functions for cross-platform portability and related socket manipulations.
+
+
+
◆
+
+
+
+
+
+ #define EVUTIL_SOCKET_ERROR
+ (
+ )
+ ...
+
+
+
+
+
Return the most recent socket error.
+
Not idempotent on all platforms.
+
+
+
+
+
◆
+
+
+
+
+
+ #define evutil_socket_t int
+
+
+
+
+
A type wide enough to hold the output of "socket()" or "accept()".
+
On Windows, this is an intptr_t; elsewhere, it is an int.
+
+
+
+
+
◆
+
+
+
+
+
+ #define evutil_timeradd
+ (
+
+ tvp,
+
+
+
+ uvp,
+
+
+
+ vvp
+
+
+ )
+
+
+
+
Value: do { \
+
(vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
+
(vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
+
if ((vvp)->tv_usec >= 1000000) { \
+
(vvp)->tv_sec++; \
+
(vvp)->tv_usec -= 1000000; \
+
} \
+
} while (0)
+
+
+
+
+
◆
+
+
+
+
+
+ #define evutil_timercmp
+ (
+
+ tvp,
+
+
+
+ uvp,
+
+
+
+ cmp
+
+
+ )
+
+
+
+
Value: (((tvp)->tv_sec == (uvp)->tv_sec) ? \
+
((tvp)->tv_usec cmp (uvp)->tv_usec) : \
+
((tvp)->tv_sec cmp (uvp)->tv_sec))
+
+
Return true iff the tvp is related to uvp according to the relational operator cmp.
+
Recognized values for cmp are ==, <=, <, >=, and >.
+
+
+
+
+
◆
+
+
+
+
+
+ #define evutil_timersub
+ (
+
+ tvp,
+
+
+
+ uvp,
+
+
+
+ vvp
+
+
+ )
+
+
+
+
Value: do { \
+
(vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
+
(vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
+
if ((vvp)->tv_usec < 0) { \
+
(vvp)->tv_sec--; \
+
(vvp)->tv_usec += 1000000; \
+
} \
+
} while (0)
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_ascii_strcasecmp
+ (
+ const char *
+ str1 ,
+
+ const char *
+ str2
+
+ )
+
+
+
+
+
As strcasecmp, but always compares the characters in locale-independent ASCII.
+
That's useful if you're handling data in ASCII-based protocols.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_ascii_strncasecmp
+ (
+ const char *
+ str1 ,
+
+ const char *
+ str2 ,
+
+ size_t
+ n
+
+ )
+
+
+
+
+
As strncasecmp, but always compares the characters in locale-independent ASCII.
+
That's useful if you're handling data in ASCII-based protocols.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_closesocket
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do the platform-specific call needed to close a socket returned from socket() or accept().
+
Parameters
+
+ sock The socket to be closed
+
+
+
Returns 0 on success (whether the operation is supported or not), -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_date_rfc1123
+ (
+ char *
+ date ,
+
+ const size_t
+ datelen ,
+
+ const struct tm *
+ tm
+
+ )
+
+
+
+
+
Format a date string using RFC 1123 format (used in HTTP).
+
If tm is NULL, current system's time will be used. The number of characters written will be returned. One should check if the return value is smaller than datelen to check if the result is truncated or not.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_getaddrinfo
+ (
+ const char *
+ nodename ,
+
+ const char *
+ servname ,
+
+ const struct evutil_addrinfo *
+ hints_in ,
+
+ struct evutil_addrinfo **
+ res
+
+ )
+
+
+
+
+
This function clones getaddrinfo for systems that don't have it.
+
For full details, see RFC 3493, section 6.1.
+
Limitations:
+When the system has no getaddrinfo, we fall back to gethostbyname_r or gethostbyname, with their attendant issues.
+The AI_V4MAPPED and AI_ALL flags are not currently implemented.
+
+
For a nonblocking variant, see evdns_getaddrinfo.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_gettime_monotonic
+ (
+ struct evutil_monotonic_timer *
+ timer ,
+
+ struct timeval *
+ tp
+
+ )
+
+
+
+
+
Query the current monotonic time from a struct evutil_monotonic_timer previously configured with evutil_configure_monotonic_time() .
+
Monotonic time is guaranteed never to run in reverse, but is not necessarily epoch- based, or relative to any other definite point. Use it to make reliable measurements of elapsed time between events even when the system time may be changed.
+
It is not safe to use this funtion on the same timer from multiple threads.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_inet_pton_scope
+ (
+ int
+ af ,
+
+ const char *
+ src ,
+
+ void *
+ dst ,
+
+ unsigned *
+ indexp
+
+ )
+
+
+
+
+
Variation of inet_pton that also parses IPv6 scopes.
+
Public for unit tests. No reason to call this directly.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_ipv6only
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Set ipv6 only bind socket option to make listener work only in ipv6 sockets.
+
According to RFC3493 and most Linux distributions, default value for the sockets is to work in IPv4-mapped mode. In IPv4-mapped mode, it is not possible to bind same port from different IPv4 and IPv6 handlers.
+
On Windows the default value is instead to only work in IPv6 mode.
+
Parameters
+
+ sock The socket to make in ipv6only working mode
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_not_ipv6only
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Set ipv6 only bind socket option to make listener work in both ipv4 and ipv6 sockets.
+
According to RFC3493 and most Linux distributions, default value for the sockets is to work in IPv4-mapped mode. In IPv4-mapped mode, it is not possible to bind same port from different IPv4 and IPv6 handlers.
+
On Windows the default value is instead to only work in IPv6 mode.
+
Parameters
+
+ sock The socket to make in ipv6only working mode
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do platform-specific operations to make a listener socket reusable.
+
Specifically, we want to make sure that another program will be able to bind this address right after we've closed the listener.
+
This differs from Windows's interpretation of "reusable", which allows multiple listeners to bind the same address at the same time.
+
Parameters
+
+ sock The socket to make reusable
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable_port
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do platform-specific operations to make a listener port reusable.
+
Specifically, we want to make sure that multiple programs which also set the same socket option will be able to bind, listen at the same time.
+
This is a feature available only to Linux 3.9+
+
Parameters
+
+ sock The socket to make reusable
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_socket_closeonexec
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do platform-specific operations as needed to close a socket upon a successful execution of one of the exec*() functions.
+
Parameters
+
+ sock The socket to be closed
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_socket_nonblocking
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do platform-specific operations as needed to make a socket nonblocking.
+
Parameters
+
+ sock The socket to make nonblocking
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_make_tcp_listen_socket_deferred
+ (
+ evutil_socket_t sock )
+
+
+
+
+
Do platform-specific operations, if possible, to make a tcp listener socket defer accept()s until there is data to read.
+
Not all platforms support this. You don't want to do this for every listener socket: only the ones that implement a protocol where the client transmits before the server needs to respond.
+
Parameters
+
+ sock The listening socket to to make deferred
+
+
+
Returns 0 on success (whether the operation is supported or not), -1 on failure
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_parse_sockaddr_port
+ (
+ const char *
+ str ,
+
+ struct sockaddr *
+ out ,
+
+ int *
+ outlen
+
+ )
+
+
+
+
+
Parse an IPv4 or IPv6 address, with optional port, from a string.
+
Recognized formats are:
+[IPv6Address]:port
+[IPv6Address]
+IPv6Address
+IPv4Address:port
+IPv4Address
+
+
If no port is specified, the port in the output is set to 0.
+
Parameters
+
+ str The string to parse. out A struct sockaddr to hold the result. This should probably be a struct sockaddr_storage. outlen A pointer to the number of bytes that that 'out' can safely hold. Set to the number of bytes used in 'out' on success.
+
+
+
Returns -1 if the address is not well-formed, if the port is out of range, or if out is not large enough to hold the result. Otherwise returns 0 on success.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evutil_secure_rng_add_bytes
+ (
+ const char *
+ dat ,
+
+ size_t
+ datlen
+
+ )
+
+
+
+
+
Seed the random number generator with extra random bytes.
+
You should almost never need to call this function; it should be sufficient to invoke evutil_secure_rng_init() , or let Libevent take care of calling evutil_secure_rng_init() on its own.
+
If you call this function as a replacement for the regular entropy sources, then you need to be sure that your input contains a fairly large amount of strong entropy. Doing so is notoriously hard: most people who try get it wrong. Watch out!
+
This function does nothing when the system provides arc4random() function because it will provide proper entropy.
+
Parameters
+
+ dat a buffer full of a strong source of random numbers datlen the number of bytes to read from datlen
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evutil_secure_rng_get_bytes
+ (
+ void *
+ buf ,
+
+ size_t
+ n
+
+ )
+
+
+
+
+
Generate n bytes of secure pseudorandom data, and store them in buf.
+
Current versions of Libevent use an ARC4-based random number generator, seeded using the platform's entropy source (/dev/urandom on Unix-like systems; BCryptGenRandom on Windows). This is not actually as secure as it should be: ARC4 is a pretty lousy cipher, and the current implementation provides only rudimentary prediction- and backtracking-resistance. Don't use this for serious cryptographic applications.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_secure_rng_init
+ (
+ void
+ )
+
+
+
+
+
Seed the secure random number generator if needed, and return 0 on success or -1 on failure.
+
It is okay to call this function more than once; it will still return 0 if the RNG has been successfully seeded and -1 if it can't be seeded.
+
Ordinarily you don't need to call this function from your own code; Libevent will seed the RNG itself the first time it needs good random numbers. You only need to call it if (a) you want to double-check that one of the seeding methods did succeed, or (b) you plan to drop the capability to seed (by chrooting, or dropping capabilities, or whatever), and you want to make sure that seeding happens before your program loses the ability to do it.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_secure_rng_set_urandom_device_file
+ (
+ char *
+ fname )
+
+
+
+
+
Set a filename to use in place of /dev/urandom for seeding the secure PRNG.
+
Return 0 on success, -1 on failure.
+
Call this function BEFORE calling any other initialization or RNG functions.
+
(This string will NOT be copied internally. Do not free it while any user of the secure RNG might be running. Don't pass anything other than a real /dev/...random device file here, or you might lose security.)
+
This API is unstable, and might change in a future libevent version.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_set_tcp_keepalive
+ (
+ evutil_socket_t sock ,
+
+ int
+ on ,
+
+ int
+ timeout
+
+ )
+
+
+
+
+
Do platform-specific operations to set/unset TCP keep-alive options TCP_KEEPIDLE, TCP_KEEPINTVL and TCP_KEEPCNT on a socket.
+
Parameters
+
+ sock The socket to be set TCP keep-alive on Nonzero value to enable TCP keep-alive, 0 to disable timeout The timeout in seconds with no activity until the first keepalive probe is sent
+
+
+
Returns 0 on success, -1 on failure
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_sockaddr_cmp
+ (
+ const struct sockaddr *
+ sa1 ,
+
+ const struct sockaddr *
+ sa2 ,
+
+ int
+ include_port
+
+ )
+
+
+
+
+
Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 preceeds sa2, or greater than 0 if sa1 follows sa2.
+
If include_port is true, consider the port as well as the address. Only implemented for AF_INET and AF_INET6 addresses. The ordering is not guaranteed to remain the same between Libevent versions.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evutil_socketpair
+ (
+ int
+ d ,
+
+ int
+ type ,
+
+ int
+ protocol ,
+
+ evutil_socket_t sv [2]
+
+ )
+
+
+
+
+
Create two new sockets that are connected to each other.
+
On Unix, this simply calls socketpair(). On Windows, it uses the loopback network interface on 127.0.0.1, and only AF_INET,SOCK_STREAM are supported.
+
(This may fail on some Windows hosts where firewall software has cleverly decided to keep 127.0.0.1 from talking to itself.)
+
Parameters and return values are as for socketpair()
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL ev_int64_t evutil_strtoll
+ (
+ const char *
+ s ,
+
+ char **
+ endptr ,
+
+ int
+ base
+
+ )
+
+
+
+
+
Parse a 64-bit value from a string.
+
Arguments are as for strtol.
+
+
+
+
libevent: event2/util.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #ifndef EVENT2_UTIL_H_INCLUDED_
+
27 #define EVENT2_UTIL_H_INCLUDED_
+
+
35 #include <event2/visibility.h>
+
+
+
+
+
+
41 #include <event2/event-config.h>
+
42 #ifdef EVENT__HAVE_SYS_TIME_H
+
+
+
45 #ifdef EVENT__HAVE_STDINT_H
+
+
47 #elif defined(EVENT__HAVE_INTTYPES_H)
+
+
+
50 #ifdef EVENT__HAVE_SYS_TYPES_H
+
51 #include <sys/types.h>
+
+
53 #ifdef EVENT__HAVE_STDDEF_H
+
+
+
+
+
+
+
60 #ifdef EVENT__HAVE_NETDB_H
+
+
+
+
+
+
66 #ifdef EVENT__HAVE_GETADDRINFO
+
+
+
+
+
71 #ifdef EVENT__HAVE_ERRNO_H
+
+
+
74 #include <sys/socket.h>
+
+
+
+
+
+
80 #if defined(EVENT__SIZEOF_VOID__) && !defined(EVENT__SIZEOF_VOID_P)
+
81 #define EVENT__SIZEOF_VOID_P EVENT__SIZEOF_VOID__
+
+
+
113 #ifdef EVENT__HAVE_UINT64_T
+
114 #define ev_uint64_t uint64_t
+
115 #define ev_int64_t int64_t
+
116 #elif defined(_WIN32)
+
117 #define ev_uint64_t unsigned __int64
+
118 #define ev_int64_t signed __int64
+
119 #elif EVENT__SIZEOF_LONG_LONG == 8
+
120 #define ev_uint64_t unsigned long long
+
121 #define ev_int64_t long long
+
122 #elif EVENT__SIZEOF_LONG == 8
+
123 #define ev_uint64_t unsigned long
+
124 #define ev_int64_t long
+
125 #elif defined(EVENT_IN_DOXYGEN_)
+
126 #define ev_uint64_t ...
+
127 #define ev_int64_t ...
+
+
129 #error "No way to define ev_uint64_t"
+
+
+
132 #ifdef EVENT__HAVE_UINT32_T
+
133 #define ev_uint32_t uint32_t
+
134 #define ev_int32_t int32_t
+
135 #elif defined(_WIN32)
+
136 #define ev_uint32_t unsigned int
+
137 #define ev_int32_t signed int
+
138 #elif EVENT__SIZEOF_LONG == 4
+
139 #define ev_uint32_t unsigned long
+
140 #define ev_int32_t signed long
+
141 #elif EVENT__SIZEOF_INT == 4
+
142 #define ev_uint32_t unsigned int
+
143 #define ev_int32_t signed int
+
144 #elif defined(EVENT_IN_DOXYGEN_)
+
145 #define ev_uint32_t ...
+
146 #define ev_int32_t ...
+
+
148 #error "No way to define ev_uint32_t"
+
+
+
151 #ifdef EVENT__HAVE_UINT16_T
+
152 #define ev_uint16_t uint16_t
+
153 #define ev_int16_t int16_t
+
154 #elif defined(_WIN32)
+
155 #define ev_uint16_t unsigned short
+
156 #define ev_int16_t signed short
+
157 #elif EVENT__SIZEOF_INT == 2
+
158 #define ev_uint16_t unsigned int
+
159 #define ev_int16_t signed int
+
160 #elif EVENT__SIZEOF_SHORT == 2
+
161 #define ev_uint16_t unsigned short
+
162 #define ev_int16_t signed short
+
163 #elif defined(EVENT_IN_DOXYGEN_)
+
164 #define ev_uint16_t ...
+
165 #define ev_int16_t ...
+
+
167 #error "No way to define ev_uint16_t"
+
+
+
170 #ifdef EVENT__HAVE_UINT8_T
+
171 #define ev_uint8_t uint8_t
+
172 #define ev_int8_t int8_t
+
173 #elif defined(EVENT_IN_DOXYGEN_)
+
174 #define ev_uint8_t ...
+
175 #define ev_int8_t ...
+
+
177 #define ev_uint8_t unsigned char
+
178 #define ev_int8_t signed char
+
+
+
181 #ifdef EVENT__HAVE_UINTPTR_T
+
182 #define ev_uintptr_t uintptr_t
+
183 #define ev_intptr_t intptr_t
+
184 #elif EVENT__SIZEOF_VOID_P <= 4
+
185 #define ev_uintptr_t ev_uint32_t
+
186 #define ev_intptr_t ev_int32_t
+
187 #elif EVENT__SIZEOF_VOID_P <= 8
+
188 #define ev_uintptr_t ev_uint64_t
+
189 #define ev_intptr_t ev_int64_t
+
190 #elif defined(EVENT_IN_DOXYGEN_)
+
191 #define ev_uintptr_t ...
+
192 #define ev_intptr_t ...
+
+
194 #error "No way to define ev_uintptr_t"
+
+
+
197 #ifdef EVENT__ssize_t
+
198 #define ev_ssize_t EVENT__ssize_t
+
+
200 #define ev_ssize_t ssize_t
+
+
+
+
+
+
+
+
+
+
+
211 #define ev_off_t ev_int64_t
+
212 #elif EVENT__SIZEOF_OFF_T == 8
+
213 #define ev_off_t ev_int64_t
+
214 #elif EVENT__SIZEOF_OFF_T == 4
+
215 #define ev_off_t ev_int32_t
+
216 #elif defined(EVENT_IN_DOXYGEN_)
+
+
+
219 #define ev_off_t off_t
+
+
+
+
+
+
+
+
+
+
238 #ifndef EVENT__HAVE_STDINT_H
+
239 #define EV_UINT64_MAX ((((ev_uint64_t)0xffffffffUL) << 32) | 0xffffffffUL)
+
240 #define EV_INT64_MAX ((((ev_int64_t) 0x7fffffffL) << 32) | 0xffffffffL)
+
241 #define EV_INT64_MIN ((-EV_INT64_MAX) - 1)
+
242 #define EV_UINT32_MAX ((ev_uint32_t)0xffffffffUL)
+
243 #define EV_INT32_MAX ((ev_int32_t) 0x7fffffffL)
+
244 #define EV_INT32_MIN ((-EV_INT32_MAX) - 1)
+
245 #define EV_UINT16_MAX ((ev_uint16_t)0xffffUL)
+
246 #define EV_INT16_MAX ((ev_int16_t) 0x7fffL)
+
247 #define EV_INT16_MIN ((-EV_INT16_MAX) - 1)
+
248 #define EV_UINT8_MAX 255
+
249 #define EV_INT8_MAX 127
+
250 #define EV_INT8_MIN ((-EV_INT8_MAX) - 1)
+
+
252 #define EV_UINT64_MAX UINT64_MAX
+
253 #define EV_INT64_MAX INT64_MAX
+
254 #define EV_INT64_MIN INT64_MIN
+
255 #define EV_UINT32_MAX UINT32_MAX
+
256 #define EV_INT32_MAX INT32_MAX
+
257 #define EV_INT32_MIN INT32_MIN
+
258 #define EV_UINT16_MAX UINT16_MAX
+
259 #define EV_INT16_MIN INT16_MIN
+
260 #define EV_INT16_MAX INT16_MAX
+
261 #define EV_UINT8_MAX UINT8_MAX
+
262 #define EV_INT8_MAX INT8_MAX
+
263 #define EV_INT8_MIN INT8_MIN
+
+
+
+
+
273 #if EVENT__SIZEOF_SIZE_T == 8
+
274 #define EV_SIZE_MAX EV_UINT64_MAX
+
275 #define EV_SSIZE_MAX EV_INT64_MAX
+
276 #elif EVENT__SIZEOF_SIZE_T == 4
+
277 #define EV_SIZE_MAX EV_UINT32_MAX
+
278 #define EV_SSIZE_MAX EV_INT32_MAX
+
279 #elif defined(EVENT_IN_DOXYGEN_)
+
280 #define EV_SIZE_MAX ...
+
281 #define EV_SSIZE_MAX ...
+
+
283 #error "No way to define SIZE_MAX"
+
+
+
286 #define EV_SSIZE_MIN ((-EV_SSIZE_MAX) - 1)
+
+
+
290 #define ev_socklen_t int
+
291 #elif defined(EVENT__socklen_t)
+
292 #define ev_socklen_t EVENT__socklen_t
+
+
294 #define ev_socklen_t socklen_t
+
+
+
297 #ifdef EVENT__HAVE_STRUCT_SOCKADDR_STORAGE___SS_FAMILY
+
298 #if !defined(EVENT__HAVE_STRUCT_SOCKADDR_STORAGE_SS_FAMILY) \
+
299 && !defined(ss_family)
+
300 #define ss_family __ss_family
+
+
+
+
+
308 #define evutil_socket_t intptr_t
+
+
310 #define evutil_socket_t int
+
+
+
+
326 #ifdef EVENT_IN_DOXYGEN_
+
+
+
+
+
331 #define EV_MONOT_PRECISE 1
+
332 #define EV_MONOT_FALLBACK 2
+
+
340 EVENT2_EXPORT_SYMBOL
int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
472 #define EVUTIL_CLOSESOCKET(s) evutil_closesocket(s)
+
+
+
+
+
+
+
+
+
+
502 #define EVUTIL_SOCKET_ERROR() WSAGetLastError()
+
+
504 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
+
505 do { WSASetLastError(errcode); } while (0)
+
+
+
+
+
+
512 #define EVUTIL_INVALID_SOCKET INVALID_SOCKET
+
513 #elif defined(EVENT_IN_DOXYGEN_)
+
+
529 #define EVUTIL_SOCKET_ERROR() ...
+
+
531 #define EVUTIL_SET_SOCKET_ERROR(errcode) ...
+
+
533 #define evutil_socket_geterror(sock) ...
+
+
535 #define evutil_socket_error_to_string(errcode) ...
+
536 #define EVUTIL_INVALID_SOCKET -1
+
+
+
539 #define EVUTIL_SOCKET_ERROR() (errno)
+
540 #define EVUTIL_SET_SOCKET_ERROR(errcode) \
+
541 do { errno = (errcode); } while (0)
+
542 #define evutil_socket_geterror(sock) (errno)
+
543 #define evutil_socket_error_to_string(errcode) (strerror(errcode))
+
544 #define EVUTIL_INVALID_SOCKET -1
+
+
556 #ifdef EVENT__HAVE_TIMERADD
+
557 #define evutil_timeradd(tvp, uvp, vvp) timeradd((tvp), (uvp), (vvp))
+
558 #define evutil_timersub(tvp, uvp, vvp) timersub((tvp), (uvp), (vvp))
+
+
560 #define evutil_timeradd(tvp, uvp, vvp) \
+
+
562 (vvp)->tv_sec = (tvp)->tv_sec + (uvp)->tv_sec; \
+
563 (vvp)->tv_usec = (tvp)->tv_usec + (uvp)->tv_usec; \
+
564 if ((vvp)->tv_usec >= 1000000) { \
+
+
566 (vvp)->tv_usec -= 1000000; \
+
+
+
569 #define evutil_timersub(tvp, uvp, vvp) \
+
+
571 (vvp)->tv_sec = (tvp)->tv_sec - (uvp)->tv_sec; \
+
572 (vvp)->tv_usec = (tvp)->tv_usec - (uvp)->tv_usec; \
+
573 if ((vvp)->tv_usec < 0) { \
+
+
575 (vvp)->tv_usec += 1000000; \
+
+
+
+
+
580 #ifdef EVENT__HAVE_TIMERCLEAR
+
581 #define evutil_timerclear(tvp) timerclear(tvp)
+
+
583 #define evutil_timerclear(tvp) (tvp)->tv_sec = (tvp)->tv_usec = 0
+
+
+
589 #define evutil_timercmp(tvp, uvp, cmp) \
+
590 (((tvp)->tv_sec == (uvp)->tv_sec) ? \
+
591 ((tvp)->tv_usec cmp (uvp)->tv_usec) : \
+
592 ((tvp)->tv_sec cmp (uvp)->tv_sec))
+
+
594 #ifdef EVENT__HAVE_TIMERISSET
+
595 #define evutil_timerisset(tvp) timerisset(tvp)
+
+
597 #define evutil_timerisset(tvp) ((tvp)->tv_sec || (tvp)->tv_usec)
+
+
+
+
602 #define evutil_offsetof(type, field) offsetof(type, field)
+
+
604 #define evutil_offsetof(type, field) ((off_t)(&((type *)0)->field))
+
+
+
+
+
610 ev_int64_t
evutil_strtoll (
const char *s,
char **endptr,
int base);
+
+
613 #ifdef EVENT__HAVE_GETTIMEOFDAY
+
614 #define evutil_gettimeofday(tv, tz) gettimeofday((tv), (tz))
+
+
+
+
618 int evutil_gettimeofday(
struct timeval *tv,
struct timezone *tz);
+
+
+
+
+
+
627 __attribute__((format(printf, 3, 4)))
+
+
+
+
634 int evutil_vsnprintf (
char *buf,
size_t buflen,
const char *format, va_list ap)
+
+
636 __attribute__((format(printf, 3, 0)))
+
+
+
+
+
642 const char *
evutil_inet_ntop (
int af,
const void *src,
char *dst,
size_t len);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
699 #ifdef EVENT__HAVE_STRUCT_ADDRINFO
+
700 #define evutil_addrinfo addrinfo
+
+
+
+
+
+
+
+
+
+
714 struct sockaddr *ai_addr;
+
+
+
+
+
725 #if defined(EAI_ADDRFAMILY) && defined(EVENT__HAVE_GETADDRINFO)
+
726 #define EVUTIL_EAI_ADDRFAMILY EAI_ADDRFAMILY
+
+
728 #define EVUTIL_EAI_ADDRFAMILY -901
+
+
730 #if defined(EAI_AGAIN) && defined(EVENT__HAVE_GETADDRINFO)
+
731 #define EVUTIL_EAI_AGAIN EAI_AGAIN
+
+
733 #define EVUTIL_EAI_AGAIN -902
+
+
735 #if defined(EAI_BADFLAGS) && defined(EVENT__HAVE_GETADDRINFO)
+
736 #define EVUTIL_EAI_BADFLAGS EAI_BADFLAGS
+
+
738 #define EVUTIL_EAI_BADFLAGS -903
+
+
740 #if defined(EAI_FAIL) && defined(EVENT__HAVE_GETADDRINFO)
+
741 #define EVUTIL_EAI_FAIL EAI_FAIL
+
+
743 #define EVUTIL_EAI_FAIL -904
+
+
745 #if defined(EAI_FAMILY) && defined(EVENT__HAVE_GETADDRINFO)
+
746 #define EVUTIL_EAI_FAMILY EAI_FAMILY
+
+
748 #define EVUTIL_EAI_FAMILY -905
+
+
750 #if defined(EAI_MEMORY) && defined(EVENT__HAVE_GETADDRINFO)
+
751 #define EVUTIL_EAI_MEMORY EAI_MEMORY
+
+
753 #define EVUTIL_EAI_MEMORY -906
+
+
+
+
+
758 #if defined(EAI_NODATA) && defined(EVENT__HAVE_GETADDRINFO) && (!defined(EAI_NONAME) || EAI_NODATA != EAI_NONAME)
+
759 #define EVUTIL_EAI_NODATA EAI_NODATA
+
+
761 #define EVUTIL_EAI_NODATA -907
+
+
763 #if defined(EAI_NONAME) && defined(EVENT__HAVE_GETADDRINFO)
+
764 #define EVUTIL_EAI_NONAME EAI_NONAME
+
+
766 #define EVUTIL_EAI_NONAME -908
+
+
768 #if defined(EAI_SERVICE) && defined(EVENT__HAVE_GETADDRINFO)
+
769 #define EVUTIL_EAI_SERVICE EAI_SERVICE
+
+
771 #define EVUTIL_EAI_SERVICE -909
+
+
773 #if defined(EAI_SOCKTYPE) && defined(EVENT__HAVE_GETADDRINFO)
+
774 #define EVUTIL_EAI_SOCKTYPE EAI_SOCKTYPE
+
+
776 #define EVUTIL_EAI_SOCKTYPE -910
+
+
778 #if defined(EAI_SYSTEM) && defined(EVENT__HAVE_GETADDRINFO)
+
779 #define EVUTIL_EAI_SYSTEM EAI_SYSTEM
+
+
781 #define EVUTIL_EAI_SYSTEM -911
+
+
+
784 #define EVUTIL_EAI_CANCEL -90001
+
+
786 #if defined(AI_PASSIVE) && defined(EVENT__HAVE_GETADDRINFO)
+
787 #define EVUTIL_AI_PASSIVE AI_PASSIVE
+
+
789 #define EVUTIL_AI_PASSIVE 0x1000
+
+
791 #if defined(AI_CANONNAME) && defined(EVENT__HAVE_GETADDRINFO)
+
792 #define EVUTIL_AI_CANONNAME AI_CANONNAME
+
+
794 #define EVUTIL_AI_CANONNAME 0x2000
+
+
796 #if defined(AI_NUMERICHOST) && defined(EVENT__HAVE_GETADDRINFO)
+
797 #define EVUTIL_AI_NUMERICHOST AI_NUMERICHOST
+
+
799 #define EVUTIL_AI_NUMERICHOST 0x4000
+
+
801 #if defined(AI_NUMERICSERV) && defined(EVENT__HAVE_GETADDRINFO)
+
802 #define EVUTIL_AI_NUMERICSERV AI_NUMERICSERV
+
+
804 #define EVUTIL_AI_NUMERICSERV 0x8000
+
+
806 #if defined(AI_V4MAPPED) && defined(EVENT__HAVE_GETADDRINFO)
+
807 #define EVUTIL_AI_V4MAPPED AI_V4MAPPED
+
+
809 #define EVUTIL_AI_V4MAPPED 0x10000
+
+
811 #if defined(AI_ALL) && defined(EVENT__HAVE_GETADDRINFO)
+
812 #define EVUTIL_AI_ALL AI_ALL
+
+
814 #define EVUTIL_AI_ALL 0x20000
+
+
816 #if defined(AI_ADDRCONFIG) && defined(EVENT__HAVE_GETADDRINFO)
+
817 #define EVUTIL_AI_ADDRCONFIG AI_ADDRCONFIG
+
+
819 #define EVUTIL_AI_ADDRCONFIG 0x40000
+
+
+
+
+
+
+
+
+
+
+
+
844 const char *evutil_gai_strerror(
int err);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Structure to hold information about a monotonic timer.
Definition: util.h:325
EVENT2_EXPORT_SYMBOL int evutil_inet_pton(int af, const char *src, void *dst)
Replacement for inet_pton for platforms which lack it.
EVENT2_EXPORT_SYMBOL int evutil_date_rfc1123(char *date, const size_t datelen, const struct tm *tm)
Format a date string using RFC 1123 format (used in HTTP).
EVENT2_EXPORT_SYMBOL int evutil_gettime_monotonic(struct evutil_monotonic_timer *timer, struct timeval *tp)
Query the current monotonic time from a struct evutil_monotonic_timer previously configured with evut...
EVENT2_EXPORT_SYMBOL int evutil_set_tcp_keepalive(evutil_socket_t sock, int on, int timeout)
Do platform-specific operations to set/unset TCP keep-alive options TCP_KEEPIDLE, TCP_KEEPINTVL and T...
EVENT2_EXPORT_SYMBOL int evutil_ascii_strcasecmp(const char *str1, const char *str2)
As strcasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_ipv6only(evutil_socket_t sock)
Set ipv6 only bind socket option to make listener work only in ipv6 sockets.
EVENT2_EXPORT_SYMBOL int evutil_getaddrinfo(const char *nodename, const char *servname, const struct evutil_addrinfo *hints_in, struct evutil_addrinfo **res)
This function clones getaddrinfo for systems that don't have it.
EVENT2_EXPORT_SYMBOL int evutil_ascii_strncasecmp(const char *str1, const char *str2, size_t n)
As strncasecmp, but always compares the characters in locale-independent ASCII.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_nonblocking(evutil_socket_t sock)
Do platform-specific operations as needed to make a socket nonblocking.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_init(void)
Seed the secure random number generator if needed, and return 0 on success or -1 on failure.
EVENT2_EXPORT_SYMBOL int evutil_parse_sockaddr_port(const char *str, struct sockaddr *out, int *outlen)
Parse an IPv4 or IPv6 address, with optional port, from a string.
EVENT2_EXPORT_SYMBOL int evutil_secure_rng_set_urandom_device_file(char *fname)
Set a filename to use in place of /dev/urandom for seeding the secure PRNG.
#define evutil_socket_error_to_string(errcode)
Convert a socket error to a string.
Definition: util.h:535
const EVENT2_EXPORT_SYMBOL char * evutil_inet_ntop(int af, const void *src, char *dst, size_t len)
Replacement for inet_ntop for platforms which lack it.
#define evutil_socket_geterror(sock)
Return the most recent socket error to occur on sock.
Definition: util.h:533
EVENT2_EXPORT_SYMBOL int evutil_snprintf(char *buf, size_t buflen, const char *format,...)
Replacement for snprintf to get consistent behavior on platforms for which the return value of snprin...
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_not_ipv6only(evutil_socket_t sock)
Set ipv6 only bind socket option to make listener work in both ipv4 and ipv6 sockets.
EVENT2_EXPORT_SYMBOL int evutil_make_socket_closeonexec(evutil_socket_t sock)
Do platform-specific operations as needed to close a socket upon a successful execution of one of the...
EVENT2_EXPORT_SYMBOL int evutil_configure_monotonic_time(struct evutil_monotonic_timer *timer, int flags)
Set up a struct evutil_monotonic_timer; flags can include EV_MONOT_PRECISE and EV_MONOT_FALLBACK.
EVENT2_EXPORT_SYMBOL int evutil_socketpair(int d, int type, int protocol, evutil_socket_t sv[2])
Create two new sockets that are connected to each other.
EVENT2_EXPORT_SYMBOL void evutil_freeaddrinfo(struct evutil_addrinfo *ai)
Release storage allocated by evutil_getaddrinfo or evdns_getaddrinfo.
EVENT2_EXPORT_SYMBOL struct evutil_monotonic_timer * evutil_monotonic_timer_new(void)
Allocate a new struct evutil_monotonic_timer for use with the evutil_configure_monotonic_time() and e...
EVENT2_EXPORT_SYMBOL int evutil_inet_pton_scope(int af, const char *src, void *dst, unsigned *indexp)
Variation of inet_pton that also parses IPv6 scopes.
EVENT2_EXPORT_SYMBOL ev_int64_t evutil_strtoll(const char *s, char **endptr, int base)
Parse a 64-bit value from a string.
EVENT2_EXPORT_SYMBOL int evutil_make_tcp_listen_socket_deferred(evutil_socket_t sock)
Do platform-specific operations, if possible, to make a tcp listener socket defer accept()s until the...
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_add_bytes(const char *dat, size_t datlen)
Seed the random number generator with extra random bytes.
EVENT2_EXPORT_SYMBOL int evutil_sockaddr_cmp(const struct sockaddr *sa1, const struct sockaddr *sa2, int include_port)
Compare two sockaddrs; return 0 if they are equal, or less than 0 if sa1 preceeds sa2,...
EVENT2_EXPORT_SYMBOL int evutil_closesocket(evutil_socket_t sock)
Do the platform-specific call needed to close a socket returned from socket() or accept().
EVENT2_EXPORT_SYMBOL void evutil_monotonic_timer_free(struct evutil_monotonic_timer *timer)
Free a struct evutil_monotonic_timer that was allocated using evutil_monotonic_timer_new().
A definition of struct addrinfo for systems that lack it.
Definition: util.h:707
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable_port(evutil_socket_t sock)
Do platform-specific operations to make a listener port reusable.
EVENT2_EXPORT_SYMBOL int evutil_make_listen_socket_reuseable(evutil_socket_t sock)
Do platform-specific operations to make a listener socket reusable.
EVENT2_EXPORT_SYMBOL int evutil_vsnprintf(char *buf, size_t buflen, const char *format, va_list ap)
Replacement for vsnprintf to get consistent behavior on platforms for which the return value of snpri...
EVENT2_EXPORT_SYMBOL void evutil_secure_rng_get_bytes(void *buf, size_t n)
Generate n bytes of secure pseudorandom data, and store them in buf.
#define evutil_socket_t
A type wide enough to hold the output of "socket()" or "accept()".
Definition: util.h:310
libevent: event2/watch.h File Reference
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
"Prepare" and "check" watchers.
+More...
+
#include <event2/visibility.h>
+
Go to the source code of this file.
+
+typedef void(* evwatch_check_cb ) (struct evwatch *, const struct evwatch_check_cb_info *, void *) Check callback, invoked by event_base_loop immediately after polling for I/O and before processing any active events. More... typedef void(* evwatch_prepare_cb ) (struct evwatch *, const struct evwatch_prepare_cb_info *, void *) Prepare callback, invoked by event_base_loop immediately before polling for I/O. More...
+EVENT2_EXPORT_SYMBOL struct event_base * evwatch_base (struct evwatch *watcher) Get the event_base that a given evwatch is registered with. More... EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_check_new (struct event_base *base, evwatch_check_cb callback, void *arg) Register a new "check" watcher, to be called in the event loop after polling for events and before handling them. More... EVENT2_EXPORT_SYMBOL void evwatch_free (struct evwatch *watcher) Deregister and deallocate a watcher. More... EVENT2_EXPORT_SYMBOL int evwatch_prepare_get_timeout (const struct evwatch_prepare_cb_info *info, struct timeval *timeout) Get the timeout (the expected polling duration) passed to the underlying implementation's dispatch. More... EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_prepare_new (struct event_base *base, evwatch_prepare_cb callback, void *arg) Register a new "prepare" watcher, to be called in the event loop prior to polling for events. More...
+
+
"Prepare" and "check" watchers.
+
"Prepare" and "check" watchers. A "prepare" watcher is a callback that fires immediately before polling for I/O. A "check" watcher is a callback that fires immediately after polling and before processing any active events. This may be useful for embedding other libraries' event loops (e.g. UI toolkits) into libevent's.
+
+
+
◆
+
+
+
+
+
+ typedef void(* evwatch_check_cb) (struct evwatch *, const struct evwatch_check_cb_info *, void *)
+
+
+
+
+
Check callback, invoked by event_base_loop immediately after polling for I/O and before processing any active events.
+
Parameters
+
+ watcher the check watcher that invoked this callback. info contextual information passed from event_base_loop. arg additional user-defined argument, set in evwatch_check_new.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ typedef void(* evwatch_prepare_cb) (struct evwatch *, const struct evwatch_prepare_cb_info *, void *)
+
+
+
+
+
Prepare callback, invoked by event_base_loop immediately before polling for I/O.
+
Parameters
+
+ watcher the prepare watcher that invoked this callback. info contextual information passed from event_base_loop. arg additional user-defined argument, set in evwatch_prepare_new.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct event_base * evwatch_base
+ (
+ struct evwatch *
+ watcher )
+
+
+
+
+
Get the event_base that a given evwatch is registered with.
+
Parameters
+
+
+
+
Returns the event_base for the given watcher.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evwatch* evwatch_check_new
+ (
+ struct event_base *
+ base ,
+
+ evwatch_check_cb callback ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Register a new "check" watcher, to be called in the event loop after polling for events and before handling them.
+
Watchers will be called in the order they were registered.
+
Parameters
+
+ base the event_base to operate on. callback the callback function to invoke. arg additional user-defined argument provided to the callback.
+
+
+
Returns a pointer to the newly allocated event watcher.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL void evwatch_free
+ (
+ struct evwatch *
+ watcher )
+
+
+
+
+
Deregister and deallocate a watcher.
+
Any watchers not freed using evwatch_free will eventually be deallocated in event_base_free (calling evwatch_free on a watcher after event_base_free has been called on its corresponding event_base is an error).
+
Parameters
+
+ watcher the watcher to deregister and deallocate.
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL int evwatch_prepare_get_timeout
+ (
+ const struct evwatch_prepare_cb_info *
+ info ,
+
+ struct timeval *
+ timeout
+
+ )
+
+
+
+
+
Get the timeout (the expected polling duration) passed to the underlying implementation's dispatch.
+
This value will only be set if there are pending EV_TIMEOUT events and if the event_base isn't in EVLOOP_NONBLOCK mode. It may be a useful performance statistic to compare the expected polling duration against the actual polling duration (that is, the time difference measured between this prepare callback and the following check callback).
+
Parameters
+
+ info the "prepare" callback info. timeout address of a timeval to write the polling duration to.
+
+
+
Returns 1 if a value was written to *timeout, or 0 if not.
+
+
+
+
+
◆
+
+
+
+
+
+ EVENT2_EXPORT_SYMBOL struct evwatch* evwatch_prepare_new
+ (
+ struct event_base *
+ base ,
+
+ evwatch_prepare_cb callback ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+
Register a new "prepare" watcher, to be called in the event loop prior to polling for events.
+
Watchers will be called in the order they were registered.
+
Parameters
+
+ base the event_base to operate on. callback the callback function to invoke. arg additional user-defined argument provided to the callback.
+
+
+
Returns a pointer to the newly allocated event watcher.
+
+
+
+
libevent: event2/watch.h Source File
+
+
+
+
+
+
+ libevent
+ 2.2.1
+
+ Event notification library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Go to the documentation of this file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
24 #ifndef EVENT2_WATCH_H_INCLUDED_
+
25 #define EVENT2_WATCH_H_INCLUDED_
+
+
+
+
+
+
43 #include <event2/visibility.h>
+
+
+
+
47 struct evwatch_prepare_cb_info;
+
48 struct evwatch_check_cb_info;
+
+
+
59 typedef void (*
evwatch_prepare_cb )(
struct evwatch *,
const struct evwatch_prepare_cb_info *,
void *);
+
+
69 typedef void (*
evwatch_check_cb )(
struct evwatch *,
const struct evwatch_check_cb_info *,
void *);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
EVENT2_EXPORT_SYMBOL struct event_base * evwatch_base(struct evwatch *watcher)
Get the event_base that a given evwatch is registered with.
void(* evwatch_prepare_cb)(struct evwatch *, const struct evwatch_prepare_cb_info *, void *)
Prepare callback, invoked by event_base_loop immediately before polling for I/O.
Definition: watch.h:59
void(* evwatch_check_cb)(struct evwatch *, const struct evwatch_check_cb_info *, void *)
Check callback, invoked by event_base_loop immediately after polling for I/O and before processing an...
Definition: watch.h:69
Structure to hold information and state for a Libevent dispatch loop.
Definition: event.h:219
EVENT2_EXPORT_SYMBOL int evwatch_prepare_get_timeout(const struct evwatch_prepare_cb_info *info, struct timeval *timeout)
Get the timeout (the expected polling duration) passed to the underlying implementation's dispatch.
EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_check_new(struct event_base *base, evwatch_check_cb callback, void *arg)
Register a new "check" watcher, to be called in the event loop after polling for events and before ha...
EVENT2_EXPORT_SYMBOL struct evwatch * evwatch_prepare_new(struct event_base *base, evwatch_prepare_cb callback, void *arg)
Register a new "prepare" watcher, to be called in the event loop prior to polling for events.
EVENT2_EXPORT_SYMBOL void evwatch_free(struct evwatch *watcher)
Deregister and deallocate a watcher.
+
