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
|
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libkate: kate_packet</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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">libkate<span id="projectnumber"> 0.4.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">kate_packet</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7c0c2af28df8ea89f5f62e830dc916b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__packet.html#ga7c0c2af28df8ea89f5f62e830dc916b1">kate_packet_wrap</a> (<a class="el" href="structkate__packet.html">kate_packet</a> *kp, size_t nbytes, const void *data)</td></tr>
<tr class="separator:ga7c0c2af28df8ea89f5f62e830dc916b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga510dc82a29cdd7234efd283974aedb0e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__packet.html#ga510dc82a29cdd7234efd283974aedb0e">kate_packet_init</a> (<a class="el" href="structkate__packet.html">kate_packet</a> *kp, size_t nbytes, const void *data)</td></tr>
<tr class="separator:ga510dc82a29cdd7234efd283974aedb0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga523061b95171fd2408105ef108d921a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__packet.html#ga523061b95171fd2408105ef108d921a4">kate_packet_clear</a> (<a class="el" href="structkate__packet.html">kate_packet</a> *kp)</td></tr>
<tr class="separator:ga523061b95171fd2408105ef108d921a4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga523061b95171fd2408105ef108d921a4" name="ga523061b95171fd2408105ef108d921a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga523061b95171fd2408105ef108d921a4">◆ </a></span>kate_packet_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_packet_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"><em>kp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Clears a <a class="el" href="structkate__packet.html">kate_packet</a> previously initialized by kate_packet_init </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kp</td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to clear </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__packet.html#aabf779dd48628d3ed726280bbce09791">kate_packet::data</a>, and <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a id="ga510dc82a29cdd7234efd283974aedb0e" name="ga510dc82a29cdd7234efd283974aedb0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga510dc82a29cdd7234efd283974aedb0e">◆ </a></span>kate_packet_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_packet_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"><em>kp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns a <a class="el" href="structkate__packet.html">kate_packet</a> created from the given data. The data is copied, so can be freed once the <a class="el" href="structkate__packet.html">kate_packet</a> is created. The <a class="el" href="structkate__packet.html">kate_packet</a> should be cleared when not needed anymore. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kp</td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to create </td></tr>
<tr><td class="paramname">nbytes</td><td>the number of bytes in the data to wrap </td></tr>
<tr><td class="paramname">data</td><td>a pointer to the data to wrap </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>, <a class="el" href="kate_8h.html#ace0a2017701cecf1b747df1744f02412">KATE_E_OUT_OF_MEMORY</a>, and <a class="el" href="group__packet.html#ga7c0c2af28df8ea89f5f62e830dc916b1">kate_packet_wrap()</a>.</p>
</div>
</div>
<a id="ga7c0c2af28df8ea89f5f62e830dc916b1" name="ga7c0c2af28df8ea89f5f62e830dc916b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7c0c2af28df8ea89f5f62e830dc916b1">◆ </a></span>kate_packet_wrap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int kate_packet_wrap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structkate__packet.html">kate_packet</a> * </td>
<td class="paramname"><em>kp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p >Returns a <a class="el" href="structkate__packet.html">kate_packet</a> wrapping the given data. The data is not copied, so should stay valid throughout the use of the <a class="el" href="structkate__packet.html">kate_packet</a>. The <a class="el" href="structkate__packet.html">kate_packet</a> should not be cleared. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kp</td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to wrap </td></tr>
<tr><td class="paramname">nbytes</td><td>the number of bytes in the data to wrap </td></tr>
<tr><td class="paramname">data</td><td>a pointer to the data to wrap </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p class="reference">References <a class="el" href="structkate__packet.html#aabf779dd48628d3ed726280bbce09791">kate_packet::data</a>, <a class="el" href="kate_8h.html#ae8ebebffaa4e6519c307a079d6d13107">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="structkate__packet.html#a32674c8a6d9f8efc1d38ea9dfbcca204">kate_packet::nbytes</a>.</p>
<p class="reference">Referenced by <a class="el" href="group__packet.html#ga510dc82a29cdd7234efd283974aedb0e">kate_packet_init()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
|
