external/bsd/libevent/man/buffer_compat.h.3

   1 .TH "event2/buffer_compat.h" 3 "Tue Jan 27 2015" "libevent" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 event2/buffer_compat.h \-
   6 .PP
   7 Obsolete and deprecated versions of the functions in \fBbuffer\&.h\fP: provided only for backward compatibility\&.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 .SS "Macros"
  13
  14 .in +1c
  15 .ti -1c
  16 .RI "#define \fBEVBUFFER_DATA\fP(x)   \fBevbuffer_pullup\fP((x), -1)"
  17 .br
  18 .RI "\fIdeprecated in favor of calling the functions directly \fP"
  19 .ti -1c
  20 .RI "#define \fBEVBUFFER_LENGTH\fP(x)   \fBevbuffer_get_length\fP(x)"
  21 .br
  22 .RI "\fIdeprecated in favor of calling the functions directly \fP"
  23 .in -1c
  24 .SS "Typedefs"
  25
  26 .in +1c
  27 .ti -1c
  28 .RI "typedef void(* \fBevbuffer_cb\fP )(struct \fBevbuffer\fP *buffer, size_t old_len, size_t new_len, void *arg)"
  29 .br
  30 .RI "\fIType definition for a callback that is invoked whenever data is added or removed from an evbuffer\&. \fP"
  31 .in -1c
  32 .SS "Functions"
  33
  34 .in +1c
  35 .ti -1c
  36 .RI "unsigned char * \fBevbuffer_find\fP (struct \fBevbuffer\fP *buffer, const unsigned char *what, size_t len)"
  37 .br
  38 .RI "\fIFind a string within an evbuffer\&. \fP"
  39 .ti -1c
  40 .RI "char * \fBevbuffer_readline\fP (struct \fBevbuffer\fP *buffer)"
  41 .br
  42 .RI "\fIObsolete alias for evbuffer_readln(buffer, NULL, EOL_STYLE_ANY)\&. \fP"
  43 .ti -1c
  44 .RI "void \fBevbuffer_setcb\fP (struct \fBevbuffer\fP *buffer, \fBevbuffer_cb\fP cb, void *cbarg)"
  45 .br
  46 .RI "\fIReplace all callbacks on an evbuffer with a single new callback, or remove them\&. \fP"
  47 .in -1c
  48 .SH "Detailed Description"
  49 .PP
  50 Obsolete and deprecated versions of the functions in \fBbuffer\&.h\fP: provided only for backward compatibility\&.
  51
  52
  53 .SH "Typedef Documentation"
  54 .PP
  55 .SS "typedef void(* evbuffer_cb)(struct \fBevbuffer\fP *buffer, size_t old_len, size_t new_len, void *arg)"
  56
  57 .PP
  58 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\&.
  59 .PP
  60 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\&.
  61 .PP
  62 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!
  63 .PP
  64 \fBParameters:\fP
  65 .RS 4
  66 \fIbuffer\fP the buffer whose size has changed
  67 .br
  68 \fIold_len\fP the previous length of the buffer
  69 .br
  70 \fInew_len\fP the current length of the buffer
  71 .br
  72 \fIarg\fP a pointer to user data
  73 .RE
  74 .PP
  75
  76 .SH "Function Documentation"
  77 .PP
  78 .SS "unsigned char* evbuffer_find (struct \fBevbuffer\fP *buffer, const unsigned char *what, size_tlen)"
  79
  80 .PP
  81 Find a string within an evbuffer\&.
  82 .PP
  83 \fBParameters:\fP
  84 .RS 4
  85 \fIbuffer\fP the evbuffer to be searched
  86 .br
  87 \fIwhat\fP the string to be searched for
  88 .br
  89 \fIlen\fP the length of the search string
  90 .RE
  91 .PP
  92 \fBReturns:\fP
  93 .RS 4
  94 a pointer to the beginning of the search string, or NULL if the search failed\&.
  95 .RE
  96 .PP
  97
  98 .SS "char* evbuffer_readline (struct \fBevbuffer\fP *buffer)"
  99
 100 .PP
 101 Obsolete alias for evbuffer_readln(buffer, NULL, EOL_STYLE_ANY)\&.
 102 .PP
 103 \fBDeprecated\fP
 104 .RS 4
 105 This function is deprecated because its behavior is not correct for almost any protocol, and also because it's wholly subsumed by \fBevbuffer_readln()\fP\&.
 106 .RE
 107 .PP
 108 .PP
 109 \fBParameters:\fP
 110 .RS 4
 111 \fIbuffer\fP the evbuffer to read from
 112 .RE
 113 .PP
 114 \fBReturns:\fP
 115 .RS 4
 116 pointer to a single line, or NULL if an error occurred
 117 .RE
 118 .PP
 119
 120 .SS "void evbuffer_setcb (struct \fBevbuffer\fP *buffer, \fBevbuffer_cb\fPcb, void *cbarg)"
 121
 122 .PP
 123 Replace all callbacks on an evbuffer with a single new callback, or remove them\&. Subsequent calls to \fBevbuffer_setcb()\fP replace callbacks set by previous calls\&. Setting the callback to NULL removes any previously set callback\&.
 124 .PP
 125 \fBDeprecated\fP
 126 .RS 4
 127 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 \fBevbuffer_add()\fP, evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others\&.
 128 .RE
 129 .PP
 130 .PP
 131 \fBParameters:\fP
 132 .RS 4
 133 \fIbuffer\fP the evbuffer to be monitored
 134 .br
 135 \fIcb\fP the callback function to invoke when the evbuffer is modified, or NULL to remove all callbacks\&.
 136 .br
 137 \fIcbarg\fP an argument to be provided to the callback function
 138 .RE
 139 .PP
 140
 141 .SH "Author"
 142 .PP
 143 Generated automatically by Doxygen for libevent from the source code\&.