<!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/channels.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">channels.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 CHANNELS_H_</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define CHANNELS_H_</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#include "libssh/priv.h"</span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">enum</span> ssh_channel_request_state_e {</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  SSH_CHANNEL_REQ_STATE_NONE = 0,</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  SSH_CHANNEL_REQ_STATE_PENDING,</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  SSH_CHANNEL_REQ_STATE_ACCEPTED,</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  SSH_CHANNEL_REQ_STATE_DENIED,</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  SSH_CHANNEL_REQ_STATE_ERROR</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</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">enum</span> ssh_channel_state_e {</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  SSH_CHANNEL_STATE_NOT_OPEN = 0,</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  SSH_CHANNEL_STATE_OPEN_DENIED,</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  SSH_CHANNEL_STATE_OPEN,</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  SSH_CHANNEL_STATE_CLOSED</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> };</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">struct </span>ssh_channel_struct {</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  ssh_session session; <span class="comment">/* SSH_SESSION pointer */</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  uint32_t local_channel;</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  uint32_t local_window;</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">int</span> local_eof;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  uint32_t local_maxpacket;</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>  uint32_t remote_channel;</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  uint32_t remote_window;</div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> remote_eof; <span class="comment">/* end of file received */</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  uint32_t remote_maxpacket;</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">enum</span> ssh_channel_state_e state;</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">int</span> delayed_close;</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  ssh_buffer stdout_buffer;</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ssh_buffer stderr_buffer;</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">void</span> *userarg;</div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">int</span> version;</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> blocking;</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> exit_status;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">enum</span> ssh_channel_request_state_e request_state;</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  ssh_channel_callbacks callbacks;</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> };</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_channel_open_conf);</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_channel_open_fail);</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_channel_success);</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_channel_failure);</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_request_success);</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_request_denied);</div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(channel_rcv_change_window);</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(channel_rcv_eof);</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(channel_rcv_close);</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(channel_rcv_request);</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(channel_rcv_data);</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> ssh_channel <a class="code" href="group__libssh__channel.html#gada8ccda7bf65165fe145d3096a252dcc" title="Allocate a new channel.">ssh_channel_new</a>(ssh_session session);</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keywordtype">int</span> channel_default_bufferize(ssh_channel channel, <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> len,</div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">int</span> is_stderr);</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> uint32_t ssh_channel_new_id(ssh_session session);</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span> ssh_channel ssh_channel_from_local(ssh_session session, uint32_t <span class="keywordtype">id</span>);</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">int</span> channel_write_common(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">void</span> *data,</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  uint32_t len, <span class="keywordtype">int</span> is_stderr);</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#ifdef WITH_SSH1</span></div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="preprocessor"></span><a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_data1);</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_close1);</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <a class="code" href="group__libssh__callbacks.html#ga8fd26956f4e2b9bc57cfef26c50e321b" title="This macro declares a packet callback handler.">SSH_PACKET_CALLBACK</a>(ssh_packet_exist_status1);</div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/* channels1.c */</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">int</span> channel_open_session1(ssh_channel channel);</div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keywordtype">int</span> channel_request_pty_size1(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *terminal,</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> cols, <span class="keywordtype">int</span> rows);</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">int</span> channel_change_pty_size1(ssh_channel channel, <span class="keywordtype">int</span> cols, <span class="keywordtype">int</span> rows);</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">int</span> channel_request_shell1(ssh_channel channel);</div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">int</span> channel_request_exec1(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">char</span> *cmd);</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">int</span> channel_write1(ssh_channel channel, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> len);</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> ssh_channel ssh_get_channel1(ssh_session session);</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor">#endif </span><span class="comment">/* CHANNELS_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>