herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d8/dd3/ssh_8h_source.html

196 lines
18 KiB
HTML
Raw Normal View History

started woking on figuring out doxygen documentation and added readme
2024-12-24 03:47:16 -07:00
<!-- HTML header for doxygen 1.9.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" class="dark-mode">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/networking/ssh.h Source File</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="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.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" />
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d8/dd3/ssh_8h_source.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ssh.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d8/dd3/ssh_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_SSH_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_SSH_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="../../da/d66/string_8h.html">arc/std/string.h</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/**</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * @brief ssh type that holds ssh connection along with credentials</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">*/</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70"> 13</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> <a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">/**</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * @brief a ssh session function</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> *</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * @param data user data that can be used within the callback</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">*/</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#aa6f481c13aec410d0902c4f9a5d94e9b"> 20</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#aa6f481c13aec410d0902c4f9a5d94e9b">ARC_Ssh_SessionFn</a>)(<span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"></span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/**</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * @brief creates ARC_Ssh type</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> *</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param ssh ARC_Ssh to create</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> */</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#ad489e520aa92d284e50db127e1e8157a"> 27</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/dd3/ssh_8h.html#ad489e520aa92d284e50db127e1e8157a">ARC_Ssh_Create</a>(<a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> **ssh, <span class="keywordtype">char</span> *host, <span class="keywordtype">char</span> *user, <span class="keywordtype">char</span> *password);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"></span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">/**</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @brief destroyes ARC_Ssh type</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> *</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param ssh ARC_Ssh to destroy</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> */</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#a08efa4bb06634fc63432bee3f0cafbc1"> 34</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/dd3/ssh_8h.html#a08efa4bb06634fc63432bee3f0cafbc1">ARC_Ssh_Destroy</a>(<a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> *ssh);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"></span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/**</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> * @brief runs a callback function within a ssh session</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param ssh ARC_Ssh to create and run function in ssh session</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param sessionFN callback to run in a ssh session</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> */</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#a611049154ff185c551929068f3d0270a"> 42</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/dd3/ssh_8h.html#a611049154ff185c551929068f3d0270a">ARC_Ssh_RunInSession</a>(<a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> *ssh, <a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#aa6f481c13aec410d0902c4f9a5d94e9b">ARC_Ssh_SessionFn</a> sessionFn);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"></span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">/**</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> * @brief</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">*/</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#a1e5f9b0c05c7e9b9d99430dc05ef02b3"> 47</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/dd3/ssh_8h.html#a1e5f9b0c05c7e9b9d99430dc05ef02b3">ARC_Ssh_ExecStrInNewSession</a>(<a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> *ssh, <span class="keywordtype">char</span> *command);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">/**</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @brief</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">*/</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="../../d8/dd3/ssh_8h.html#a1cc4737620480eb72a38fd0bbc84a9d2"> 52</a></span><a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<a class="code hl_function" href="../../d8/dd3/ssh_8h.html#a1cc4737620480eb72a38fd0bbc84a9d2">ARC_Ssh_ExecStrInNewSessionAndGetResponse</a>(<a class="code hl_typedef" href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a> *ssh, <span class="keywordtype">char</span> *command);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>}</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="preprocessor">#endif </span><span class="comment">//!ARC_SSH_H_</span></div>
<div class="ttc" id="assh_8h_html_a08efa4bb06634fc63432bee3f0cafbc1"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#a08efa4bb06634fc63432bee3f0cafbc1">ARC_Ssh_Destroy</a></div><div class="ttdeci">void ARC_Ssh_Destroy(ARC_Ssh *ssh)</div><div class="ttdoc">destroyes ARC_Ssh type</div></div>
<div class="ttc" id="assh_8h_html_a1cc4737620480eb72a38fd0bbc84a9d2"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#a1cc4737620480eb72a38fd0bbc84a9d2">ARC_Ssh_ExecStrInNewSessionAndGetResponse</a></div><div class="ttdeci">ARC_String * ARC_Ssh_ExecStrInNewSessionAndGetResponse(ARC_Ssh *ssh, char *command)</div></div>
<div class="ttc" id="assh_8h_html_a1e5f9b0c05c7e9b9d99430dc05ef02b3"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#a1e5f9b0c05c7e9b9d99430dc05ef02b3">ARC_Ssh_ExecStrInNewSession</a></div><div class="ttdeci">void ARC_Ssh_ExecStrInNewSession(ARC_Ssh *ssh, char *command)</div></div>
<div class="ttc" id="assh_8h_html_a611049154ff185c551929068f3d0270a"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#a611049154ff185c551929068f3d0270a">ARC_Ssh_RunInSession</a></div><div class="ttdeci">void ARC_Ssh_RunInSession(ARC_Ssh *ssh, ARC_Ssh_SessionFn sessionFn)</div><div class="ttdoc">runs a callback function within a ssh session</div></div>
<div class="ttc" id="assh_8h_html_aa6f481c13aec410d0902c4f9a5d94e9b"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#aa6f481c13aec410d0902c4f9a5d94e9b">ARC_Ssh_SessionFn</a></div><div class="ttdeci">void(* ARC_Ssh_SessionFn)(void *data)</div><div class="ttdoc">a ssh session function</div><div class="ttdef"><b>Definition</b> <a href="#l00020">ssh.h:20</a></div></div>
<div class="ttc" id="assh_8h_html_ad489e520aa92d284e50db127e1e8157a"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#ad489e520aa92d284e50db127e1e8157a">ARC_Ssh_Create</a></div><div class="ttdeci">void ARC_Ssh_Create(ARC_Ssh **ssh, char *host, char *user, char *password)</div><div class="ttdoc">creates ARC_Ssh type</div></div>
<div class="ttc" id="assh_8h_html_af7f8e513348e5d76222c96396bc0ed70"><div class="ttname"><a href="../../d8/dd3/ssh_8h.html#af7f8e513348e5d76222c96396bc0ed70">ARC_Ssh</a></div><div class="ttdeci">struct ARC_Ssh ARC_Ssh</div><div class="ttdoc">ssh type that holds ssh connection along with credentials</div><div class="ttdef"><b>Definition</b> <a href="#l00013">ssh.h:13</a></div></div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</a></div></div>
<div class="ttc" id="astructARC__String_html"><div class="ttname"><a href="../../df/d06/structARC__String.html">ARC_String</a></div><div class="ttdoc">substring position within a string</div><div class="ttdef"><b>Definition</b> <a href="../../da/d66/string_8h_source.html#l00014">string.h:14</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_e1e6d6205f1f2bb361dce2a25d40e4a1.html">networking</a></li><li class="navelem"><a class="el" href="../../d8/dd3/ssh_8h.html">ssh.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>
Reference in a new issue Copy permalink