/usr/share/doc/libssh-doc/html/group__libssh__messages.html is in libssh-doc 0.6.1-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | <!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.6"/>
<title>libssh: The SSH message 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.6.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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 message functions<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>This file contains the message parsing utilities for client and server programs using libssh.
<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:ga9d1b1d2279c6be3539f2b630960759c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html#ga9d1b1d2279c6be3539f2b630960759c3">ssh_message_free</a> (ssh_message msg)</td></tr>
<tr class="memdesc:ga9d1b1d2279c6be3539f2b630960759c3"><td class="mdescLeft"> </td><td class="mdescRight">Free a SSH message. <a href="#ga9d1b1d2279c6be3539f2b630960759c3">More...</a><br/></td></tr>
<tr class="separator:ga9d1b1d2279c6be3539f2b630960759c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e536b6f1c824b7ca43d0e8f954b3bd4"><td class="memItemLeft" align="right" valign="top">ssh_message </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html#ga8e536b6f1c824b7ca43d0e8f954b3bd4">ssh_message_get</a> (ssh_session session)</td></tr>
<tr class="memdesc:ga8e536b6f1c824b7ca43d0e8f954b3bd4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a SSH message from a SSH session. <a href="#ga8e536b6f1c824b7ca43d0e8f954b3bd4">More...</a><br/></td></tr>
<tr class="separator:ga8e536b6f1c824b7ca43d0e8f954b3bd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7aa19d51c443b779fe454f0be3c666d4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html#ga7aa19d51c443b779fe454f0be3c666d4">ssh_message_subtype</a> (ssh_message msg)</td></tr>
<tr class="memdesc:ga7aa19d51c443b779fe454f0be3c666d4"><td class="mdescLeft"> </td><td class="mdescRight">Get the subtype of the message. <a href="#ga7aa19d51c443b779fe454f0be3c666d4">More...</a><br/></td></tr>
<tr class="separator:ga7aa19d51c443b779fe454f0be3c666d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20fc6e536f170b98c7d62ce3675d8cdb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html#ga20fc6e536f170b98c7d62ce3675d8cdb">ssh_message_type</a> (ssh_message msg)</td></tr>
<tr class="memdesc:ga20fc6e536f170b98c7d62ce3675d8cdb"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the message. <a href="#ga20fc6e536f170b98c7d62ce3675d8cdb">More...</a><br/></td></tr>
<tr class="separator:ga20fc6e536f170b98c7d62ce3675d8cdb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This file contains the message parsing utilities for client and server programs using libssh. </p>
<p>On the server the the main loop of the program will call ssh_message_get(session) to get messages as they come. They are not 1-1 with the protocol messages. Then, the user will know what kind of a message it is and use the appropriate functions to handle it (or use the default handlers if you don't know what to do). </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9d1b1d2279c6be3539f2b630960759c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssh_message_free </td>
<td>(</td>
<td class="paramtype">ssh_message </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a SSH message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to release the memory. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="group__libssh__pki.html#ga08808beb83a42ccd6f1c710ddeb1b4c2">ssh_key_free()</a>.</p>
<p>Referenced by <a class="el" href="group__libssh__session.html#ga0f048a4c0dbe02cfb7e9c5b6d0db0f27">ssh_disconnect()</a>, and <a class="el" href="group__libssh__session.html#gae5af27a98a7488e9f5ded6b37c274156">ssh_free()</a>.</p>
</div>
</div>
<a class="anchor" id="ga8e536b6f1c824b7ca43d0e8f954b3bd4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_message ssh_message_get </td>
<td>(</td>
<td class="paramtype">ssh_session </td>
<td class="paramname"><em>session</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve a SSH message from a SSH session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">session</td><td>The SSH session to get the message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The SSH message received, NULL in case of error, or timeout elapsed.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This function blocks until a message has been received. Betterset up a callback if this behavior is unwanted. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7aa19d51c443b779fe454f0be3c666d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_message_subtype </td>
<td>(</td>
<td class="paramtype">ssh_message </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the subtype of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to get the subtype from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The message type or -1 on error. </dd></dl>
</div>
</div>
<a class="anchor" id="ga20fc6e536f170b98c7d62ce3675d8cdb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_message_type </td>
<td>(</td>
<td class="paramtype">ssh_message </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of the message. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to get the type from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The message type or -1 on error. </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.6
</small></address>
</body>
</html>
|