<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <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.3.1"/> <title>libssh: include/libssh/misc.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="doxygen.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 style="padding-left: 0.5em;"> <div id="projectname">libssh  <span id="projectnumber">0.5.5</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b9682cd10a3f48e47321de8901f87a77.html">libssh</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">misc.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of the SSH Library</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (c) 2009 by Aris Adamantiadis</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * The SSH Library is free software; you can redistribute it and/or modify</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as published by</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or (at your</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * option) any later version.</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The SSH Library is distributed in the hope that it will be useful, but</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * License for more details.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with the SSH Library; see the file COPYING. If not, write to</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MA 02111-1307, USA.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef MISC_H_</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define MISC_H_</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/* in misc.c */</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* gets the user home dir. */</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">char</span> *ssh_get_user_home_dir(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">char</span> *ssh_get_local_username(ssh_session session);</div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">int</span> ssh_file_readaccess_ok(<span class="keyword">const</span> <span class="keywordtype">char</span> *file);</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">char</span> *<a class="code" href="group__libssh__misc.html#ga85622306848fd7e735d5843747f6eb28" title="Expand a directory starting with a tilde '~'.">ssh_path_expand_tilde</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *d);</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">char</span> *ssh_path_expand_escape(ssh_session session, <span class="keyword">const</span> <span class="keywordtype">char</span> *s);</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">int</span> ssh_analyze_banner(ssh_session session, <span class="keywordtype">int</span> server, <span class="keywordtype">int</span> *ssh1, <span class="keywordtype">int</span> *ssh2);</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">int</span> ssh_is_ipaddr_v4(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">int</span> ssh_is_ipaddr(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/* macro for byte ordering */</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> uint64_t ntohll(uint64_t);</div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define htonll(x) ntohll(x)</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/* list processing */</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">struct </span>ssh_list {</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">struct </span>ssh_iterator *root;</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">struct </span>ssh_iterator *end;</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> };</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">struct </span>ssh_iterator {</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">struct </span>ssh_iterator *next;</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">const</span> <span class="keywordtype">void</span> *data;</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> };</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">struct </span>ssh_timestamp {</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">long</span> seconds;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">long</span> useconds;</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">struct </span>ssh_list *ssh_list_new(<span class="keywordtype">void</span>);</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">void</span> ssh_list_free(<span class="keyword">struct</span> ssh_list *list);</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">struct </span>ssh_iterator *ssh_list_get_iterator(<span class="keyword">const</span> <span class="keyword">struct</span> ssh_list *list);</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">struct </span>ssh_iterator *ssh_list_find(<span class="keyword">const</span> <span class="keyword">struct</span> ssh_list *list, <span class="keywordtype">void</span> *value);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">int</span> ssh_list_append(<span class="keyword">struct</span> ssh_list *list, <span class="keyword">const</span> <span class="keywordtype">void</span> *data);</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">int</span> ssh_list_prepend(<span class="keyword">struct</span> ssh_list *list, <span class="keyword">const</span> <span class="keywordtype">void</span> *data);</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> ssh_list_remove(<span class="keyword">struct</span> ssh_list *list, <span class="keyword">struct</span> ssh_iterator *iterator);</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">char</span> *ssh_lowercase(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keywordtype">char</span> *ssh_hostport(<span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keywordtype">int</span> port);</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">const</span> <span class="keywordtype">void</span> *_ssh_list_pop_head(<span class="keyword">struct</span> ssh_list *list);</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#define ssh_iterator_value(type, iterator)\</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"> ((type)((iterator)->data))</span></div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#define ssh_list_pop_head(type, ssh_list)\</span></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"> ((type)_ssh_list_pop_head(ssh_list))</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">int</span> ssh_make_milliseconds(<span class="keywordtype">long</span> sec, <span class="keywordtype">long</span> usec);</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keywordtype">void</span> ssh_timestamp_init(<span class="keyword">struct</span> ssh_timestamp *ts);</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keywordtype">int</span> ssh_timeout_elapsed(<span class="keyword">struct</span> ssh_timestamp *ts, <span class="keywordtype">int</span> timeout);</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">int</span> <a class="code" href="group__libssh__misc.html#gad1c4b29e2421eb8f9ca111d98b0c2976" title="updates a timeout value so it reflects the remaining time">ssh_timeout_update</a>(<span class="keyword">struct</span> ssh_timestamp *ts, <span class="keywordtype">int</span> timeout);</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif </span><span class="comment">/* MISC_H_ */</span><span class="preprocessor"></span></div> </div><!-- fragment --></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.3.1 </small></address> </body> </html>