<!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.3.1"/>
<title>libssh: The SSH buffer functions.</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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libssh
 <span id="projectnumber">0.5.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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="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>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The SSH buffer functions.<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions to handle SSH buffers.
<a href="#details">More...</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:ga608cf73226454f21e8b2f9f1d838c5fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html#ga608cf73226454f21e8b2f9f1d838c5fc">ssh_buffer_free</a> (struct ssh_buffer_struct *buffer)</td></tr>
<tr class="memdesc:ga608cf73226454f21e8b2f9f1d838c5fc"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate a SSH buffer. <a href="#ga608cf73226454f21e8b2f9f1d838c5fc">More...</a><br/></td></tr>
<tr class="separator:ga608cf73226454f21e8b2f9f1d838c5fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4e6c650c6361809182bc2fa4e0cde982"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html#ga4e6c650c6361809182bc2fa4e0cde982">ssh_buffer_get_begin</a> (struct ssh_buffer_struct *buffer)</td></tr>
<tr class="memdesc:ga4e6c650c6361809182bc2fa4e0cde982"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer on the head of a buffer. <a href="#ga4e6c650c6361809182bc2fa4e0cde982">More...</a><br/></td></tr>
<tr class="separator:ga4e6c650c6361809182bc2fa4e0cde982"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1594908ed57799f4a84066f47c3e7c0"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html#gad1594908ed57799f4a84066f47c3e7c0">ssh_buffer_get_len</a> (struct ssh_buffer_struct *buffer)</td></tr>
<tr class="memdesc:gad1594908ed57799f4a84066f47c3e7c0"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the buffer, not counting position. <a href="#gad1594908ed57799f4a84066f47c3e7c0">More...</a><br/></td></tr>
<tr class="separator:gad1594908ed57799f4a84066f47c3e7c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ecc914104a5bf0da485d3e42f6a7d3b"><td class="memItemLeft" align="right" valign="top">struct ssh_buffer_struct * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html#ga7ecc914104a5bf0da485d3e42f6a7d3b">ssh_buffer_new</a> (void)</td></tr>
<tr class="memdesc:ga7ecc914104a5bf0da485d3e42f6a7d3b"><td class="mdescLeft"> </td><td class="mdescRight">Create a new SSH buffer. <a href="#ga7ecc914104a5bf0da485d3e42f6a7d3b">More...</a><br/></td></tr>
<tr class="separator:ga7ecc914104a5bf0da485d3e42f6a7d3b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to handle SSH buffers. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga608cf73226454f21e8b2f9f1d838c5fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssh_buffer_free </td>
<td>(</td>
<td class="paramtype">struct ssh_buffer_struct * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deallocate a SSH buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer to free. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__libssh__auth.html#ga40c8ac05358aa941496fd1243ac9ee00">publickey_from_file()</a>, <a class="el" href="group__libssh__auth.html#ga1bd48caa6d4fc91a0cbedd04ba56f901">publickey_to_string()</a>, <a class="el" href="group__libssh__channel.html#gaf5d55c90f3d98c583df23d21905c1127">ssh_channel_change_pty_size()</a>, <a class="el" href="group__libssh__channel.html#gad1417f9eae8928fed20faafe2d9dbfff">ssh_channel_free()</a>, <a class="el" href="group__libssh__channel.html#gada8ccda7bf65165fe145d3096a252dcc">ssh_channel_new()</a>, <a class="el" href="group__libssh__channel.html#gae86b0704a1f2bdebb268b55567f7f47b">ssh_channel_open_forward()</a>, <a class="el" href="group__libssh__channel.html#ga7aede2f9af4c494ff9e41fc08a4572f1">ssh_channel_request_env()</a>, <a class="el" href="group__libssh__channel.html#ga567d509183ade0a77190f390e2b5747d">ssh_channel_request_exec()</a>, <a class="el" href="group__libssh__channel.html#gabb175414352256e1602286e0ab50886c">ssh_channel_request_pty_size()</a>, <a class="el" href="group__libssh__channel.html#gaa98315fca818b561970a6950683f4053">ssh_channel_request_send_signal()</a>, <a class="el" href="group__libssh__channel.html#ga06024b070f9b2a3d6964b79ae36695b7">ssh_channel_request_subsystem()</a>, <a class="el" href="group__libssh__channel.html#gadfa34624c28164bd73453cd04aa64c1f">ssh_channel_request_x11()</a>, <a class="el" href="group__libssh__channel.html#gac474d071d80e725c8b5633cb1d35c010">ssh_forward_cancel()</a>, <a class="el" href="group__libssh__channel.html#ga041a495f0230bb017cdf7459e6773664">ssh_forward_listen()</a>, and <a class="el" href="group__libssh__session.html#gae5af27a98a7488e9f5ded6b37c274156">ssh_free()</a>.</p>
</div>
</div>
<a class="anchor" id="ga4e6c650c6361809182bc2fa4e0cde982"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ssh_buffer_get_begin </td>
<td>(</td>
<td class="paramtype">struct ssh_buffer_struct * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer on the head of a buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer to get the head pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A data pointer on the head. It doesn't take the position into account.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Don't expect data to be nul-terminated.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>buffer_get_rest() </dd>
<dd>
buffer_get_len() </dd></dl>
</div>
</div>
<a class="anchor" id="gad1594908ed57799f4a84066f47c3e7c0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ssh_buffer_get_len </td>
<td>(</td>
<td class="paramtype">struct ssh_buffer_struct * </td>
<td class="paramname"><em>buffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the length of the buffer, not counting position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer to get the length from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The length of the buffer.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>buffer_get() </dd></dl>
</div>
</div>
<a class="anchor" id="ga7ecc914104a5bf0da485d3e42f6a7d3b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">struct ssh_buffer_struct* ssh_buffer_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new SSH buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>A newly initialized SSH buffer, NULL on error. </dd></dl>
<p>Referenced by <a class="el" href="group__libssh__auth.html#ga1bd48caa6d4fc91a0cbedd04ba56f901">publickey_to_string()</a>, <a class="el" href="group__libssh__channel.html#gaf5d55c90f3d98c583df23d21905c1127">ssh_channel_change_pty_size()</a>, <a class="el" href="group__libssh__channel.html#gada8ccda7bf65165fe145d3096a252dcc">ssh_channel_new()</a>, <a class="el" href="group__libssh__channel.html#gae86b0704a1f2bdebb268b55567f7f47b">ssh_channel_open_forward()</a>, <a class="el" href="group__libssh__channel.html#ga7aede2f9af4c494ff9e41fc08a4572f1">ssh_channel_request_env()</a>, <a class="el" href="group__libssh__channel.html#ga567d509183ade0a77190f390e2b5747d">ssh_channel_request_exec()</a>, <a class="el" href="group__libssh__channel.html#gabb175414352256e1602286e0ab50886c">ssh_channel_request_pty_size()</a>, <a class="el" href="group__libssh__channel.html#gaa98315fca818b561970a6950683f4053">ssh_channel_request_send_signal()</a>, <a class="el" href="group__libssh__channel.html#ga06024b070f9b2a3d6964b79ae36695b7">ssh_channel_request_subsystem()</a>, <a class="el" href="group__libssh__channel.html#gadfa34624c28164bd73453cd04aa64c1f">ssh_channel_request_x11()</a>, <a class="el" href="group__libssh__channel.html#gac474d071d80e725c8b5633cb1d35c010">ssh_forward_cancel()</a>, <a class="el" href="group__libssh__channel.html#ga041a495f0230bb017cdf7459e6773664">ssh_forward_listen()</a>, and <a class="el" href="group__libssh__session.html#gaadadc0f9601547c30db7c4d62017d32c">ssh_new()</a>.</p>
</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.3.1
</small></address>
</body>
</html>
