/
tag_8h.html
235 lines (226 loc) · 16.5 KB
/
tag_8h.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libevent: event2/tag.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libevent
 <span id="projectnumber">2.2.1</span>
</div>
<div id="projectbrief">Event notification library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_db160b4728e6067cf5f9cc14ec42c79d.html">event2</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tag.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Helper functions for reading and writing tagged data onto buffers.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <event2/visibility.h></code><br />
<code>#include <event2/event-config.h></code><br />
<code>#include <<a class="el" href="util_8h_source.html">event2/util.h</a>></code><br />
</div>
<p><a href="tag_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a93e1a38b1581faeed7b9e49cb5b1ee1f"><td class="memItemLeft" align="right" valign="top"><a id="a93e1a38b1581faeed7b9e49cb5b1ee1f"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_consume</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf)</td></tr>
<tr class="separator:a93e1a38b1581faeed7b9e49cb5b1ee1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22ef611a14b919e939fdade0af8b692c"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><a class="el" href="tag_8h.html#a22ef611a14b919e939fdade0af8b692c">evtag_encode_int</a> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t number)</td></tr>
<tr class="memdesc:a22ef611a14b919e939fdade0af8b692c"><td class="mdescLeft"> </td><td class="mdescRight">Encode an integer and store it in an evbuffer. <a href="tag_8h.html#a22ef611a14b919e939fdade0af8b692c">More...</a><br /></td></tr>
<tr class="separator:a22ef611a14b919e939fdade0af8b692c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0aa6b889cb9538fc8d930478e26bea4a"><td class="memItemLeft" align="right" valign="top"><a id="a0aa6b889cb9538fc8d930478e26bea4a"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_encode_int64</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint64_t number)</td></tr>
<tr class="separator:a0aa6b889cb9538fc8d930478e26bea4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18a5875f383b88a10f9609febd572bc7"><td class="memItemLeft" align="right" valign="top"><a id="a18a5875f383b88a10f9609febd572bc7"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_init</b> (void)</td></tr>
<tr class="separator:a18a5875f383b88a10f9609febd572bc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55b4edd181b9b64ddf8c43b0681208a8"><td class="memItemLeft" align="right" valign="top"><a id="a55b4edd181b9b64ddf8c43b0681208a8"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t tag, const void *data, ev_uint32_t len)</td></tr>
<tr class="separator:a55b4edd181b9b64ddf8c43b0681208a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb0b4a136bfb4459872a48803e1016bd"><td class="memItemLeft" align="right" valign="top"><a id="afb0b4a136bfb4459872a48803e1016bd"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal_buffer</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t tag, struct <a class="el" href="structevbuffer.html">evbuffer</a> *data)</td></tr>
<tr class="separator:afb0b4a136bfb4459872a48803e1016bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38d624fe8fba15ecded4f102774f4b29"><td class="memItemLeft" align="right" valign="top"><a id="a38d624fe8fba15ecded4f102774f4b29"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal_int</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t tag, ev_uint32_t integer)</td></tr>
<tr class="separator:a38d624fe8fba15ecded4f102774f4b29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8800a6023b92077c93b03aa00cad103e"><td class="memItemLeft" align="right" valign="top"><a id="a8800a6023b92077c93b03aa00cad103e"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal_int64</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t tag, ev_uint64_t integer)</td></tr>
<tr class="separator:a8800a6023b92077c93b03aa00cad103e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9243cfb24ac29e1d45c4f0e6e8823d1"><td class="memItemLeft" align="right" valign="top"><a id="ae9243cfb24ac29e1d45c4f0e6e8823d1"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal_string</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buf, ev_uint32_t tag, const char *string)</td></tr>
<tr class="separator:ae9243cfb24ac29e1d45c4f0e6e8823d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57deb58c95af797722fc9ed07fb92e8a"><td class="memItemLeft" align="right" valign="top"><a id="a57deb58c95af797722fc9ed07fb92e8a"></a>
EVENT2_EXPORT_SYMBOL void </td><td class="memItemRight" valign="bottom"><b>evtag_marshal_timeval</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t tag, struct timeval *tv)</td></tr>
<tr class="separator:a57deb58c95af797722fc9ed07fb92e8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ea5b39f452ed214ab06c07ee661f227"><td class="memItemLeft" align="right" valign="top"><a id="a3ea5b39f452ed214ab06c07ee661f227"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_payload_length</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t *plength)</td></tr>
<tr class="separator:a3ea5b39f452ed214ab06c07ee661f227"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac23fdb8107760cc507a3ce0ff5a1e692"><td class="memItemLeft" align="right" valign="top"><a id="ac23fdb8107760cc507a3ce0ff5a1e692"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_peek</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t *ptag)</td></tr>
<tr class="separator:ac23fdb8107760cc507a3ce0ff5a1e692"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06365df1b23ca825910f6a999e3def91"><td class="memItemLeft" align="right" valign="top"><a id="a06365df1b23ca825910f6a999e3def91"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_peek_length</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t *plength)</td></tr>
<tr class="separator:a06365df1b23ca825910f6a999e3def91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a584eb1c913f4ce8033ce2d3e8d7c1cff"><td class="memItemLeft" align="right" valign="top"><a id="a584eb1c913f4ce8033ce2d3e8d7c1cff"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *src, ev_uint32_t *ptag, struct <a class="el" href="structevbuffer.html">evbuffer</a> *dst)</td></tr>
<tr class="separator:a584eb1c913f4ce8033ce2d3e8d7c1cff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47e19795f3d66e646c9c60c34feac334"><td class="memItemLeft" align="right" valign="top"><a id="a47e19795f3d66e646c9c60c34feac334"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal_fixed</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *src, ev_uint32_t need_tag, void *data, size_t len)</td></tr>
<tr class="separator:a47e19795f3d66e646c9c60c34feac334"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57431aea9815331fbbea6cca413a85af"><td class="memItemLeft" align="right" valign="top">EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><a class="el" href="tag_8h.html#a57431aea9815331fbbea6cca413a85af">evtag_unmarshal_header</a> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t *ptag)</td></tr>
<tr class="memdesc:a57431aea9815331fbbea6cca413a85af"><td class="mdescLeft"> </td><td class="mdescRight">Unmarshals the header and returns the length of the payload. <a href="tag_8h.html#a57431aea9815331fbbea6cca413a85af">More...</a><br /></td></tr>
<tr class="separator:a57431aea9815331fbbea6cca413a85af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4fdccdcbc51e5c21aa01baeba8ae32e"><td class="memItemLeft" align="right" valign="top"><a id="ad4fdccdcbc51e5c21aa01baeba8ae32e"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal_int</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t need_tag, ev_uint32_t *pinteger)</td></tr>
<tr class="separator:ad4fdccdcbc51e5c21aa01baeba8ae32e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10aff4dc5e8870b5d6cf7c493752b680"><td class="memItemLeft" align="right" valign="top"><a id="a10aff4dc5e8870b5d6cf7c493752b680"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal_int64</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t need_tag, ev_uint64_t *pinteger)</td></tr>
<tr class="separator:a10aff4dc5e8870b5d6cf7c493752b680"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4325fc1589684a5a3f23aa2b0f9bd45"><td class="memItemLeft" align="right" valign="top"><a id="af4325fc1589684a5a3f23aa2b0f9bd45"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal_string</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t need_tag, char **pstring)</td></tr>
<tr class="separator:af4325fc1589684a5a3f23aa2b0f9bd45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3d7cc5f3a002cebe47666953c50ba24"><td class="memItemLeft" align="right" valign="top"><a id="aa3d7cc5f3a002cebe47666953c50ba24"></a>
EVENT2_EXPORT_SYMBOL int </td><td class="memItemRight" valign="bottom"><b>evtag_unmarshal_timeval</b> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *evbuf, ev_uint32_t need_tag, struct timeval *ptv)</td></tr>
<tr class="separator:aa3d7cc5f3a002cebe47666953c50ba24"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Helper functions for reading and writing tagged data onto buffers. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a22ef611a14b919e939fdade0af8b692c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22ef611a14b919e939fdade0af8b692c">◆ </a></span>evtag_encode_int()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL void evtag_encode_int </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevbuffer.html">evbuffer</a> * </td>
<td class="paramname"><em>evbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ev_uint32_t </td>
<td class="paramname"><em>number</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encode an integer and store it in an evbuffer. </p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">evbuf</td><td>evbuffer to store the encoded number </td></tr>
<tr><td class="paramname">number</td><td>a 32-bit integer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a57431aea9815331fbbea6cca413a85af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57431aea9815331fbbea6cca413a85af">◆ </a></span>evtag_unmarshal_header()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EVENT2_EXPORT_SYMBOL int evtag_unmarshal_header </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structevbuffer.html">evbuffer</a> * </td>
<td class="paramname"><em>evbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ev_uint32_t * </td>
<td class="paramname"><em>ptag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unmarshals the header and returns the length of the payload. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">evbuf</td><td>the buffer from which to unmarshal data </td></tr>
<tr><td class="paramname">ptag</td><td>a pointer in which the tag id is being stored </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 on failure or the number of bytes in the remaining payload. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>