/usr/share/doc/libssh-doc/html/socket_8h_source.html is in libssh-doc 0.8.0~20170825.94fa1e38-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libssh: include/libssh/socket.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libssh
 <span id="projectnumber">0.8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></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">socket.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"> * This library is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * version 2.1 of the License, or (at your 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"> * This library is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Lesser General Public 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</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef SOCKET_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define SOCKET_H_</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "libssh/callbacks.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">struct </span>ssh_poll_handle_struct;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/* socket.c */</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">struct </span>ssh_socket_struct;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>ssh_socket_struct* ssh_socket;</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">int</span> ssh_socket_init(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">void</span> ssh_socket_cleanup(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> ssh_socket ssh_socket_new(ssh_session session);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> ssh_socket_reset(ssh_socket s);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> ssh_socket_free(ssh_socket s);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> ssh_socket_set_fd(ssh_socket s, socket_t fd);</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> socket_t ssh_socket_get_fd_in(ssh_socket s);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifndef _WIN32</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">int</span> ssh_socket_unix(ssh_socket s, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> ssh_execute_command(<span class="keyword">const</span> <span class="keywordtype">char</span> *command, socket_t in, socket_t out);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">int</span> ssh_socket_connect_proxycommand(ssh_socket s, <span class="keyword">const</span> <span class="keywordtype">char</span> *command);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">void</span> ssh_socket_close(ssh_socket s);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">int</span> ssh_socket_write(ssh_socket s,<span class="keyword">const</span> <span class="keywordtype">void</span> *buffer, <span class="keywordtype">int</span> len);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">int</span> ssh_socket_is_open(ssh_socket s);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">int</span> ssh_socket_fd_isset(ssh_socket s, fd_set *<span class="keyword">set</span>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">void</span> ssh_socket_fd_set(ssh_socket s, fd_set *<span class="keyword">set</span>, socket_t *max_fd);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> ssh_socket_set_fd_in(ssh_socket s, socket_t fd);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> ssh_socket_set_fd_out(ssh_socket s, socket_t fd);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">int</span> ssh_socket_nonblocking_flush(ssh_socket s);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">void</span> ssh_socket_set_write_wontblock(ssh_socket s);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> ssh_socket_set_read_wontblock(ssh_socket s);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> ssh_socket_set_except(ssh_socket s);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">int</span> ssh_socket_get_status(ssh_socket s);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">int</span> ssh_socket_get_poll_flags(ssh_socket s);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">int</span> ssh_socket_buffered_write_bytes(ssh_socket s);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keywordtype">int</span> ssh_socket_data_available(ssh_socket s);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">int</span> ssh_socket_data_writable(ssh_socket s);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">int</span> ssh_socket_set_nonblocking(socket_t fd);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">int</span> ssh_socket_set_blocking(socket_t fd);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> ssh_socket_set_callbacks(ssh_socket s, ssh_socket_callbacks callbacks);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">int</span> ssh_socket_pollcallback(<span class="keyword">struct</span> ssh_poll_handle_struct *p, socket_t fd, <span class="keywordtype">int</span> revents, <span class="keywordtype">void</span> *v_s);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">struct </span>ssh_poll_handle_struct * ssh_socket_get_poll_handle_in(ssh_socket s);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">struct </span>ssh_poll_handle_struct * ssh_socket_get_poll_handle_out(ssh_socket s);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">int</span> ssh_socket_connect(ssh_socket s, <span class="keyword">const</span> <span class="keywordtype">char</span> *host, <span class="keywordtype">int</span> port, <span class="keyword">const</span> <span class="keywordtype">char</span> *bind_addr);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif </span><span class="comment">/* SOCKET_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.13
</small></address>
</body>
</html>
|