<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>libkate: kate_packet</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>kate_packet</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><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><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><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>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga523061b95171fd2408105ef108d921a4"></a><!-- doxytag: member="kate_packet.c::kate_packet_clear" ref="ga523061b95171fd2408105ef108d921a4" args="(kate_packet *kp)" -->
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to clear </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00515">kate_packet::data</a>, and <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>.</p>
</div>
</div>
<a class="anchor" id="ga510dc82a29cdd7234efd283974aedb0e"></a><!-- doxytag: member="kate_packet.c::kate_packet_init" ref="ga510dc82a29cdd7234efd283974aedb0e" args="(kate_packet *kp, size_t nbytes, const void *data)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to create </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbytes</em> </td><td>the number of bytes in the data to wrap </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>a pointer to the data to wrap </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, <a class="el" href="kate_8h_source.html#l00654">KATE_E_OUT_OF_MEMORY</a>, and <a class="el" href="kate__packet_8c_source.html#l00030">kate_packet_wrap()</a>.</p>
</div>
</div>
<a class="anchor" id="ga7c0c2af28df8ea89f5f62e830dc916b1"></a><!-- doxytag: member="kate_packet.c::kate_packet_wrap" ref="ga7c0c2af28df8ea89f5f62e830dc916b1" args="(kate_packet *kp, size_t nbytes, const void *data)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kp</em> </td><td>the <a class="el" href="structkate__packet.html">kate_packet</a> to wrap </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbytes</em> </td><td>the number of bytes in the data to wrap </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>a pointer to the data to wrap </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 success </dd>
<dd>
KATE_E_* error </dd></dl>
<p>References <a class="el" href="kate_8h_source.html#l00515">kate_packet::data</a>, <a class="el" href="kate_8h_source.html#l00653">KATE_E_INVALID_PARAMETER</a>, and <a class="el" href="kate_8h_source.html#l00514">kate_packet::nbytes</a>.</p>
<p>Referenced by <a class="el" href="kate__packet_8c_source.html#l00055">kate_packet_init()</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Dec 23 04:05:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
