<!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: include/libssh/buffer.h Source File</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 class="current"><a href="files.html"><span>Files</span></a></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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b9682cd10a3f48e47321de8901f87a77.html">libssh</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">buffer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of the SSH Library</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2009 by Aris Adamantiadis</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * The SSH Library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or (at your</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The SSH Library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with the SSH Library; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MA 02111-1307, USA.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef BUFFER_H_</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define BUFFER_H_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "libssh/libssh.h"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Describes a buffer state</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * [XXXXXXXXXXXXDATA PAYLOAD XXXXXXXXXXXXXXXXXXXXXXXX]</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * ^ ^ ^ ^]</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * \_data points\_pos points here \_used points here | /</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * here Allocated</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">struct </span>ssh_buffer_struct {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">char</span> *data;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  uint32_t used;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  uint32_t allocated;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint32_t pos;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> LIBSSH_API <span class="keywordtype">void</span> <a class="code" href="group__libssh__buffer.html#ga608cf73226454f21e8b2f9f1d838c5fc" title="Deallocate a SSH buffer.">ssh_buffer_free</a>(ssh_buffer buffer);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> LIBSSH_API <span class="keywordtype">void</span> *<a class="code" href="group__libssh__buffer.html#ga4e6c650c6361809182bc2fa4e0cde982" title="Get a pointer on the head of a buffer.">ssh_buffer_get_begin</a>(ssh_buffer buffer);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> LIBSSH_API uint32_t <a class="code" href="group__libssh__buffer.html#gad1594908ed57799f4a84066f47c3e7c0" title="Get the length of the buffer, not counting position.">ssh_buffer_get_len</a>(ssh_buffer buffer);</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> LIBSSH_API ssh_buffer <a class="code" href="group__libssh__buffer.html#ga7ecc914104a5bf0da485d3e42f6a7d3b" title="Create a new SSH buffer.">ssh_buffer_new</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">int</span> buffer_add_ssh_string(ssh_buffer buffer, ssh_string <span class="keywordtype">string</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">int</span> buffer_add_u8(ssh_buffer buffer, uint8_t data);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">int</span> buffer_add_u16(ssh_buffer buffer, uint16_t data);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">int</span> buffer_add_u32(ssh_buffer buffer, uint32_t data);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">int</span> buffer_add_u64(ssh_buffer buffer, uint64_t data);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">int</span> buffer_add_data(ssh_buffer buffer, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint32_t len);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">int</span> buffer_prepend_data(ssh_buffer buffer, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint32_t len);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">int</span> buffer_add_buffer(ssh_buffer buffer, ssh_buffer source);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">int</span> buffer_reinit(ssh_buffer buffer);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/* buffer_get_rest returns a pointer to the current position into the buffer */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> *buffer_get_rest(ssh_buffer buffer);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">/* buffer_get_rest_len returns the number of bytes which can be read */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> uint32_t buffer_get_rest_len(ssh_buffer buffer);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/* buffer_read_*() returns the number of bytes read, except for ssh strings */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">int</span> buffer_get_u8(ssh_buffer buffer, uint8_t *data);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">int</span> buffer_get_u32(ssh_buffer buffer, uint32_t *data);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">int</span> buffer_get_u64(ssh_buffer buffer, uint64_t *data);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> uint32_t buffer_get_data(ssh_buffer buffer, <span class="keywordtype">void</span> *data, uint32_t requestedlen);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">/* buffer_get_ssh_string() is an exception. if the String read is too large or invalid, it will answer NULL. */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> ssh_string buffer_get_ssh_string(ssh_buffer buffer);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/* gets a string out of a SSH-1 mpint */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> ssh_string buffer_get_mpint(ssh_buffer buffer);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/* buffer_pass_bytes acts as if len bytes have been read (used for padding) */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> uint32_t buffer_pass_bytes_end(ssh_buffer buffer, uint32_t len);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> uint32_t buffer_pass_bytes(ssh_buffer buffer, uint32_t len);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif </span><span class="comment">/* BUFFER_H_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></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>
