| 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__log.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 SSH logging functions.</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="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The SSH logging functions.<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
  <a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba95c5ce872b66ec03f3336970c1e0a774">SSH_LOG_NOLOG</a> =0,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba12e6bbab0c5a667e259e2f9599a72550">SSH_LOG_WARNING</a>,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba75fa79e63947b66462db977d9b5ae27c">SSH_LOG_PROTOCOL</a>,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba6445dfe21592d69d9741d319538b6673">SSH_LOG_PACKET</a>,
<br />
  <a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba926c933f61d1afa64003c1cc66f6a01c">SSH_LOG_FUNCTIONS</a>
<br />
}</td></tr>
<tr class="separator:ga06fc87d81c62e9abb8790b6e5713c55b"><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:ga28de9ecb422e9b2ffcd5dcb5b7ec13e1"><td class="memItemLeft" align="right" valign="top"><a id="ga28de9ecb422e9b2ffcd5dcb5b7ec13e1"></a>
void </td><td class="memItemRight" valign="bottom"><b>ssh_log_function</b> (int verbosity, const char *function, const char *buffer)</td></tr>
<tr class="separator:ga28de9ecb422e9b2ffcd5dcb5b7ec13e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac8bd5378e8af9c6af0ebc198ae6dd2ed"><td class="memItemLeft" align="right" valign="top"><a id="gac8bd5378e8af9c6af0ebc198ae6dd2ed"></a>
void </td><td class="memItemRight" valign="bottom"><b>_ssh_log</b> (int verbosity, const char *function, const char *format,...)</td></tr>
<tr class="separator:gac8bd5378e8af9c6af0ebc198ae6dd2ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0bb252b81e0c497fc559c9e4007cf6c5"><td class="memItemLeft" align="right" valign="top"><a id="ga0bb252b81e0c497fc559c9e4007cf6c5"></a>
void </td><td class="memItemRight" valign="bottom"><b>ssh_log</b> (<a class="el" href="structssh__session__struct.html">ssh_session</a> session, int verbosity, const char *format,...)</td></tr>
<tr class="separator:ga0bb252b81e0c497fc559c9e4007cf6c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacfb35fd4c7d3dafdbbfaa2c255022ddc"><td class="memItemLeft" align="right" valign="top"><a id="gacfb35fd4c7d3dafdbbfaa2c255022ddc"></a>
void </td><td class="memItemRight" valign="bottom"><b>ssh_log_common</b> (struct <a class="el" href="structssh__common__struct.html">ssh_common_struct</a> *common, int verbosity, const char *function, const char *format,...)</td></tr>
<tr class="separator:gacfb35fd4c7d3dafdbbfaa2c255022ddc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9719dabb8fab8a3ebeb4dc2ebcd2dd45"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga9719dabb8fab8a3ebeb4dc2ebcd2dd45">ssh_set_log_level</a> (int level)</td></tr>
<tr class="memdesc:ga9719dabb8fab8a3ebeb4dc2ebcd2dd45"><td class="mdescLeft"> </td><td class="mdescRight">Set the log level of the library. <a href="#ga9719dabb8fab8a3ebeb4dc2ebcd2dd45">More...</a><br /></td></tr>
<tr class="separator:ga9719dabb8fab8a3ebeb4dc2ebcd2dd45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad6a0b7b581b12be4e34a110b7312614b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#gad6a0b7b581b12be4e34a110b7312614b">ssh_get_log_level</a> (void)</td></tr>
<tr class="memdesc:gad6a0b7b581b12be4e34a110b7312614b"><td class="mdescLeft"> </td><td class="mdescRight">Get the log level of the library. <a href="#gad6a0b7b581b12be4e34a110b7312614b">More...</a><br /></td></tr>
<tr class="separator:gad6a0b7b581b12be4e34a110b7312614b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6accdc08b7d8c4234750ef30c4854b9e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga6accdc08b7d8c4234750ef30c4854b9e">ssh_set_log_callback</a> (<a class="el" href="group__libssh__callbacks.html#gab6eedc77c07dde0c6baf9c29e7700a99">ssh_logging_callback</a> cb)</td></tr>
<tr class="memdesc:ga6accdc08b7d8c4234750ef30c4854b9e"><td class="mdescLeft"> </td><td class="mdescRight">Set the logging callback function. <a href="#ga6accdc08b7d8c4234750ef30c4854b9e">More...</a><br /></td></tr>
<tr class="separator:ga6accdc08b7d8c4234750ef30c4854b9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f795c820547d058dbbfa80cd4fe9a4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libssh__callbacks.html#gab6eedc77c07dde0c6baf9c29e7700a99">ssh_logging_callback</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga0f795c820547d058dbbfa80cd4fe9a4e">ssh_get_log_callback</a> (void)</td></tr>
<tr class="memdesc:ga0f795c820547d058dbbfa80cd4fe9a4e"><td class="mdescLeft"> </td><td class="mdescRight">Get the pointer to the logging callback function. <a href="#ga0f795c820547d058dbbfa80cd4fe9a4e">More...</a><br /></td></tr>
<tr class="separator:ga0f795c820547d058dbbfa80cd4fe9a4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga887a1e754cd935b55fea1afb1f718761"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga887a1e754cd935b55fea1afb1f718761">ssh_get_log_userdata</a> (void)</td></tr>
<tr class="memdesc:ga887a1e754cd935b55fea1afb1f718761"><td class="mdescLeft"> </td><td class="mdescRight">Get the userdata of the logging function. <a href="#ga887a1e754cd935b55fea1afb1f718761">More...</a><br /></td></tr>
<tr class="separator:ga887a1e754cd935b55fea1afb1f718761"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0addd5c29922f40e9f842a43e0cb0b27"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga0addd5c29922f40e9f842a43e0cb0b27">ssh_set_log_userdata</a> (void *data)</td></tr>
<tr class="memdesc:ga0addd5c29922f40e9f842a43e0cb0b27"><td class="mdescLeft"> </td><td class="mdescRight">Set the userdata for the logging function. <a href="#ga0addd5c29922f40e9f842a43e0cb0b27">More...</a><br /></td></tr>
<tr class="separator:ga0addd5c29922f40e9f842a43e0cb0b27"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Logging functions for debugging and problem resolving. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga06fc87d81c62e9abb8790b6e5713c55b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06fc87d81c62e9abb8790b6e5713c55b">◆ </a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga06fc87d81c62e9abb8790b6e5713c55ba95c5ce872b66ec03f3336970c1e0a774"></a>SSH_LOG_NOLOG </td><td class="fielddoc"><p>No logging at all </p>
</td></tr>
<tr><td class="fieldname"><a id="gga06fc87d81c62e9abb8790b6e5713c55ba12e6bbab0c5a667e259e2f9599a72550"></a>SSH_LOG_WARNING </td><td class="fielddoc"><p>Only fatal warnings </p>
</td></tr>
<tr><td class="fieldname"><a id="gga06fc87d81c62e9abb8790b6e5713c55ba75fa79e63947b66462db977d9b5ae27c"></a>SSH_LOG_PROTOCOL </td><td class="fielddoc"><p>High level protocol information </p>
</td></tr>
<tr><td class="fieldname"><a id="gga06fc87d81c62e9abb8790b6e5713c55ba6445dfe21592d69d9741d319538b6673"></a>SSH_LOG_PACKET </td><td class="fielddoc"><p>Lower level protocol infomations, packet level </p>
</td></tr>
<tr><td class="fieldname"><a id="gga06fc87d81c62e9abb8790b6e5713c55ba926c933f61d1afa64003c1cc66f6a01c"></a>SSH_LOG_FUNCTIONS </td><td class="fielddoc"><p>Every function path </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga0f795c820547d058dbbfa80cd4fe9a4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0f795c820547d058dbbfa80cd4fe9a4e">◆ </a></span>ssh_get_log_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__libssh__callbacks.html#gab6eedc77c07dde0c6baf9c29e7700a99">ssh_logging_callback</a> ssh_get_log_callback </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the pointer to the logging callback function. </p>
<dl class="section return"><dt>Returns</dt><dd>The pointer the the callback or NULL if none set. </dd></dl>
</div>
</div>
<a id="gad6a0b7b581b12be4e34a110b7312614b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6a0b7b581b12be4e34a110b7312614b">◆ </a></span>ssh_get_log_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_get_log_level </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the log level of the library. </p>
<dl class="section return"><dt>Returns</dt><dd>The value of the log level. </dd></dl>
</div>
</div>
<a id="ga887a1e754cd935b55fea1afb1f718761"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga887a1e754cd935b55fea1afb1f718761">◆ </a></span>ssh_get_log_userdata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* ssh_get_log_userdata </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the userdata of the logging function. </p>
<dl class="section return"><dt>Returns</dt><dd>The userdata if set or NULL. </dd></dl>
</div>
</div>
<a id="ga6accdc08b7d8c4234750ef30c4854b9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6accdc08b7d8c4234750ef30c4854b9e">◆ </a></span>ssh_set_log_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_set_log_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libssh__callbacks.html#gab6eedc77c07dde0c6baf9c29e7700a99">ssh_logging_callback</a> </td>
<td class="paramname"><em>cb</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the logging callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cb</td><td>The callback to set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, < 0 on errror. </dd></dl>
</div>
</div>
<a id="ga9719dabb8fab8a3ebeb4dc2ebcd2dd45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9719dabb8fab8a3ebeb4dc2ebcd2dd45">◆ </a></span>ssh_set_log_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_set_log_level </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the log level of the library. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The level to set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_OK on success, SSH_ERROR on error. </dd></dl>
</div>
</div>
<a id="ga0addd5c29922f40e9f842a43e0cb0b27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0addd5c29922f40e9f842a43e0cb0b27">◆ </a></span>ssh_set_log_userdata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ssh_set_log_userdata </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the userdata for the logging function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The userdata to set.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SSH_OK on success. </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>