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

   1 .TH "event2/tag.h" 3 "Tue Jan 27 2015" "libevent" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 event2/tag.h \-
   6 .PP
   7 Helper functions for reading and writing tagged data onto buffers\&.
   8
   9 .SH SYNOPSIS
  10 .br
  11 .PP
  12 \fC#include <event2/event-config\&.h>\fP
  13 .br
  14 \fC#include <event2/util\&.h>\fP
  15 .br
  16
  17 .SS "Functions"
  18
  19 .in +1c
  20 .ti -1c
  21 .RI "int \fBevtag_consume\fP (struct \fBevbuffer\fP *evbuf)"
  22 .br
  23 .ti -1c
  24 .RI "void \fBevtag_encode_int\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t number)"
  25 .br
  26 .RI "\fIEncode an integer and store it in an evbuffer\&. \fP"
  27 .ti -1c
  28 .RI "void \fBevtag_encode_int64\fP (struct \fBevbuffer\fP *evbuf, ev_uint64_t number)"
  29 .br
  30 .ti -1c
  31 .RI "void \fBevtag_init\fP (void)"
  32 .br
  33 .ti -1c
  34 .RI "void \fBevtag_marshal\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t tag, const void *data, ev_uint32_t len)"
  35 .br
  36 .ti -1c
  37 .RI "void \fBevtag_marshal_buffer\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t tag, struct \fBevbuffer\fP *data)"
  38 .br
  39 .ti -1c
  40 .RI "void \fBevtag_marshal_int\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t tag, ev_uint32_t integer)"
  41 .br
  42 .ti -1c
  43 .RI "void \fBevtag_marshal_int64\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t tag, ev_uint64_t integer)"
  44 .br
  45 .ti -1c
  46 .RI "void \fBevtag_marshal_string\fP (struct \fBevbuffer\fP *buf, ev_uint32_t tag, const char *string)"
  47 .br
  48 .ti -1c
  49 .RI "void \fBevtag_marshal_timeval\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t tag, struct timeval *tv)"
  50 .br
  51 .ti -1c
  52 .RI "int \fBevtag_payload_length\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t *plength)"
  53 .br
  54 .ti -1c
  55 .RI "int \fBevtag_peek\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t *ptag)"
  56 .br
  57 .ti -1c
  58 .RI "int \fBevtag_peek_length\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t *plength)"
  59 .br
  60 .ti -1c
  61 .RI "int \fBevtag_unmarshal\fP (struct \fBevbuffer\fP *src, ev_uint32_t *ptag, struct \fBevbuffer\fP *dst)"
  62 .br
  63 .ti -1c
  64 .RI "int \fBevtag_unmarshal_fixed\fP (struct \fBevbuffer\fP *src, ev_uint32_t need_tag, void *data, size_t len)"
  65 .br
  66 .ti -1c
  67 .RI "int \fBevtag_unmarshal_header\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t *ptag)"
  68 .br
  69 .RI "\fIUnmarshals the header and returns the length of the payload\&. \fP"
  70 .ti -1c
  71 .RI "int \fBevtag_unmarshal_int\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t need_tag, ev_uint32_t *pinteger)"
  72 .br
  73 .ti -1c
  74 .RI "int \fBevtag_unmarshal_int64\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t need_tag, ev_uint64_t *pinteger)"
  75 .br
  76 .ti -1c
  77 .RI "int \fBevtag_unmarshal_string\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t need_tag, char **pstring)"
  78 .br
  79 .ti -1c
  80 .RI "int \fBevtag_unmarshal_timeval\fP (struct \fBevbuffer\fP *evbuf, ev_uint32_t need_tag, struct timeval *ptv)"
  81 .br
  82 .in -1c
  83 .SH "Detailed Description"
  84 .PP
  85 Helper functions for reading and writing tagged data onto buffers\&.
  86
  87
  88 .SH "Function Documentation"
  89 .PP
  90 .SS "void evtag_encode_int (struct \fBevbuffer\fP *evbuf, ev_uint32_tnumber)"
  91
  92 .PP
  93 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\&.
  94 .PP
  95 \fBParameters:\fP
  96 .RS 4
  97 \fIevbuf\fP evbuffer to store the encoded number
  98 .br
  99 \fInumber\fP a 32-bit integer
 100 .RE
 101 .PP
 102
 103 .SS "int evtag_unmarshal_header (struct \fBevbuffer\fP *evbuf, ev_uint32_t *ptag)"
 104
 105 .PP
 106 Unmarshals the header and returns the length of the payload\&.
 107 .PP
 108 \fBParameters:\fP
 109 .RS 4
 110 \fIevbuf\fP the buffer from which to unmarshal data
 111 .br
 112 \fIptag\fP a pointer in which the tag id is being stored
 113 .RE
 114 .PP
 115 \fBReturns:\fP
 116 .RS 4
 117 -1 on failure or the number of bytes in the remaining payload\&.
 118 .RE
 119 .PP
 120
 121 .SH "Author"
 122 .PP
 123 Generated automatically by Doxygen for libevent from the source code\&.