Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/external/bsd/libevent/man import doxygen generated pages for...
details: https://anonhg.NetBSD.org/src/rev/65d4c5871c56
branches: trunk
changeset: 786011:65d4c5871c56
user: christos <christos%NetBSD.org@localhost>
date: Thu Apr 11 16:05:55 2013 +0000
description:
import doxygen generated pages for libevent.
mandoc renders them butt-ugly.
diffstat:
external/bsd/libevent/man/buffer.h.3 | 1138 ++++++++++++
external/bsd/libevent/man/buffer_compat.h.3 | 139 +
external/bsd/libevent/man/bufferevent.3 | 27 +
external/bsd/libevent/man/bufferevent_ssl.h.3 | 116 +
external/bsd/libevent/man/deprecated.3 | 83 +
external/bsd/libevent/man/dns.h.3 | 887 +++++++++
external/bsd/libevent/man/dns_compat.h.3 | 499 +++++
external/bsd/libevent/man/evbuffer_cb_info.3 | 57 +
external/bsd/libevent/man/evbuffer_iovec.3 | 51 +
external/bsd/libevent/man/evbuffer_ptr.3 | 41 +
external/bsd/libevent/man/event.h.3 | 1283 +++++++++++++
external/bsd/libevent/man/event_base.3 | 31 +
external/bsd/libevent/man/event_compat.h.3 | 286 +++
external/bsd/libevent/man/event_config.3 | 29 +
external/bsd/libevent/man/evthread_condition_callbacks.3 | 70 +
external/bsd/libevent/man/evthread_lock_callbacks.3 | 76 +
external/bsd/libevent/man/evutil_addrinfo.3 | 50 +
external/bsd/libevent/man/http.h.3 | 1315 ++++++++++++++
external/bsd/libevent/man/http_compat.h.3 | 92 +
external/bsd/libevent/man/rpc.h.3 | 871 +++++++++
external/bsd/libevent/man/rpc_compat.h.3 | 27 +
external/bsd/libevent/man/tag.h.3 | 121 +
external/bsd/libevent/man/tag_compat.h.3 | 41 +
external/bsd/libevent/man/thread.h.3 | 203 ++
external/bsd/libevent/man/util.h.3 | 607 ++++++
25 files changed, 8140 insertions(+), 0 deletions(-)
diffs (truncated from 8240 to 300 lines):
diff -r 46390113b019 -r 65d4c5871c56 external/bsd/libevent/man/buffer.h.3
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/external/bsd/libevent/man/buffer.h.3 Thu Apr 11 16:05:55 2013 +0000
@@ -0,0 +1,1138 @@
+.TH "event2/buffer.h" 3 "Wed Apr 10 2013" "libevent" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+event2/buffer.h \-
+.PP
+Functions for buffering data for network sending or receiving\&.
+
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <event2/event-config\&.h>\fP
+.br
+\fC#include <stdarg\&.h>\fP
+.br
+\fC#include <event2/util\&.h>\fP
+.br
+
+.SS "Data Structures"
+
+.in +1c
+.ti -1c
+.RI "struct \fBevbuffer\fP"
+.br
+.RI "\fIAn evbuffer is an opaque data type for efficiently buffering data to be sent or received on the network\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_cb_info\fP"
+.br
+.RI "\fIStructure passed to an evbuffer_cb_func evbuffer callback\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_iovec\fP"
+.br
+.RI "\fIDescribes a single extent of memory inside an evbuffer\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_ptr\fP"
+.br
+.RI "\fIPointer to a position within an evbuffer\&. \fP"
+.in -1c
+.SS "Macros"
+
+.in +1c
+.ti -1c
+.RI "#define \fBEVBUFFER_CB_ENABLED\fP 1"
+.br
+.RI "\fIIf this flag is not set, then a callback is temporarily disabled, and should not be invoked\&. \fP"
+.ti -1c
+.RI "#define \fBEVBUFFER_FLAG_DRAINS_TO_FD\fP 1"
+.br
+.RI "\fIIf this flag is set, then we will not use \fBevbuffer_peek()\fP, \fBevbuffer_remove()\fP, \fBevbuffer_remove_buffer()\fP, 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)\&. \fP"
+.in -1c
+.SS "Typedefs"
+
+.in +1c
+.ti -1c
+.RI "typedef void(* \fBevbuffer_cb_func\fP )(struct \fBevbuffer\fP *buffer, const struct \fBevbuffer_cb_info\fP *info, void *arg)"
+.br
+.RI "\fIType definition for a callback that is invoked whenever data is added or removed from an evbuffer\&. \fP"
+.ti -1c
+.RI "typedef void(* \fBevbuffer_ref_cleanup_cb\fP )(const void *data, size_t datalen, void *extra)"
+.br
+.RI "\fIA cleanup function for a piece of memory added to an evbuffer by reference\&. \fP"
+.in -1c
+.SS "Enumerations"
+
+.in +1c
+.ti -1c
+.RI "enum \fBevbuffer_eol_style\fP { \fBEVBUFFER_EOL_ANY\fP, \fBEVBUFFER_EOL_CRLF\fP, \fBEVBUFFER_EOL_CRLF_STRICT\fP, \fBEVBUFFER_EOL_LF\fP }"
+.br
+.RI "\fIUsed to tell evbuffer_readln what kind of line-ending to look for\&. \fP"
+.ti -1c
+.RI "enum \fBevbuffer_ptr_how\fP { \fBEVBUFFER_PTR_SET\fP, \fBEVBUFFER_PTR_ADD\fP }"
+.br
+.RI "\fIDefines how to adjust an \fBevbuffer_ptr\fP by \fBevbuffer_ptr_set()\fP \fP"
+.in -1c
+.SS "Functions"
+
+.in +1c
+.ti -1c
+.RI "int \fBevbuffer_add\fP (struct \fBevbuffer\fP *buf, const void *data, size_t datlen)"
+.br
+.RI "\fIAppend data to the end of an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_add_buffer\fP (struct \fBevbuffer\fP *outbuf, struct \fBevbuffer\fP *inbuf)"
+.br
+.RI "\fIMove all data from one evbuffer into another evbuffer\&. \fP"
+.ti -1c
+.RI "struct evbuffer_cb_entry * \fBevbuffer_add_cb\fP (struct \fBevbuffer\fP *buffer, \fBevbuffer_cb_func\fP cb, void *cbarg)"
+.br
+.RI "\fIAdd a new callback to an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_add_file\fP (struct \fBevbuffer\fP *outbuf, int fd, ev_off_t offset, ev_off_t length)"
+.br
+.RI "\fICopy data from a file into the evbuffer for writing to a socket\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_add_printf\fP (struct \fBevbuffer\fP *buf, const char *fmt,\&.\&.\&.)"
+.br
+.RI "\fIAppend a formatted string to the end of an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_add_reference\fP (struct \fBevbuffer\fP *outbuf, const void *data, size_t datlen, \fBevbuffer_ref_cleanup_cb\fP cleanupfn, void *cleanupfn_arg)"
+.br
+.RI "\fIReference memory into an evbuffer without copying\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_add_vprintf\fP (struct \fBevbuffer\fP *buf, const char *fmt, va_list ap)"
+.br
+.RI "\fIAppend a va_list formatted string to the end of an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_cb_clear_flags\fP (struct \fBevbuffer\fP *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags)"
+.br
+.RI "\fIChange the flags that are set for a callback on a buffer by removing some\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_cb_set_flags\fP (struct \fBevbuffer\fP *buffer, struct evbuffer_cb_entry *cb, ev_uint32_t flags)"
+.br
+.RI "\fIChange the flags that are set for a callback on a buffer by adding more\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_clear_flags\fP (struct \fBevbuffer\fP *buf, ev_uint64_t flags)"
+.br
+.RI "\fIChange the flags that are set for an evbuffer by removing some\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_commit_space\fP (struct \fBevbuffer\fP *buf, struct \fBevbuffer_iovec\fP *vec, int n_vecs)"
+.br
+.RI "\fICommits previously reserved space\&. \fP"
+.ti -1c
+.RI "ev_ssize_t \fBevbuffer_copyout\fP (struct \fBevbuffer\fP *buf, void *data_out, size_t datlen)"
+.br
+.RI "\fIRead data from an evbuffer, and leave the buffer unchanged\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_defer_callbacks\fP (struct \fBevbuffer\fP *buffer, struct \fBevent_base\fP *base)"
+.br
+.RI "\fIForce all the callbacks on an evbuffer to be run, not immediately after the evbuffer is altered, but instead from inside the event loop\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_drain\fP (struct \fBevbuffer\fP *buf, size_t len)"
+.br
+.RI "\fIRemove a specified number of bytes data from the beginning of an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_enable_locking\fP (struct \fBevbuffer\fP *buf, void *lock)"
+.br
+.RI "\fIEnable locking on an evbuffer so that it can safely be used by multiple threads at the same time\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_expand\fP (struct \fBevbuffer\fP *buf, size_t datlen)"
+.br
+.RI "\fIExpands the available space in an evbuffer\&. \fP"
+.ti -1c
+.RI "void \fBevbuffer_free\fP (struct \fBevbuffer\fP *buf)"
+.br
+.RI "\fIDeallocate storage for an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_freeze\fP (struct \fBevbuffer\fP *buf, int at_front)"
+.br
+.RI "\fIPrevent calls that modify an evbuffer from succeeding\&. \fP"
+.ti -1c
+.RI "size_t \fBevbuffer_get_contiguous_space\fP (const struct \fBevbuffer\fP *buf)"
+.br
+.RI "\fIReturns the number of contiguous available bytes in the first buffer chain\&. \fP"
+.ti -1c
+.RI "size_t \fBevbuffer_get_length\fP (const struct \fBevbuffer\fP *buf)"
+.br
+.RI "\fIReturns the total number of bytes stored in the evbuffer\&. \fP"
+.ti -1c
+.RI "void \fBevbuffer_lock\fP (struct \fBevbuffer\fP *buf)"
+.br
+.RI "\fIAcquire the lock on an evbuffer\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer\fP * \fBevbuffer_new\fP (void)"
+.br
+.RI "\fIAllocate storage for a new evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_peek\fP (struct \fBevbuffer\fP *buffer, ev_ssize_t len, struct \fBevbuffer_ptr\fP *start_at, struct \fBevbuffer_iovec\fP *vec_out, int n_vec)"
+.br
+.RI "\fIFunction to peek at data inside an evbuffer without removing it or copying it out\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_prepend\fP (struct \fBevbuffer\fP *buf, const void *data, size_t size)"
+.br
+.RI "\fIPrepends data to the beginning of the evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_prepend_buffer\fP (struct \fBevbuffer\fP *dst, struct \fBevbuffer\fP *src)"
+.br
+.RI "\fIPrepends all data from the src evbuffer to the beginning of the dst evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_ptr_set\fP (struct \fBevbuffer\fP *buffer, struct \fBevbuffer_ptr\fP *ptr, size_t position, enum \fBevbuffer_ptr_how\fP how)"
+.br
+.RI "\fISets the search pointer in the buffer to position\&. \fP"
+.ti -1c
+.RI "unsigned char * \fBevbuffer_pullup\fP (struct \fBevbuffer\fP *buf, ev_ssize_t size)"
+.br
+.RI "\fIMakes the data at the begging of an evbuffer contiguous\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_read\fP (struct \fBevbuffer\fP *buffer, \fBevutil_socket_t\fP fd, int howmuch)"
+.br
+.RI "\fIRead from a file descriptor and store the result in an evbuffer\&. \fP"
+.ti -1c
+.RI "char * \fBevbuffer_readln\fP (struct \fBevbuffer\fP *buffer, size_t *n_read_out, enum \fBevbuffer_eol_style\fP eol_style)"
+.br
+.RI "\fIRead a single line from an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_remove\fP (struct \fBevbuffer\fP *buf, void *data, size_t datlen)"
+.br
+.RI "\fIRead data from an evbuffer and drain the bytes read\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_remove_buffer\fP (struct \fBevbuffer\fP *src, struct \fBevbuffer\fP *dst, size_t datlen)"
+.br
+.RI "\fIRead data from an evbuffer into another evbuffer, draining the bytes from the source buffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_remove_cb\fP (struct \fBevbuffer\fP *buffer, \fBevbuffer_cb_func\fP cb, void *cbarg)"
+.br
+.RI "\fIRemove a callback from an evbuffer, given the function and argument used to add it\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_remove_cb_entry\fP (struct \fBevbuffer\fP *buffer, struct evbuffer_cb_entry *ent)"
+.br
+.RI "\fIRemove a callback from an evbuffer, given a handle returned from evbuffer_add_cb\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_reserve_space\fP (struct \fBevbuffer\fP *buf, ev_ssize_t size, struct \fBevbuffer_iovec\fP *vec, int n_vec)"
+.br
+.RI "\fIReserves space in the last chain or chains of an evbuffer\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_ptr\fP \fBevbuffer_search\fP (struct \fBevbuffer\fP *buffer, const char *what, size_t len, const struct \fBevbuffer_ptr\fP *start)"
+.br
+.RI "\fISearch for a string within an evbuffer\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_ptr\fP \fBevbuffer_search_eol\fP (struct \fBevbuffer\fP *buffer, struct \fBevbuffer_ptr\fP *start, size_t *eol_len_out, enum \fBevbuffer_eol_style\fP eol_style)"
+.br
+.RI "\fISearch for an end-of-line string within an evbuffer\&. \fP"
+.ti -1c
+.RI "struct \fBevbuffer_ptr\fP \fBevbuffer_search_range\fP (struct \fBevbuffer\fP *buffer, const char *what, size_t len, const struct \fBevbuffer_ptr\fP *start, const struct \fBevbuffer_ptr\fP *end)"
+.br
+.RI "\fISearch for a string within part of an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_set_flags\fP (struct \fBevbuffer\fP *buf, ev_uint64_t flags)"
+.br
+.RI "\fIChange the flags that are set for an evbuffer by adding more\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_unfreeze\fP (struct \fBevbuffer\fP *buf, int at_front)"
+.br
+.RI "\fIRe-enable calls that modify an evbuffer\&. \fP"
+.ti -1c
+.RI "void \fBevbuffer_unlock\fP (struct \fBevbuffer\fP *buf)"
+.br
+.RI "\fIRelease the lock on an evbuffer\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_write\fP (struct \fBevbuffer\fP *buffer, \fBevutil_socket_t\fP fd)"
+.br
+.RI "\fIWrite the contents of an evbuffer to a file descriptor\&. \fP"
+.ti -1c
+.RI "int \fBevbuffer_write_atmost\fP (struct \fBevbuffer\fP *buffer, \fBevutil_socket_t\fP fd, ev_ssize_t howmuch)"
+.br
+.RI "\fIWrite some of the contents of an evbuffer to a file descriptor\&. \fP"
+.in -1c
+.SH "Detailed Description"
+.PP
+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\&.
+.PP
+A new evbuffer can be allocated with \fBevbuffer_new()\fP, and can be freed with \fBevbuffer_free()\fP\&. Most users will be using evbuffers via the bufferevent interface\&. To access a
bufferevent's evbuffers, use \fBbufferevent_get_input()\fP and \fBbufferevent_get_output()\fP\&.
+.PP
+There are several guidelines for using evbuffers\&.
+.PP
+.IP "\(bu" 2
+if you already know how much data you are going to add as a result of calling \fBevbuffer_add()\fP multiple times, it makes sense to use \fBevbuffer_expand()\fP first to make sure that enough memory
is allocated before hand\&.
+.PP
+.PP
+.IP "\(bu" 2
+\fBevbuffer_add_buffer()\fP adds the contents of one buffer to the other without incurring any unnecessary memory copies\&.
+.PP
+.PP
+.IP "\(bu" 2
+\fBevbuffer_add()\fP and \fBevbuffer_add_buffer()\fP do not mix very well: if you use them, you will wind up with fragmented memory in your buffer\&.
+.PP
+.PP
+.IP "\(bu" 2
+For high-performance code, you may want to avoid copying data into and out of buffers\&. You can skip the copy step by using \fBevbuffer_reserve_space()\fP/evbuffer_commit_space() when writing into
a buffer, and \fBevbuffer_peek()\fP when reading\&.
+.PP
+.PP
+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\&.
+.PP
+As the contents of an evbuffer can be stored in multiple different memory blocks, it cannot be accessed directly\&. Instead, \fBevbuffer_pullup()\fP 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 \fBevbuffer_peek()\fP if you don't
require that the memory to be contiguous\&.
+.SH "Macro Definition Documentation"
+.PP
+.SS "#define EVBUFFER_CB_ENABLED 1"
+
+.PP
+If this flag is not set, then a callback is temporarily disabled, and should not be invoked\&. \fBSee Also:\fP
+.RS 4
+\fBevbuffer_cb_set_flags()\fP, \fBevbuffer_cb_clear_flags()\fP
+.RE
+.PP
+
+.SS "#define EVBUFFER_FLAG_DRAINS_TO_FD 1"
+
+.PP
+If this flag is set, then we will not use \fBevbuffer_peek()\fP, \fBevbuffer_remove()\fP, \fBevbuffer_remove_buffer()\fP, 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 \fBevbuffer_add_file()\fP; see that function for more information\&.
+.PP
+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\&.
+.SH "Typedef Documentation"
+.PP
+.SS "typedef void(* evbuffer_cb_func)(struct \fBevbuffer\fP *buffer, const struct \fBevbuffer_cb_info\fP *info, void *arg)"
+
Home |
Main Index |
Thread Index |
Old Index