| Dir : /usr/local/ssl/share/doc/libssh-devel/html/ |
| Server: Linux server2.noticiasdecolima.com 4.18.0-553.30.1.el8_10.x86_64 #1 SMP Tue Nov 26 02:30:26 EST 2024 x86_64 IP: 107.161.180.42 |
| Dir : //usr/local/ssl/share/doc/libssh-devel/html/structssh__socket__callbacks__struct.html |
<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libssh: ssh_socket_callbacks_struct 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script src="striped_bg.js"></script>
<link href="that_style.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libssh
 <span id="projectnumber">0.9.6</span>
</div>
<div id="projectbrief">The SSH library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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 Struct Reference<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a> » <a class="el" href="group__libssh__callbacks.html">The libssh callbacks</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="callbacks_8h_source.html">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:a21680bc94721a1507e1382e06f731aef"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__socket__callbacks__struct.html#a21680bc94721a1507e1382e06f731aef">userdata</a></td></tr>
<tr class="separator:a21680bc94721a1507e1382e06f731aef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73d09c1b2ae438da96c4b3bbfb99c9ad"><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#a73d09c1b2ae438da96c4b3bbfb99c9ad">data</a></td></tr>
<tr class="separator:a73d09c1b2ae438da96c4b3bbfb99c9ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad1bb53264cd71badae09bd3a0f561eb"><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#aad1bb53264cd71badae09bd3a0f561eb">controlflow</a></td></tr>
<tr class="separator:aad1bb53264cd71badae09bd3a0f561eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae642ee58e72973ee0802820e46cb777b"><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#ae642ee58e72973ee0802820e46cb777b">exception</a></td></tr>
<tr class="separator:ae642ee58e72973ee0802820e46cb777b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a905f6e0260fd5891d4afa9ed229b8479"><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#a905f6e0260fd5891d4afa9ed229b8479">connected</a></td></tr>
<tr class="separator:a905f6e0260fd5891d4afa9ed229b8479"><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 id="a905f6e0260fd5891d4afa9ed229b8479"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a905f6e0260fd5891d4afa9ed229b8479">◆ </a></span>connected</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_int_int ssh_socket_callbacks_struct::connected</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function is called when the ssh_socket_connect was used on the socket on nonblocking state, and the connection successed. </p>
</div>
</div>
<a id="aad1bb53264cd71badae09bd3a0f561eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad1bb53264cd71badae09bd3a0f561eb">◆ </a></span>controlflow</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_int ssh_socket_callbacks_struct::controlflow</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time a controlflow state changes, i.e. the socket is available for reading or writing. </p>
</div>
</div>
<a id="a73d09c1b2ae438da96c4b3bbfb99c9ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73d09c1b2ae438da96c4b3bbfb99c9ad">◆ </a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_data ssh_socket_callbacks_struct::data</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time data appears on socket. The data not consumed will appear on the next data event. </p>
</div>
</div>
<a id="ae642ee58e72973ee0802820e46cb777b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae642ee58e72973ee0802820e46cb777b">◆ </a></span>exception</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssh_callback_int_int ssh_socket_callbacks_struct::exception</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time an exception appears on socket. An exception can be a socket problem (timeout, ...) or an end-of-file. </p>
</div>
</div>
<a id="a21680bc94721a1507e1382e06f731aef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21680bc94721a1507e1382e06f731aef">◆ </a></span>userdata</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ssh_socket_callbacks_struct::userdata</td>
</tr>
</table>
</div><div class="memdoc">
<p>User-provided data. 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><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.14
</small></address>
</body>
</html>