<!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: ssh_socket_callbacks Struct Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ssh_socket_callbacks Struct Reference<div class="ingroups"><a class="el" href="group__libssh__callbacks.html">The libssh callbacks</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>These are the callbacks exported by the socket structure They are called by the socket module when a socket event appears.
<a href="structssh__socket__callbacks__struct.html#details">More...</a></p>
<p><code>#include <<a class="el" href="callbacks_8h_source.html">include/libssh/callbacks.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aea8fb026a6859ad8c6a115f4698243a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea8fb026a6859ad8c6a115f4698243a6"></a>
ssh_callback_int_int </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#aea8fb026a6859ad8c6a115f4698243a6">connected</a></td></tr>
<tr class="memdesc:aea8fb026a6859ad8c6a115f4698243a6"><td class="mdescLeft"> </td><td class="mdescRight">This function is called when the ssh_socket_connect was used on the socket on nonblocking state, and the connection successed. <br/></td></tr>
<tr class="separator:aea8fb026a6859ad8c6a115f4698243a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae46949c0769fcdce94280888a3301d2d"><td class="memItemLeft" align="right" valign="top">ssh_callback_int </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#ae46949c0769fcdce94280888a3301d2d">controlflow</a></td></tr>
<tr class="memdesc:ae46949c0769fcdce94280888a3301d2d"><td class="mdescLeft"> </td><td class="mdescRight">This function will be called each time a controlflow state changes, i.e. <a href="#ae46949c0769fcdce94280888a3301d2d">More...</a><br/></td></tr>
<tr class="separator:ae46949c0769fcdce94280888a3301d2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a847925e298ebc2cf424e35f782c27bd1"><td class="memItemLeft" align="right" valign="top">ssh_callback_data </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#a847925e298ebc2cf424e35f782c27bd1">data</a></td></tr>
<tr class="memdesc:a847925e298ebc2cf424e35f782c27bd1"><td class="mdescLeft"> </td><td class="mdescRight">This function will be called each time data appears on socket. <a href="#a847925e298ebc2cf424e35f782c27bd1">More...</a><br/></td></tr>
<tr class="separator:a847925e298ebc2cf424e35f782c27bd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9683522c399bbfe7116e2cda2c357478"><td class="memItemLeft" align="right" valign="top">ssh_callback_int_int </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#a9683522c399bbfe7116e2cda2c357478">exception</a></td></tr>
<tr class="memdesc:a9683522c399bbfe7116e2cda2c357478"><td class="mdescLeft"> </td><td class="mdescRight">This function will be called each time an exception appears on socket. <a href="#a9683522c399bbfe7116e2cda2c357478">More...</a><br/></td></tr>
<tr class="separator:a9683522c399bbfe7116e2cda2c357478"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c6b5344b5af43e28402419f24304bb"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#a95c6b5344b5af43e28402419f24304bb">userdata</a></td></tr>
<tr class="memdesc:a95c6b5344b5af43e28402419f24304bb"><td class="mdescLeft"> </td><td class="mdescRight">User-provided data. <a href="#a95c6b5344b5af43e28402419f24304bb">More...</a><br/></td></tr>
<tr class="separator:a95c6b5344b5af43e28402419f24304bb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>These are the callbacks exported by the socket structure They are called by the socket module when a socket event appears. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ae46949c0769fcdce94280888a3301d2d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_int ssh_socket_callbacks::controlflow</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time a controlflow state changes, i.e. </p>
<p>the socket is available for reading or writing. </p>
</div>
</div>
<a class="anchor" id="a847925e298ebc2cf424e35f782c27bd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_data ssh_socket_callbacks::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time data appears on socket. </p>
<p>The data not consumed will appear on the next data event. </p>
</div>
</div>
<a class="anchor" id="a9683522c399bbfe7116e2cda2c357478"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_int_int ssh_socket_callbacks::exception</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time an exception appears on socket. </p>
<p>An exception can be a socket problem (timeout, ...) or an end-of-file. </p>
</div>
</div>
<a class="anchor" id="a95c6b5344b5af43e28402419f24304bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ssh_socket_callbacks::userdata</td>
</tr>
</table>
</div><div class="memdoc">
<p>User-provided data. </p>
<p>User is free to set anything he wants here </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/libssh/<a class="el" href="callbacks_8h_source.html">callbacks.h</a></li>
</ul>
</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>
