| Dir : /proc/thread-self/root/usr/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 : //proc/thread-self/root/usr/share/doc/libssh-devel/html/structssh__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_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_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:ac29d6727c165e28748cfa442d7a292b9"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#ac29d6727c165e28748cfa442d7a292b9">size</a></td></tr>
<tr class="separator:ac29d6727c165e28748cfa442d7a292b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5cdca2ba78d7582d8eff77ef7995700"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#aa5cdca2ba78d7582d8eff77ef7995700">userdata</a></td></tr>
<tr class="separator:aa5cdca2ba78d7582d8eff77ef7995700"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f79b2d36329d0ce6e9ac2cd3b77b046"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__auth.html#ga3b54d7be70dcc98a107e41e11000a3e1">ssh_auth_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#a5f79b2d36329d0ce6e9ac2cd3b77b046">auth_function</a></td></tr>
<tr class="separator:a5f79b2d36329d0ce6e9ac2cd3b77b046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a409f4218537c3224e42d35b28ae93f7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__callbacks.html#ga9057cbb0dc4ad1939cf6e03f36eaae9f">ssh_log_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#a409f4218537c3224e42d35b28ae93f7a">log_function</a></td></tr>
<tr class="separator:a409f4218537c3224e42d35b28ae93f7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc74777decb2f20ba522f794a29995ad"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#adc74777decb2f20ba522f794a29995ad">connect_status_function</a> )(void *<a class="el" href="structssh__callbacks__struct.html#aa5cdca2ba78d7582d8eff77ef7995700">userdata</a>, float status)</td></tr>
<tr class="separator:adc74777decb2f20ba522f794a29995ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affa000c51d64fb6bb10c1ab7109ab1f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__callbacks.html#gaeeb75ac372db669157bba96c22e6df85">ssh_global_request_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#affa000c51d64fb6bb10c1ab7109ab1f1">global_request_function</a></td></tr>
<tr class="separator:affa000c51d64fb6bb10c1ab7109ab1f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66ede60538c6615c221ea60e756b064c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__callbacks.html#ga6fc88f06d2eaa263d3336621edea0dcc">ssh_channel_open_request_x11_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#a66ede60538c6615c221ea60e756b064c">channel_open_request_x11_function</a></td></tr>
<tr class="separator:a66ede60538c6615c221ea60e756b064c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0016052943bb72880d3e54cc46ca0073"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__callbacks.html#gaaa21f6a1afe26a81e1b20a714bbfdec0">ssh_channel_open_request_auth_agent_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structssh__callbacks__struct.html#a0016052943bb72880d3e54cc46ca0073">channel_open_request_auth_agent_function</a></td></tr>
<tr class="separator:a0016052943bb72880d3e54cc46ca0073"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The structure to replace libssh functions with appropriate callbacks. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a5f79b2d36329d0ce6e9ac2cd3b77b046"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f79b2d36329d0ce6e9ac2cd3b77b046">◆ </a></span>auth_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__auth.html#ga3b54d7be70dcc98a107e41e11000a3e1">ssh_auth_callback</a> ssh_callbacks_struct::auth_function</td>
</tr>
</table>
</div><div class="memdoc">
<p>This functions will be called if e.g. a keyphrase is needed. </p>
</div>
</div>
<a id="a0016052943bb72880d3e54cc46ca0073"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0016052943bb72880d3e54cc46ca0073">◆ </a></span>channel_open_request_auth_agent_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__callbacks.html#gaaa21f6a1afe26a81e1b20a714bbfdec0">ssh_channel_open_request_auth_agent_callback</a> ssh_callbacks_struct::channel_open_request_auth_agent_function</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called when an incoming "auth-agent" request is received. </p>
</div>
</div>
<a id="a66ede60538c6615c221ea60e756b064c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66ede60538c6615c221ea60e756b064c">◆ </a></span>channel_open_request_x11_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__callbacks.html#ga6fc88f06d2eaa263d3336621edea0dcc">ssh_channel_open_request_x11_callback</a> ssh_callbacks_struct::channel_open_request_x11_function</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called when an incoming X11 request is received. </p>
</div>
</div>
<a id="adc74777decb2f20ba522f794a29995ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc74777decb2f20ba522f794a29995ad">◆ </a></span>connect_status_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* ssh_callbacks_struct::connect_status_function) (void *<a class="el" href="structssh__callbacks__struct.html#aa5cdca2ba78d7582d8eff77ef7995700">userdata</a>, float status)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function gets called during connection time to indicate the percentage of connection steps completed. </p>
</div>
</div>
<a id="affa000c51d64fb6bb10c1ab7109ab1f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affa000c51d64fb6bb10c1ab7109ab1f1">◆ </a></span>global_request_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__callbacks.html#gaeeb75ac372db669157bba96c22e6df85">ssh_global_request_callback</a> ssh_callbacks_struct::global_request_function</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time a global request is received. </p>
</div>
</div>
<a id="a409f4218537c3224e42d35b28ae93f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a409f4218537c3224e42d35b28ae93f7a">◆ </a></span>log_function</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__callbacks.html#ga9057cbb0dc4ad1939cf6e03f36eaae9f">ssh_log_callback</a> ssh_callbacks_struct::log_function</td>
</tr>
</table>
</div><div class="memdoc">
<p>This function will be called each time a loggable event happens. </p>
</div>
</div>
<a id="ac29d6727c165e28748cfa442d7a292b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac29d6727c165e28748cfa442d7a292b9">◆ </a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ssh_callbacks_struct::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>DON'T SET THIS use <a class="el" href="group__libssh__callbacks.html#gafe09b81e5346f0babe288dc38113d289" title="Initializes an ssh_callbacks_struct A call to this macro is mandatory when you have set a new ssh_cal...">ssh_callbacks_init()</a> instead. </p>
</div>
</div>
<a id="aa5cdca2ba78d7582d8eff77ef7995700"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5cdca2ba78d7582d8eff77ef7995700">◆ </a></span>userdata</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ssh_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>