| 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/group__libssh.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: The libssh API</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The libssh API</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__libssh__callbacks"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__callbacks.html">The libssh callbacks</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__auth"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__auth.html">The SSH authentication functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__buffer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__buffer.html">The SSH buffer functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__channel"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__channel.html">The SSH channel functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__error"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__error.html">The SSH error functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__log"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html">The SSH logging functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__messages"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__messages.html">The SSH message functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__misc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__misc.html">The SSH helper functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__pki"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__pki.html">The SSH Public Key Infrastructure</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__poll"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__poll.html">The SSH poll functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__scp"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__scp.html">The SSH scp functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__session"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__session.html">The SSH session functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__string"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__string.html">The SSH string functions</a></td></tr>
<tr class="memdesc:group__libssh__string"><td class="mdescLeft"> </td><td class="mdescRight">String manipulations used in libssh. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__libssh__threads"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__threads.html">The SSH threading functions.</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e">ssh_init</a> (void)</td></tr>
<tr class="memdesc:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="mdescLeft"> </td><td class="mdescRight">Initialize global cryptographic data structures. <a href="#ga3ebf8d6920e563f3b032e3cd5277598e">More...</a><br /></td></tr>
<tr class="separator:ga3ebf8d6920e563f3b032e3cd5277598e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga12489699b7b74b46ac372ee5ecfffc6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh.html#ga12489699b7b74b46ac372ee5ecfffc6c">libssh_destructor</a> (void)</td></tr>
<tr class="memdesc:ga12489699b7b74b46ac372ee5ecfffc6c"><td class="mdescLeft"> </td><td class="mdescRight">Finalize and cleanup all libssh and cryptographic data structures. <a href="#ga12489699b7b74b46ac372ee5ecfffc6c">More...</a><br /></td></tr>
<tr class="separator:ga12489699b7b74b46ac372ee5ecfffc6c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga94a851d00248acde9cd7da084b491242"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242">ssh_finalize</a> (void)</td></tr>
<tr class="memdesc:ga94a851d00248acde9cd7da084b491242"><td class="mdescLeft"> </td><td class="mdescRight">Finalize and cleanup all libssh and cryptographic data structures. <a href="#ga94a851d00248acde9cd7da084b491242">More...</a><br /></td></tr>
<tr class="separator:ga94a851d00248acde9cd7da084b491242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace089fe39904adbab6fba831e6dd013c"><td class="memItemLeft" align="right" valign="top"><a id="gace089fe39904adbab6fba831e6dd013c"></a>
bool </td><td class="memItemRight" valign="bottom"><b>is_ssh_initialized</b> (void)</td></tr>
<tr class="separator:gace089fe39904adbab6fba831e6dd013c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The libssh library is implementing the SSH protocols and some of its extensions. This group of functions is mostly used to implement an SSH client. Some function are needed to implement an SSH server too. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga12489699b7b74b46ac372ee5ecfffc6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga12489699b7b74b46ac372ee5ecfffc6c">◆ </a></span>libssh_destructor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void libssh_destructor </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize and cleanup all libssh and cryptographic data structures. </p>
<p>This function is automatically called when the library is unloaded. </p>
</div>
</div>
<a id="ga94a851d00248acde9cd7da084b491242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94a851d00248acde9cd7da084b491242">◆ </a></span>ssh_finalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_finalize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalize and cleanup all libssh and cryptographic data structures. </p>
<p>Since version 0.8.0, when libssh is dynamically linked, it is not necessary to call this function, since it is automatically called when the library is unloaded.</p>
<p>If libssh is statically linked, it is necessary to explicitly call <a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e" title="Initialize global cryptographic data structures. ">ssh_init()</a> before calling any other provided API, and it is necessary to explicitly call <a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242" title="Finalize and cleanup all libssh and cryptographic data structures. ">ssh_finalize()</a> to free the allocated resources before exiting.</p>
<p>If <a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e" title="Initialize global cryptographic data structures. ">ssh_init()</a> is called explicitly, then <a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242" title="Finalize and cleanup all libssh and cryptographic data structures. ">ssh_finalize()</a> must be called explicitly.</p>
<p>When called, decrements the counter _ssh_initialized. If the counter reaches zero, then the libssh and cryptographic data structures are cleaned up.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 if an error occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e" title="Initialize global cryptographic data structures. ">ssh_init()</a> </dd></dl>
</div>
</div>
<a id="ga3ebf8d6920e563f3b032e3cd5277598e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ebf8d6920e563f3b032e3cd5277598e">◆ </a></span>ssh_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize global cryptographic data structures. </p>
<p>Since version 0.8.0, when libssh is dynamically linked, it is not necessary to call this function on systems which are fully supported with regards to threading (that is, system with pthreads available).</p>
<p>If libssh is statically linked, it is necessary to explicitly call <a class="el" href="group__libssh.html#ga3ebf8d6920e563f3b032e3cd5277598e" title="Initialize global cryptographic data structures. ">ssh_init()</a> before calling any other provided API, and it is necessary to explicitly call <a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242" title="Finalize and cleanup all libssh and cryptographic data structures. ">ssh_finalize()</a> to free the allocated resources before exiting.</p>
<p>If the library is already initialized, increments the _ssh_initialized counter and return the error code cached in _ssh_init_ret.</p>
<dl class="section return"><dt>Returns</dt><dd>SSH_OK on success, SSH_ERROR if an error occurred.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__libssh.html#ga94a851d00248acde9cd7da084b491242" title="Finalize and cleanup all libssh and cryptographic data structures. ">ssh_finalize()</a> </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.14
</small></address>
</body>
</html>