%PDF-
%PDF-
Mini Shell
Mini Shell
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Nagios: iocache.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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">Nagios
 <span id="projectnumber">4.4.3</span>
</div>
<div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">iocache.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>I/O cache function declarations.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdlib.h></code><br/>
<code>#include <sys/types.h></code><br/>
<code>#include <sys/socket.h></code><br/>
</div>
<p><a href="iocache_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="memitem:a55f7f9a81e6bd8906611bcf7f85d021c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55f7f9a81e6bd8906611bcf7f85d021c"></a>
typedef struct iocache </td><td class="memItemRight" valign="bottom"><b>iocache</b></td></tr>
<tr class="separator:a55f7f9a81e6bd8906611bcf7f85d021c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae146fb5628e76989e5dfaea288a059b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#ae146fb5628e76989e5dfaea288a059b8">iocache_destroy</a> (iocache *ioc)</td></tr>
<tr class="memdesc:ae146fb5628e76989e5dfaea288a059b8"><td class="mdescLeft"> </td><td class="mdescRight">Destroys an iocache object, freeing all memory allocated to it. <a href="#ae146fb5628e76989e5dfaea288a059b8">More...</a><br/></td></tr>
<tr class="separator:ae146fb5628e76989e5dfaea288a059b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a570919eb41d4787291e692f2d9924f74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a570919eb41d4787291e692f2d9924f74">iocache_reset</a> (iocache *ioc)</td></tr>
<tr class="memdesc:a570919eb41d4787291e692f2d9924f74"><td class="mdescLeft"> </td><td class="mdescRight">Resets an iocache struct, discarding all data in it without free()'ing any memory. <a href="#a570919eb41d4787291e692f2d9924f74">More...</a><br/></td></tr>
<tr class="separator:a570919eb41d4787291e692f2d9924f74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47c6a4d2fe0c3c6b8eeb3253857696c6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a47c6a4d2fe0c3c6b8eeb3253857696c6">iocache_resize</a> (iocache *ioc, unsigned long new_size)</td></tr>
<tr class="memdesc:a47c6a4d2fe0c3c6b8eeb3253857696c6"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer in an io cache. <a href="#a47c6a4d2fe0c3c6b8eeb3253857696c6">More...</a><br/></td></tr>
<tr class="separator:a47c6a4d2fe0c3c6b8eeb3253857696c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5504e609daa3e89b4c1d0c7ee10883cd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a5504e609daa3e89b4c1d0c7ee10883cd">iocache_grow</a> (iocache *ioc, unsigned long increment)</td></tr>
<tr class="memdesc:a5504e609daa3e89b4c1d0c7ee10883cd"><td class="mdescLeft"> </td><td class="mdescRight">Grows an iocache object This uses <a class="el" href="iocache_8h.html#a47c6a4d2fe0c3c6b8eeb3253857696c6" title="Resizes the buffer in an io cache. ">iocache_resize()</a> internally. <a href="#a5504e609daa3e89b4c1d0c7ee10883cd">More...</a><br/></td></tr>
<tr class="separator:a5504e609daa3e89b4c1d0c7ee10883cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f80081c951f3a8ea6d958db40c592ea"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a2f80081c951f3a8ea6d958db40c592ea">iocache_size</a> (iocache *ioc)</td></tr>
<tr class="memdesc:a2f80081c951f3a8ea6d958db40c592ea"><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size of the io cache. <a href="#a2f80081c951f3a8ea6d958db40c592ea">More...</a><br/></td></tr>
<tr class="separator:a2f80081c951f3a8ea6d958db40c592ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a441133dd5ffeef560d6c4465af42dec5"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a441133dd5ffeef560d6c4465af42dec5">iocache_capacity</a> (iocache *ioc)</td></tr>
<tr class="memdesc:a441133dd5ffeef560d6c4465af42dec5"><td class="mdescLeft"> </td><td class="mdescRight">Returns remaining read capacity of the io cache. <a href="#a441133dd5ffeef560d6c4465af42dec5">More...</a><br/></td></tr>
<tr class="separator:a441133dd5ffeef560d6c4465af42dec5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee21b08e5e29cec723fd55d0097ea934"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#aee21b08e5e29cec723fd55d0097ea934">iocache_available</a> (iocache *ioc)</td></tr>
<tr class="memdesc:aee21b08e5e29cec723fd55d0097ea934"><td class="mdescLeft"> </td><td class="mdescRight">Return the amount of unread but stored data in the io cache. <a href="#aee21b08e5e29cec723fd55d0097ea934">More...</a><br/></td></tr>
<tr class="separator:aee21b08e5e29cec723fd55d0097ea934"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a515b0146b7054578110c8f0c39321b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a9a515b0146b7054578110c8f0c39321b">iocache_use_size</a> (iocache *ioc, unsigned long size)</td></tr>
<tr class="memdesc:a9a515b0146b7054578110c8f0c39321b"><td class="mdescLeft"> </td><td class="mdescRight">Use a chunk of data from iocache based on size. <a href="#a9a515b0146b7054578110c8f0c39321b">More...</a><br/></td></tr>
<tr class="separator:a9a515b0146b7054578110c8f0c39321b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3bade517d121ec16f8647cd5d06e46e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#ac3bade517d121ec16f8647cd5d06e46e">iocache_use_delim</a> (iocache *ioc, const char *delim, size_t delim_len, unsigned long *size)</td></tr>
<tr class="memdesc:ac3bade517d121ec16f8647cd5d06e46e"><td class="mdescLeft"> </td><td class="mdescRight">Use a chunk of data from iocache based on delimiter. <a href="#ac3bade517d121ec16f8647cd5d06e46e">More...</a><br/></td></tr>
<tr class="separator:ac3bade517d121ec16f8647cd5d06e46e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42deb8ea8d88b20cb6eabdf40b5a53c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a42deb8ea8d88b20cb6eabdf40b5a53c7">iocache_unuse_size</a> (iocache *ioc, unsigned long size)</td></tr>
<tr class="memdesc:a42deb8ea8d88b20cb6eabdf40b5a53c7"><td class="mdescLeft"> </td><td class="mdescRight">Forget that a specified number of bytes have been used. <a href="#a42deb8ea8d88b20cb6eabdf40b5a53c7">More...</a><br/></td></tr>
<tr class="separator:a42deb8ea8d88b20cb6eabdf40b5a53c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09251e6424e938799a615c9788a16d66"><td class="memItemLeft" align="right" valign="top">iocache * </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a09251e6424e938799a615c9788a16d66">iocache_create</a> (unsigned long size)</td></tr>
<tr class="memdesc:a09251e6424e938799a615c9788a16d66"><td class="mdescLeft"> </td><td class="mdescRight">Creates the iocache object, initializing it with the given size. <a href="#a09251e6424e938799a615c9788a16d66">More...</a><br/></td></tr>
<tr class="separator:a09251e6424e938799a615c9788a16d66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d5e78d9f3f933aca19b109edc13bd06"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a9d5e78d9f3f933aca19b109edc13bd06">iocache_read</a> (iocache *ioc, int fd)</td></tr>
<tr class="memdesc:a9d5e78d9f3f933aca19b109edc13bd06"><td class="mdescLeft"> </td><td class="mdescRight">Read data into the iocache buffer. <a href="#a9d5e78d9f3f933aca19b109edc13bd06">More...</a><br/></td></tr>
<tr class="separator:a9d5e78d9f3f933aca19b109edc13bd06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0da13d6fc67e4955fcba4b1cf0a8694"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#ac0da13d6fc67e4955fcba4b1cf0a8694">iocache_add</a> (iocache *ioc, char *buf, unsigned int len)</td></tr>
<tr class="memdesc:ac0da13d6fc67e4955fcba4b1cf0a8694"><td class="mdescLeft"> </td><td class="mdescRight">Add data to the iocache buffer The data is copied, so it can safely be taken from the stack in a function that returns before the data is used. <a href="#ac0da13d6fc67e4955fcba4b1cf0a8694">More...</a><br/></td></tr>
<tr class="separator:ac0da13d6fc67e4955fcba4b1cf0a8694"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a306617113452fe919ed70b7a71179b04"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="iocache_8h.html#a306617113452fe919ed70b7a71179b04">iocache_sendto</a> (iocache *ioc, int fd, char *buf, unsigned int len, int flags, const struct sockaddr *dest_addr, socklen_t addrlen)</td></tr>
<tr class="memdesc:a306617113452fe919ed70b7a71179b04"><td class="mdescLeft"> </td><td class="mdescRight">Like sendto(), but sends all cached data prior to the requested. <a href="#a306617113452fe919ed70b7a71179b04">More...</a><br/></td></tr>
<tr class="separator:a306617113452fe919ed70b7a71179b04"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>I/O cache function declarations. </p>
<p>The I/O cache library is useful for reading large chunks of data from sockets and utilizing parts of that data based on either size or a magic delimiter. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ac0da13d6fc67e4955fcba4b1cf0a8694"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_add </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add data to the iocache buffer The data is copied, so it can safely be taken from the stack in a function that returns before the data is used. </p>
<p>If the io cache is too small to hold the data, -1 will be returned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ioc</td><td>The io cache to add to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the data we should add </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Length (in bytes) of data pointed to by buf </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>iocache_available(ioc) on success, -1 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="aee21b08e5e29cec723fd55d0097ea934"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long iocache_available </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the amount of unread but stored data in the io cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache to operate on </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes available to read </dd></dl>
</div>
</div>
<a class="anchor" id="a441133dd5ffeef560d6c4465af42dec5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long iocache_capacity </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns remaining read capacity of the io cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache to operate on </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes available to read, or -1 if ioc is null, -2 if the buffer is null, or -2 if the buffer size is <= 0 </dd></dl>
</div>
</div>
<a class="anchor" id="a09251e6424e938799a615c9788a16d66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">iocache* iocache_create </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates the iocache object, initializing it with the given size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Initial size of the iocache buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to a valid iocache object </dd></dl>
</div>
</div>
<a class="anchor" id="ae146fb5628e76989e5dfaea288a059b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void iocache_destroy </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys an iocache object, freeing all memory allocated to it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The iocache object to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5504e609daa3e89b4c1d0c7ee10883cd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_grow </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>increment</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Grows an iocache object This uses <a class="el" href="iocache_8h.html#a47c6a4d2fe0c3c6b8eeb3253857696c6" title="Resizes the buffer in an io cache. ">iocache_resize()</a> internally. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ioc</td><td>The iocache to grow </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">increment</td><td>How much to increase it </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a9d5e78d9f3f933aca19b109edc13bd06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_read </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data into the iocache buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache we should read into </td></tr>
<tr><td class="paramname">fd</td><td>The filedescriptor we should read from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes read on success. < 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a570919eb41d4787291e692f2d9924f74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void iocache_reset </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets an iocache struct, discarding all data in it without free()'ing any memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ioc</td><td>The iocache struct to reset </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a47c6a4d2fe0c3c6b8eeb3253857696c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_resize </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>new_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resizes the buffer in an io cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache to resize </td></tr>
<tr><td class="paramname">new_size</td><td>The new size of the io cache </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a306617113452fe919ed70b7a71179b04"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_sendto </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct sockaddr * </td>
<td class="paramname"><em>dest_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">socklen_t </td>
<td class="paramname"><em>addrlen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Like sendto(), but sends all cached data prior to the requested. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ioc</td><td>The iocache to send, or cache data in </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>The file descriptor to send to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>Pointer to the data to send </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Length (in bytes) of data to send </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Flags passed to sendto(2) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dest_addr</td><td>Destination address </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">addrlen</td><td>size (in bytes) of dest_addr </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bytes sent on success, -ERRNO on errors </dd></dl>
</div>
</div>
<a class="anchor" id="a2f80081c951f3a8ea6d958db40c592ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long iocache_size </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the total size of the io cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ioc</td><td>The iocache to inspect </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The size of the io cache. If ioc is null, 0 is returned </dd></dl>
</div>
</div>
<a class="anchor" id="a42deb8ea8d88b20cb6eabdf40b5a53c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int iocache_unuse_size </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Forget that a specified number of bytes have been used. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache that you want to un-use data in </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes you want to forget you've seen </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-1 if there was an error, 0 otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="ac3bade517d121ec16f8647cd5d06e46e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* iocache_use_delim </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>delim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>delim_len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long * </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use a chunk of data from iocache based on delimiter. </p>
<p>The caller must take care not to write beyond the end of the requested buffer, if any is returned, or Bad Things(tm) will happen.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache to use data from </td></tr>
<tr><td class="paramname">delim</td><td>The delimiter </td></tr>
<tr><td class="paramname">delim_len</td><td>Length of the delimiter </td></tr>
<tr><td class="paramname">size</td><td>Length of the returned buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL on errors (delimiter not found, insufficient data). pointer on success </dd></dl>
</div>
</div>
<a class="anchor" id="a9a515b0146b7054578110c8f0c39321b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* iocache_use_size </td>
<td>(</td>
<td class="paramtype">iocache * </td>
<td class="paramname"><em>ioc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use a chunk of data from iocache based on size. </p>
<p>The caller must take care not to write beyond the end of the requested buffer, or Bad Things(tm) will happen.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ioc</td><td>The io cache we should use data from </td></tr>
<tr><td class="paramname">size</td><td>The size of the data we want returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NULL on errors (insufficient data, fe). pointer on success </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.5
</small></address>
</body>
</html>
Zerion Mini Shell 1.0