<!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/callbacks.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">callbacks.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 Aris Adamantiadis <aris@0xbadc0de.be></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="comment">/* callback.h</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * This file includes the public declarations for the libssh callback mechanism</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> */</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef _SSH_CALLBACK_H</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor">#define _SSH_CALLBACK_H</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <libssh/libssh.h></span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <string.h></span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">typedef</span> void (*ssh_callback_int) (<span class="keywordtype">int</span> code, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">typedef</span> int (*ssh_callback_data) (<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">typedef</span> void (*ssh_callback_int_int) (<span class="keywordtype">int</span> code, <span class="keywordtype">int</span> errno_code, <span class="keywordtype">void</span> *user);</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> <span class="keyword">typedef</span> int (*ssh_message_callback) (ssh_session, ssh_message message, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">typedef</span> int (*ssh_channel_callback_int) (ssh_channel channel, <span class="keywordtype">int</span> code, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">typedef</span> int (*ssh_channel_callback_data) (ssh_channel channel, <span class="keywordtype">int</span> code, <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00081"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga7c6a9d477c59ee65b3c03d77b510595f"> 81</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__libssh__callbacks.html#ga7c6a9d477c59ee65b3c03d77b510595f" title="SSH authentication callback.">ssh_auth_callback</a>) (<span class="keyword">const</span> <span class="keywordtype">char</span> *prompt, <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> len,</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">int</span> echo, <span class="keywordtype">int</span> verify, <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00090"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#gad1b724cd0c1cfb92e80ce4f51cadfdfd"> 90</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#gad1b724cd0c1cfb92e80ce4f51cadfdfd" title="SSH log callback.">ssh_log_callback</a>) (ssh_session session, <span class="keywordtype">int</span> priority,</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *message, <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga2c8dca5a8a40b6e567a1a01c28c01804"> 100</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga2c8dca5a8a40b6e567a1a01c28c01804" title="SSH Connection status callback.">ssh_status_callback</a>) (ssh_session session, <span class="keywordtype">float</span> status,</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div> <div class="line"><a name="l00110"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga649b6ab88336adf945a0def9efb80fbe"> 110</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga649b6ab88336adf945a0def9efb80fbe" title="SSH global request callback.">ssh_global_request_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  ssh_message message, <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html"> 116</a></span> <span class="keyword">struct </span><a class="code" href="structssh__callbacks__struct.html" title="The structure to replace libssh functions with appropriate callbacks.">ssh_callbacks_struct</a> {</div> <div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#a2c3e59dff4f356957397d15a5f4d3659"> 118</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structssh__callbacks__struct.html#a2c3e59dff4f356957397d15a5f4d3659" title="DON'T SET THIS use ssh_callbacks_init() instead.">size</a>;</div> <div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#a319d5838c0e75ed3917ea5021a3f8448"> 122</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structssh__callbacks__struct.html#a319d5838c0e75ed3917ea5021a3f8448" title="User-provided data.">userdata</a>;</div> <div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#a5f68540b4661f1c8c31a964007a751ef"> 126</a></span>  <a class="code" href="group__libssh__callbacks.html#ga7c6a9d477c59ee65b3c03d77b510595f" title="SSH authentication callback.">ssh_auth_callback</a> <a class="code" href="structssh__callbacks__struct.html#a5f68540b4661f1c8c31a964007a751ef" title="This functions will be called if e.g.">auth_function</a>;</div> <div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#aa81100c9902b615ec4b1657922d9dff0"> 130</a></span>  <a class="code" href="group__libssh__callbacks.html#gad1b724cd0c1cfb92e80ce4f51cadfdfd" title="SSH log callback.">ssh_log_callback</a> <a class="code" href="structssh__callbacks__struct.html#aa81100c9902b615ec4b1657922d9dff0" title="This function will be called each time a loggable event happens.">log_function</a>;</div> <div class="line"><a name="l00135"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#aee7d6e46d09a338031e09d5f59a79839"> 135</a></span>  void (*<a class="code" href="structssh__callbacks__struct.html#aee7d6e46d09a338031e09d5f59a79839" title="This function gets called during connection time to indicate the percentage of connection steps compl...">connect_status_function</a>)(<span class="keywordtype">void</span> *<a class="code" href="structssh__callbacks__struct.html#a319d5838c0e75ed3917ea5021a3f8448" title="User-provided data.">userdata</a>, <span class="keywordtype">float</span> status);</div> <div class="line"><a name="l00139"></a><span class="lineno"><a class="code" href="structssh__callbacks__struct.html#a5c43f825b0a857a5d537d229f83a1eec"> 139</a></span>  <a class="code" href="group__libssh__callbacks.html#ga649b6ab88336adf945a0def9efb80fbe" title="SSH global request callback.">ssh_global_request_callback</a> <a class="code" href="structssh__callbacks__struct.html#a5c43f825b0a857a5d537d229f83a1eec" title="This function will be called each time a global request is received.">global_request_function</a>;</div> <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> };</div> <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structssh__callbacks__struct.html" title="The structure to replace libssh functions with appropriate callbacks.">ssh_callbacks_struct</a> *ssh_callbacks;</div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> <div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html"> 147</a></span> <span class="keyword">struct </span><a class="code" href="structssh__socket__callbacks__struct.html" title="These are the callbacks exported by the socket structure They are called by the socket module when a ...">ssh_socket_callbacks_struct</a> {</div> <div class="line"><a name="l00151"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html#a95c6b5344b5af43e28402419f24304bb"> 151</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structssh__socket__callbacks__struct.html#a95c6b5344b5af43e28402419f24304bb" title="User-provided data.">userdata</a>;</div> <div class="line"><a name="l00156"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html#a847925e298ebc2cf424e35f782c27bd1"> 156</a></span>  ssh_callback_data <a class="code" href="structssh__socket__callbacks__struct.html#a847925e298ebc2cf424e35f782c27bd1" title="This function will be called each time data appears on socket.">data</a>;</div> <div class="line"><a name="l00160"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html#ae46949c0769fcdce94280888a3301d2d"> 160</a></span>  ssh_callback_int <a class="code" href="structssh__socket__callbacks__struct.html#ae46949c0769fcdce94280888a3301d2d" title="This function will be called each time a controlflow state changes, i.e.">controlflow</a>;</div> <div class="line"><a name="l00164"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html#a9683522c399bbfe7116e2cda2c357478"> 164</a></span>  ssh_callback_int_int <a class="code" href="structssh__socket__callbacks__struct.html#a9683522c399bbfe7116e2cda2c357478" title="This function will be called each time an exception appears on socket.">exception</a>;</div> <div class="line"><a name="l00168"></a><span class="lineno"><a class="code" href="structssh__socket__callbacks__struct.html#aea8fb026a6859ad8c6a115f4698243a6"> 168</a></span>  ssh_callback_int_int <a class="code" href="structssh__socket__callbacks__struct.html#aea8fb026a6859ad8c6a115f4698243a6" title="This function is called when the ssh_socket_connect was used on the socket on nonblocking state...">connected</a>;</div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span> };</div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structssh__socket__callbacks__struct.html" title="These are the callbacks exported by the socket structure They are called by the socket module when a ...">ssh_socket_callbacks_struct</a> *ssh_socket_callbacks;</div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="preprocessor">#define SSH_SOCKET_FLOW_WRITEWILLBLOCK 1</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_SOCKET_FLOW_WRITEWONTBLOCK 2</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#define SSH_SOCKET_EXCEPTION_EOF 1</span></div> <div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_SOCKET_EXCEPTION_ERROR 2</span></div> <div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="preprocessor">#define SSH_SOCKET_CONNECTED_OK 1</span></div> <div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_SOCKET_CONNECTED_ERROR 2</span></div> <div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="preprocessor"></span><span class="preprocessor">#define SSH_SOCKET_CONNECTED_TIMEOUT 3</span></div> <div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00189"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#gafe09b81e5346f0babe288dc38113d289"> 189</a></span> <span class="preprocessor">#define ssh_callbacks_init(p) do {\</span></div> <div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="preprocessor"> (p)->size=sizeof(*(p)); \</span></div> <div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="preprocessor">} while(0);</span></div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="preprocessor">#define ssh_callbacks_exists(p,c) (\</span></div> <div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="preprocessor"> (p != NULL) && ( (char *)&((p)-> c) < (char *)(p) + (p)->size ) && \</span></div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="preprocessor"> ((p)-> c != NULL) \</span></div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="preprocessor"> )</span></div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00216"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga41076189f34fb00a54bc54f58832fbae"> 216</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__libssh__callbacks.html#ga41076189f34fb00a54bc54f58832fbae" title="Prototype for a packet callback, to be called when a new packet arrives.">ssh_packet_callback</a>) (ssh_session session, uint8_t type, ssh_buffer packet, <span class="keywordtype">void</span> *user);</div> <div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div> <div class="line"><a name="l00220"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#gac29df803aa1295d6a498c1b081f3b494"> 220</a></span> <span class="preprocessor">#define SSH_PACKET_USED 1</span></div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00223"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga4766917128a12b646a8aee7ebc019f8c"> 223</a></span> <span class="preprocessor">#define SSH_PACKET_NOT_USED 2</span></div> <div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div> <div class="line"><a name="l00233"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b"> 233</a></span> <span class="preprocessor">#define SSH_PACKET_CALLBACK(name) \</span></div> <div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor"> int name (ssh_session session, uint8_t type, ssh_buffer packet, void *user)</span></div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="keyword">struct </span>ssh_packet_callbacks_struct {</div> <div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  uint8_t start;</div> <div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  uint8_t n_callbacks;</div> <div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <a class="code" href="group__libssh__callbacks.html#ga41076189f34fb00a54bc54f58832fbae" title="Prototype for a packet callback, to be called when a new packet arrives.">ssh_packet_callback</a> *callbacks;</div> <div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keywordtype">void</span> *user;</div> <div class="line"><a name="l00247"></a><span class="lineno"> 247</span> };</div> <div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>ssh_packet_callbacks_struct *ssh_packet_callbacks;</div> <div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div> <div class="line"><a name="l00272"></a><span class="lineno"> 272</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__callbacks.html#ga2e4b0507c738748a3f10e43fe201fe09" title="Set the session callback functions.">ssh_set_callbacks</a>(ssh_session session, ssh_callbacks cb);</div> <div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div> <div class="line"><a name="l00283"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga2676f5018fc9a7a4034527a38636c1cb"> 283</a></span> <span class="keyword">typedef</span> int (*<a class="code" href="group__libssh__callbacks.html#ga2676f5018fc9a7a4034527a38636c1cb" title="SSH channel data callback.">ssh_channel_data_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  ssh_channel channel,</div> <div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordtype">void</span> *data,</div> <div class="line"><a name="l00286"></a><span class="lineno"> 286</span>  uint32_t len,</div> <div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="keywordtype">int</span> is_stderr,</div> <div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00289"></a><span class="lineno"> 289</span> </div> <div class="line"><a name="l00296"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga0b5a09075bab3711b50d079d403eded5"> 296</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga0b5a09075bab3711b50d079d403eded5" title="SSH channel eof callback.">ssh_channel_eof_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  ssh_channel channel,</div> <div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div> <div class="line"><a name="l00306"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga6dd3c923f67d136837394cf53cc281ca"> 306</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga6dd3c923f67d136837394cf53cc281ca" title="SSH channel close callback.">ssh_channel_close_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  ssh_channel channel,</div> <div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00309"></a><span class="lineno"> 309</span> </div> <div class="line"><a name="l00317"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga56787ff30d1f2a76dafc4f7cd1744ae7"> 317</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga56787ff30d1f2a76dafc4f7cd1744ae7" title="SSH channel signal callback.">ssh_channel_signal_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  ssh_channel channel,</div> <div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *signal,</div> <div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div> <div class="line"><a name="l00328"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#gabad42498382063acdcd67dc931d67f9f"> 328</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#gabad42498382063acdcd67dc931d67f9f" title="SSH channel exit status callback.">ssh_channel_exit_status_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  ssh_channel channel,</div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span>  <span class="keywordtype">int</span> exit_status,</div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span> </div> <div class="line"><a name="l00343"></a><span class="lineno"><a class="code" href="group__libssh__callbacks.html#ga9ea789f1b8b71edf89b86a0af810cd0e"> 343</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__libssh__callbacks.html#ga9ea789f1b8b71edf89b86a0af810cd0e" title="SSH channel exit signal callback.">ssh_channel_exit_signal_callback</a>) (ssh_session session,</div> <div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  ssh_channel channel,</div> <div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *signal,</div> <div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  <span class="keywordtype">int</span> core,</div> <div class="line"><a name="l00347"></a><span class="lineno"> 347</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *errmsg,</div> <div class="line"><a name="l00348"></a><span class="lineno"> 348</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *lang,</div> <div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  <span class="keywordtype">void</span> *userdata);</div> <div class="line"><a name="l00350"></a><span class="lineno"> 350</span> </div> <div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="keyword">struct </span>ssh_channel_callbacks_struct {</div> <div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  <span class="keywordtype">size_t</span> size;</div> <div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  <span class="keywordtype">void</span> *userdata;</div> <div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <a class="code" href="group__libssh__callbacks.html#ga2676f5018fc9a7a4034527a38636c1cb" title="SSH channel data callback.">ssh_channel_data_callback</a> channel_data_function;</div> <div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  <a class="code" href="group__libssh__callbacks.html#ga0b5a09075bab3711b50d079d403eded5" title="SSH channel eof callback.">ssh_channel_eof_callback</a> channel_eof_function;</div> <div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  <a class="code" href="group__libssh__callbacks.html#ga6dd3c923f67d136837394cf53cc281ca" title="SSH channel close callback.">ssh_channel_close_callback</a> channel_close_function;</div> <div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <a class="code" href="group__libssh__callbacks.html#ga56787ff30d1f2a76dafc4f7cd1744ae7" title="SSH channel signal callback.">ssh_channel_signal_callback</a> channel_signal_function;</div> <div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  <a class="code" href="group__libssh__callbacks.html#gabad42498382063acdcd67dc931d67f9f" title="SSH channel exit status callback.">ssh_channel_exit_status_callback</a> channel_exit_status_function;</div> <div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  <a class="code" href="group__libssh__callbacks.html#ga9ea789f1b8b71edf89b86a0af810cd0e" title="SSH channel exit signal callback.">ssh_channel_exit_signal_callback</a> channel_exit_signal_function;</div> <div class="line"><a name="l00382"></a><span class="lineno"> 382</span> };</div> <div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>ssh_channel_callbacks_struct *ssh_channel_callbacks;</div> <div class="line"><a name="l00384"></a><span class="lineno"> 384</span> </div> <div class="line"><a name="l00406"></a><span class="lineno"> 406</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__callbacks.html#gacea52d1373970a4922bf60e6b1680919" title="Set the channel callback functions.">ssh_set_channel_callbacks</a>(ssh_channel channel,</div> <div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  ssh_channel_callbacks cb);</div> <div class="line"><a name="l00408"></a><span class="lineno"> 408</span> </div> <div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="keyword">typedef</span> int (*ssh_thread_callback) (<span class="keywordtype">void</span> **lock);</div> <div class="line"><a name="l00416"></a><span class="lineno"> 416</span> </div> <div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> long (*ssh_thread_id_callback) (void);</div> <div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="keyword">struct </span>ssh_threads_callbacks_struct {</div> <div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *type;</div> <div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  ssh_thread_callback mutex_init;</div> <div class="line"><a name="l00421"></a><span class="lineno"> 421</span>  ssh_thread_callback mutex_destroy;</div> <div class="line"><a name="l00422"></a><span class="lineno"> 422</span>  ssh_thread_callback mutex_lock;</div> <div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  ssh_thread_callback mutex_unlock;</div> <div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  ssh_thread_id_callback thread_id;</div> <div class="line"><a name="l00425"></a><span class="lineno"> 425</span> };</div> <div class="line"><a name="l00426"></a><span class="lineno"> 426</span> </div> <div class="line"><a name="l00437"></a><span class="lineno"> 437</span> LIBSSH_API <span class="keywordtype">int</span> <a class="code" href="group__libssh__threads.html#gaf473af3fbae6f1bb0e249fd1d079ff68" title="sets the thread callbacks necessary if your program is using libssh in a multithreaded fashion...">ssh_threads_set_callbacks</a>(<span class="keyword">struct</span> ssh_threads_callbacks_struct</div> <div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  *cb);</div> <div class="line"><a name="l00439"></a><span class="lineno"> 439</span> </div> <div class="line"><a name="l00446"></a><span class="lineno"> 446</span> LIBSSH_API <span class="keyword">struct </span>ssh_threads_callbacks_struct *ssh_threads_get_pthread(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00447"></a><span class="lineno"> 447</span> </div> <div class="line"><a name="l00454"></a><span class="lineno"> 454</span> LIBSSH_API <span class="keyword">struct </span>ssh_threads_callbacks_struct *<a class="code" href="group__libssh__threads.html#ga10fa1f7243c94524b734a96963818c5b" title="returns a pointer on the noop threads callbacks, to be used with ssh_threads_set_callbacks.">ssh_threads_get_noop</a>(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00455"></a><span class="lineno"> 455</span> </div> <div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="preprocessor">#ifdef __cplusplus</span></div> <div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="preprocessor"></span>}</div> <div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor">#endif </span><span class="comment">/*_SSH_CALLBACK_H */</span><span class="preprocessor"></span></div> <div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment">/* @} */</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>