buffer__compat_8h.html

<!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" lang="en-US">
<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.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libevent: event2/buffer_compat.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">libevent<span id="projectnumber">&#160;2.2.2</span>
   </div>
   <div id="projectbrief">Event notification library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(function(){initNavTree('buffer__compat_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">buffer_compat.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Obsolete and deprecated versions of the functions in <a class="el" href="buffer_8h.html" title="Functions for buffering data for network sending or receiving.">buffer.h</a>: provided only for backward compatibility.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stddef.h&gt;</code><br />
<code>#include &lt;event2/visibility.h&gt;</code><br />
</div>
<p><a href="buffer__compat_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1c57a451c56dc1483a1c8aaeb9b92cc6" id="r_a1c57a451c56dc1483a1c8aaeb9b92cc6"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#a1c57a451c56dc1483a1c8aaeb9b92cc6">EVBUFFER_DATA</a>(x)</td></tr>
<tr class="memdesc:a1c57a451c56dc1483a1c8aaeb9b92cc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">deprecated in favor of calling the functions directly  <br /></td></tr>
<tr class="memitem:ab8d9564980e380cf1887f2be70f687ad" id="r_ab8d9564980e380cf1887f2be70f687ad"><td class="memItemLeft">#define&#160;</td><td class="memItemRight"><a class="el" href="#ab8d9564980e380cf1887f2be70f687ad">EVBUFFER_LENGTH</a>(x)</td></tr>
<tr class="memdesc:ab8d9564980e380cf1887f2be70f687ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">deprecated in favor of calling the functions directly  <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a6df4ae9e3d819c487ded545d2e1d41b0" id="r_a6df4ae9e3d819c487ded545d2e1d41b0"><td class="memItemLeft">typedef void(*&#160;</td><td class="memItemRight"><a class="el" href="#a6df4ae9e3d819c487ded545d2e1d41b0">evbuffer_cb</a>) (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buffer, size_t old_len, size_t new_len, void *arg)</td></tr>
<tr class="memdesc:a6df4ae9e3d819c487ded545d2e1d41b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type definition for a callback that is invoked whenever data is added or removed from an evbuffer.  <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a619aefdeffb4e0193a1b6eb571eac312" id="r_a619aefdeffb4e0193a1b6eb571eac312"><td class="memItemLeft">EVENT2_EXPORT_SYMBOL unsigned char *&#160;</td><td class="memItemRight"><a class="el" href="#a619aefdeffb4e0193a1b6eb571eac312">evbuffer_find</a> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buffer, const unsigned char *what, size_t len)</td></tr>
<tr class="memdesc:a619aefdeffb4e0193a1b6eb571eac312"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find a string within an evbuffer.  <br /></td></tr>
<tr class="memitem:a2b51bd215fa905472d8986de6388af94" id="r_a2b51bd215fa905472d8986de6388af94"><td class="memItemLeft">EVENT2_EXPORT_SYMBOL char *&#160;</td><td class="memItemRight"><a class="el" href="#a2b51bd215fa905472d8986de6388af94">evbuffer_readline</a> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buffer)</td></tr>
<tr class="memdesc:a2b51bd215fa905472d8986de6388af94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY).  <br /></td></tr>
<tr class="memitem:aaae25109e21cb9f7417922592ed495a4" id="r_aaae25109e21cb9f7417922592ed495a4"><td class="memItemLeft">EVENT2_EXPORT_SYMBOL int&#160;</td><td class="memItemRight"><a class="el" href="#aaae25109e21cb9f7417922592ed495a4">evbuffer_setcb</a> (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buffer, <a class="el" href="#a6df4ae9e3d819c487ded545d2e1d41b0">evbuffer_cb</a> cb, void *cbarg)</td></tr>
<tr class="memdesc:aaae25109e21cb9f7417922592ed495a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace all callbacks on an evbuffer with a single new callback, or remove them.  <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Obsolete and deprecated versions of the functions in <a class="el" href="buffer_8h.html" title="Functions for buffering data for network sending or receiving.">buffer.h</a>: provided only for backward compatibility. </p>
</div><a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="a1c57a451c56dc1483a1c8aaeb9b92cc6" name="a1c57a451c56dc1483a1c8aaeb9b92cc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c57a451c56dc1483a1c8aaeb9b92cc6">&#9670;&#160;</a></span>EVBUFFER_DATA</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define EVBUFFER_DATA</td>
          <td>(</td>
          <td class="paramtype"></td>          <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="buffer_8h.html#a671f10bbc1d4c9ea77d51eb13a58d16b">evbuffer_pullup</a>((x), -1)</div>
<div class="ttc" id="abuffer_8h_html_a671f10bbc1d4c9ea77d51eb13a58d16b"><div class="ttname"><a href="buffer_8h.html#a671f10bbc1d4c9ea77d51eb13a58d16b">evbuffer_pullup</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_pullup(struct evbuffer *buf, ev_ssize_t size)</div><div class="ttdoc">Makes the data at the beginning of an evbuffer contiguous.</div></div>
</div><!-- fragment -->
<p>deprecated in favor of calling the functions directly </p>

</div>
</div>
<a id="ab8d9564980e380cf1887f2be70f687ad" name="ab8d9564980e380cf1887f2be70f687ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8d9564980e380cf1887f2be70f687ad">&#9670;&#160;</a></span>EVBUFFER_LENGTH</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define EVBUFFER_LENGTH</td>
          <td>(</td>
          <td class="paramtype"></td>          <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_function" href="buffer_8h.html#a808db707e84e20229b2aafdcaba6c708">evbuffer_get_length</a>(x)</div>
<div class="ttc" id="abuffer_8h_html_a808db707e84e20229b2aafdcaba6c708"><div class="ttname"><a href="buffer_8h.html#a808db707e84e20229b2aafdcaba6c708">evbuffer_get_length</a></div><div class="ttdeci">EVENT2_EXPORT_SYMBOL size_t evbuffer_get_length(const struct evbuffer *buf)</div><div class="ttdoc">Returns the total number of bytes stored in the evbuffer.</div></div>
</div><!-- fragment -->
<p>deprecated in favor of calling the functions directly </p>

</div>
</div>
<a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
<a id="a6df4ae9e3d819c487ded545d2e1d41b0" name="a6df4ae9e3d819c487ded545d2e1d41b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6df4ae9e3d819c487ded545d2e1d41b0">&#9670;&#160;</a></span>evbuffer_cb</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* evbuffer_cb) (struct <a class="el" href="structevbuffer.html">evbuffer</a> *buffer, size_t old_len, size_t new_len, void *arg)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type definition for a callback that is invoked whenever data is added or removed from an evbuffer. </p>
<p>An evbuffer may have one or more callbacks set at a time. The order in which they are executed is undefined.</p>
<p>A callback function may add more callbacks, or remove itself from the list of callbacks, or add or remove data from the buffer. It may not remove another callback from the list.</p>
<p>If a callback adds or removes data from the buffer or from another buffer, this can cause a recursive invocation of your callback or other callbacks. If you ask for an infinite loop, you might just get one: watch out!</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>the buffer whose size has changed </td></tr>
    <tr><td class="paramname">old_len</td><td>the previous length of the buffer </td></tr>
    <tr><td class="paramname">new_len</td><td>the current length of the buffer </td></tr>
    <tr><td class="paramname">arg</td><td>a pointer to user data </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a619aefdeffb4e0193a1b6eb571eac312" name="a619aefdeffb4e0193a1b6eb571eac312"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a619aefdeffb4e0193a1b6eb571eac312">&#9670;&#160;</a></span>evbuffer_find()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EVENT2_EXPORT_SYMBOL unsigned char * evbuffer_find </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structevbuffer.html">evbuffer</a> *</td>          <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const unsigned char *</td>          <td class="paramname"><span class="paramname"><em>what</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>len</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find a string within an evbuffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>the evbuffer to be searched </td></tr>
    <tr><td class="paramname">what</td><td>the string to be searched for </td></tr>
    <tr><td class="paramname">len</td><td>the length of the search string </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the beginning of the search string, or NULL if the search failed. </dd></dl>

</div>
</div>
<a id="a2b51bd215fa905472d8986de6388af94" name="a2b51bd215fa905472d8986de6388af94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b51bd215fa905472d8986de6388af94">&#9670;&#160;</a></span>evbuffer_readline()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EVENT2_EXPORT_SYMBOL char * evbuffer_readline </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structevbuffer.html">evbuffer</a> *</td>          <td class="paramname"><span class="paramname"><em>buffer</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Obsolete alias for evbuffer_readln(buffer, NULL, EVBUFFER_EOL_ANY). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated</a></b></dt><dd>This function is deprecated because its behavior is not correct for almost any protocol, and also because it's wholly subsumed by <a class="el" href="buffer_8h.html#a5448ad62cdda5b74264fefc4f4f8ea91" title="Read a single line from an evbuffer.">evbuffer_readln()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>the evbuffer to read from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to a single line, or NULL if an error occurred </dd></dl>

</div>
</div>
<a id="aaae25109e21cb9f7417922592ed495a4" name="aaae25109e21cb9f7417922592ed495a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaae25109e21cb9f7417922592ed495a4">&#9670;&#160;</a></span>evbuffer_setcb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EVENT2_EXPORT_SYMBOL int evbuffer_setcb </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structevbuffer.html">evbuffer</a> *</td>          <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="#a6df4ae9e3d819c487ded545d2e1d41b0">evbuffer_cb</a></td>          <td class="paramname"><span class="paramname"><em>cb</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>cbarg</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Replace all callbacks on an evbuffer with a single new callback, or remove them. </p>
<p>Subsequent calls to <a class="el" href="#aaae25109e21cb9f7417922592ed495a4" title="Replace all callbacks on an evbuffer with a single new callback, or remove them.">evbuffer_setcb()</a> replace callbacks set by previous calls. Setting the callback to NULL removes any previously set callback.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated</a></b></dt><dd>This function is deprecated because it clears all previous callbacks set on the evbuffer, which can cause confusing behavior if multiple parts of the code all want to add their own callbacks on a buffer. Instead, use <a class="el" href="buffer_8h.html#a8abedc30187fe00d86b7b1cc4d3ce643" title="Append data to the end of an evbuffer.">evbuffer_add()</a>, evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>the evbuffer to be monitored </td></tr>
    <tr><td class="paramname">cb</td><td>the callback function to invoke when the evbuffer is modified, or NULL to remove all callbacks. </td></tr>
    <tr><td class="paramname">cbarg</td><td>an argument to be provided to the callback function </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or -1 on error </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>event2</b></li><li class="navelem"><a href="buffer__compat_8h.html">buffer_compat.h</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
  </ul>
</div>
</body>
</html>