feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
a66b93d2f31e22ed76f7016046dfe67dcb8da615
qt-creator/src/libs/3rdparty/net7ssh/doc/html/classNe7sshSftpPacket.html
kh1 84732beaf5 Fix wrong folder name.
2010-01-11 18:16:35 +01:00

303 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ne7ssh.kdevelop: Ne7sshSftpPacket Class Reference</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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Ne7sshSftpPacket Class Reference</h1><!-- doxytag: class="Ne7sshSftpPacket" --><!-- doxytag: inherits="ne7ssh_string" --><code>#include &lt;<a class="el" href="ne7ssh__sftp__packet_8h_source.html">ne7ssh_sftp_packet.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Ne7sshSftpPacket:</div>
<div class="dynsection">
<p><center><img src="classNe7sshSftpPacket__inherit__graph.png" border="0" usemap="#Ne7sshSftpPacket__inherit__map" alt="Inheritance graph"></center>
<map name="Ne7sshSftpPacket__inherit__map">
<area shape="rect" href="classne7ssh__string.html" title="ne7ssh_string" alt="" coords="20,7,129,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for Ne7sshSftpPacket:</div>
<div class="dynsection">
<p><center><img src="classNe7sshSftpPacket__coll__graph.png" border="0" usemap="#Ne7sshSftpPacket__coll__map" alt="Collaboration graph"></center>
<map name="Ne7sshSftpPacket__coll__map">
<area shape="rect" href="classne7ssh__string.html" title="ne7ssh_string" alt="" coords="20,7,129,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classNe7sshSftpPacket-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#54df2d3302fdf0e825f4ad1b616cc15c">Ne7sshSftpPacket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#05d7cba2934f1e6f5723e93354d9702e">Ne7sshSftpPacket</a> (int channel)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#d859efc5bffd4d8f052d0dd60cc35f35">Ne7sshSftpPacket</a> (Botan::SecureVector&lt; Botan::byte &gt; &amp;var, uint32 position)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#515d160ed0a9b6d25df767cb57fee7ab">~Ne7sshSftpPacket</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Botan::SecureVector<br class="typebreak">
&lt; Botan::byte &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#a9ad7d742391e82b582bbe92d7733bac">value</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">Botan::SecureVector&lt; Botan::byte &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#9752d881865bf4aa3eb55ce6207a2014">valueFragment</a> (uint32 len=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#fa2cc71f2c697621a22c092a84d4bbbb">addInt64</a> (const uint64 var)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint64&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#49290c1b73cf7cfbe684555e7b125317">getInt64</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNe7sshSftpPacket.html#43daa80040c6c1676f00af013fea566f">isChannelSet</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8049fe9c640a02823af9a4171bd1ba79"></a><!-- doxytag: member="Ne7sshSftpPacket::channel" ref="8049fe9c640a02823af9a4171bd1ba79" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>channel</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Andrew Useckas &lt;<a href="mailto:andrew@netsieben.com">andrew@netsieben.com</a>&gt; </dd></dl>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="54df2d3302fdf0e825f4ad1b616cc15c"></a><!-- doxytag: member="Ne7sshSftpPacket::Ne7sshSftpPacket" ref="54df2d3302fdf0e825f4ad1b616cc15c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ne7sshSftpPacket::Ne7sshSftpPacket </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
</div>
</div><p>
<a class="anchor" name="05d7cba2934f1e6f5723e93354d9702e"></a><!-- doxytag: member="Ne7sshSftpPacket::Ne7sshSftpPacket" ref="05d7cba2934f1e6f5723e93354d9702e" args="(int channel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ne7sshSftpPacket::Ne7sshSftpPacket </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>channel</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>channel</em>&nbsp;</td><td>Channel ID, returned by connect methods. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d859efc5bffd4d8f052d0dd60cc35f35"></a><!-- doxytag: member="Ne7sshSftpPacket::Ne7sshSftpPacket" ref="d859efc5bffd4d8f052d0dd60cc35f35" args="(Botan::SecureVector&lt; Botan::byte &gt; &amp;var, uint32 position)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ne7sshSftpPacket::Ne7sshSftpPacket </td>
<td>(</td>
<td class="paramtype">Botan::SecureVector&lt; Botan::byte &gt; &amp;&nbsp;</td>
<td class="paramname"> <em>var</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32&nbsp;</td>
<td class="paramname"> <em>position</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. Intializes the class with packet data. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>var</em>&nbsp;</td><td>Reference to packet data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>position</em>&nbsp;</td><td>Offset. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="515d160ed0a9b6d25df767cb57fee7ab"></a><!-- doxytag: member="Ne7sshSftpPacket::~Ne7sshSftpPacket" ref="515d160ed0a9b6d25df767cb57fee7ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ne7sshSftpPacket::~Ne7sshSftpPacket </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default destructor.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fa2cc71f2c697621a22c092a84d4bbbb"></a><!-- doxytag: member="Ne7sshSftpPacket::addInt64" ref="fa2cc71f2c697621a22c092a84d4bbbb" args="(const uint64 var)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Ne7sshSftpPacket::addInt64 </td>
<td>(</td>
<td class="paramtype">const uint64&nbsp;</td>
<td class="paramname"> <em>var</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Appends 64 bit integer to the packet buffer. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>var</em>&nbsp;</td><td>64 bit integer. </td></tr>
</table>
</dl>
<p>References <a class="el" href="ne7ssh__string_8cpp_source.html#l00100">ne7ssh_string::addBytes()</a>.</p>
</div>
</div><p>
<a class="anchor" name="49290c1b73cf7cfbe684555e7b125317"></a><!-- doxytag: member="Ne7sshSftpPacket::getInt64" ref="49290c1b73cf7cfbe684555e7b125317" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64 Ne7sshSftpPacket::getInt64 </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves a 64 bit integer from a packet buffer. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Unsigned 64 bit integer. </dd></dl>
<p>Referenced by <a class="el" href="ne7ssh__sftp_8cpp_source.html#l00317">Ne7sshSftp::handleNames()</a>, and <a class="el" href="ne7ssh__sftp_8cpp_source.html#l00362">Ne7sshSftp::processAttrs()</a>.</p>
</div>
</div><p>
<a class="anchor" name="43daa80040c6c1676f00af013fea566f"></a><!-- doxytag: member="Ne7sshSftpPacket::isChannelSet" ref="43daa80040c6c1676f00af013fea566f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Ne7sshSftpPacket::isChannelSet </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if the channel ID is set in the instance. Channel ID is needed to construct a SFTP packet. <dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the channel ID is set. Otherwise false. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a9ad7d742391e82b582bbe92d7733bac"></a><!-- doxytag: member="Ne7sshSftpPacket::value" ref="a9ad7d742391e82b582bbe92d7733bac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Botan::SecureVector&lt; Botan::byte &gt; &amp; Ne7sshSftpPacket::value </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns buffer as a vector appending the SFTP subsystem specific packet headers. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the buffer. </dd></dl>
<p>Reimplemented from <a class="el" href="classne7ssh__string.html#b593c45799f28af90922b7a8332e1a9f">ne7ssh_string</a>.</p>
<p>References <a class="el" href="ne7ssh__string_8cpp_source.html#l00110">ne7ssh_string::addChar()</a>, <a class="el" href="ne7ssh__string_8cpp_source.html#l00115">ne7ssh_string::addInt()</a>, <a class="el" href="ne7ssh__string_8cpp_source.html#l00091">ne7ssh_string::addVectorField()</a>, and <a class="el" href="ne7ssh__string_8h_source.html#l00129">ne7ssh_string::value()</a>.</p>
</div>
</div><p>
<a class="anchor" name="9752d881865bf4aa3eb55ce6207a2014"></a><!-- doxytag: member="Ne7sshSftpPacket::valueFragment" ref="9752d881865bf4aa3eb55ce6207a2014" args="(uint32 len=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Botan::SecureVector&lt; Botan::byte &gt; Ne7sshSftpPacket::valueFragment </td>
<td>(</td>
<td class="paramtype">uint32&nbsp;</td>
<td class="paramname"> <em>len</em> = <code>0</code> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns buffer as a vector appending the SFTP subsystem specific packet headers, including the length in the first packet transmitted. Used in transmissions when it's necessary to split the message into multiple packets. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>len</em>&nbsp;</td><td>Length to append to the first packet in the message. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to SFTP packet or empty vector on error. </dd></dl>
<p>References <a class="el" href="ne7ssh__string_8cpp_source.html#l00110">ne7ssh_string::addChar()</a>, <a class="el" href="ne7ssh__string_8cpp_source.html#l00115">ne7ssh_string::addInt()</a>, <a class="el" href="ne7ssh__string_8cpp_source.html#l00105">ne7ssh_string::addVector()</a>, <a class="el" href="ne7ssh__string_8cpp_source.html#l00091">ne7ssh_string::addVectorField()</a>, and <a class="el" href="ne7ssh__string_8h_source.html#l00129">ne7ssh_string::value()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ne7ssh__sftp__packet_8h_source.html">ne7ssh_sftp_packet.h</a><li>ne7ssh_sftp_packet.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue May 5 14:10:44 2009 for ne7ssh.kdevelop by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
View Git Blame Copy Permalink