<!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: ssh::Channel Class Reference</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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>ssh</b></li><li class="navelem"><a class="el" href="classssh_1_1Channel.html">Channel</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">ssh::Channel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>the <a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">ssh::Channel</a> class describes the state of an SSH channel.
<a href="classssh_1_1Channel.html#details">More...</a></p>
<p><code>#include <<a class="el" href="libsshpp_8hpp_source.html">include/libssh/libsshpp.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a62000c16999e74525d296f0a1cb19c95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classssh_1_1Channel.html">Channel</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#a62000c16999e74525d296f0a1cb19c95">acceptX11</a> (int timeout_ms)</td></tr>
<tr class="memdesc:a62000c16999e74525d296f0a1cb19c95"><td class="mdescLeft"> </td><td class="mdescRight">accept an incoming X11 connection <a href="#a62000c16999e74525d296f0a1cb19c95">More...</a><br/></td></tr>
<tr class="separator:a62000c16999e74525d296f0a1cb19c95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a196b0eab10bf168330f569ff3881562c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#a196b0eab10bf168330f569ff3881562c">changePtySize</a> (int cols, int rows)</td></tr>
<tr class="memdesc:a196b0eab10bf168330f569ff3881562c"><td class="mdescLeft"> </td><td class="mdescRight">change the size of a pseudoterminal <a href="#a196b0eab10bf168330f569ff3881562c">More...</a><br/></td></tr>
<tr class="separator:a196b0eab10bf168330f569ff3881562c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad14405b4e8c3a8e3d37a49ed793aadde"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#ad14405b4e8c3a8e3d37a49ed793aadde">close</a> ()</td></tr>
<tr class="memdesc:ad14405b4e8c3a8e3d37a49ed793aadde"><td class="mdescLeft"> </td><td class="mdescRight">closes a channel <a href="#ad14405b4e8c3a8e3d37a49ed793aadde">More...</a><br/></td></tr>
<tr class="separator:ad14405b4e8c3a8e3d37a49ed793aadde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38880d18d0fc357be0f4f8b8ef1c92ef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#a38880d18d0fc357be0f4f8b8ef1c92ef">isClosed</a> ()</td></tr>
<tr class="memdesc:a38880d18d0fc357be0f4f8b8ef1c92ef"><td class="mdescLeft"> </td><td class="mdescRight">returns true if channel is in closed state <a href="#a38880d18d0fc357be0f4f8b8ef1c92ef">More...</a><br/></td></tr>
<tr class="separator:a38880d18d0fc357be0f4f8b8ef1c92ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bb4131d82cc033d75f65a5137053532"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#a3bb4131d82cc033d75f65a5137053532">isEof</a> ()</td></tr>
<tr class="memdesc:a3bb4131d82cc033d75f65a5137053532"><td class="mdescLeft"> </td><td class="mdescRight">returns true if channel is in EOF state <a href="#a3bb4131d82cc033d75f65a5137053532">More...</a><br/></td></tr>
<tr class="separator:a3bb4131d82cc033d75f65a5137053532"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2794c09f819f3132b241aa6b72b0664"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#aa2794c09f819f3132b241aa6b72b0664">isOpen</a> ()</td></tr>
<tr class="memdesc:aa2794c09f819f3132b241aa6b72b0664"><td class="mdescLeft"> </td><td class="mdescRight">returns true if channel is in open state <a href="#aa2794c09f819f3132b241aa6b72b0664">More...</a><br/></td></tr>
<tr class="separator:aa2794c09f819f3132b241aa6b72b0664"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06cf7ffd971eff87783a169444fa09a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classssh_1_1Channel.html#a06cf7ffd971eff87783a169444fa09a2">write</a> (const void *data, size_t len, bool is_stderr=false)</td></tr>
<tr class="memdesc:a06cf7ffd971eff87783a169444fa09a2"><td class="mdescLeft"> </td><td class="mdescRight">Writes on a channel. <a href="#a06cf7ffd971eff87783a169444fa09a2">More...</a><br/></td></tr>
<tr class="separator:a06cf7ffd971eff87783a169444fa09a2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>the <a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">ssh::Channel</a> class describes the state of an SSH channel. </p>
<dl class="section see"><dt>See Also</dt><dd>ssh_channel </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a62000c16999e74525d296f0a1cb19c95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classssh_1_1Channel.html">Channel</a>* ssh::Channel::acceptX11 </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeout_ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>accept an incoming X11 connection </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">timeout_ms</td><td>timeout for waiting, in ms </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new <a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> pointer on the X11 connection </dd>
<dd>
NULL in case of error </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>you have to delete this pointer after use </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#ga548bd0f77a50b7c8180942544b375866" title="Accept an X11 forwarding channel.">ssh_channel_accept_x11</a> </dd>
<dd>
Channel::requestX11 </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#ga548bd0f77a50b7c8180942544b375866">ssh_channel_accept_x11()</a>.</p>
</div>
</div>
<a class="anchor" id="a196b0eab10bf168330f569ff3881562c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Channel::changePtySize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>rows</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>change the size of a pseudoterminal </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cols</td><td>number of columns </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rows</td><td>number of rows </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#gaf5d55c90f3d98c583df23d21905c1127" title="Change the size of the terminal associated to a channel.">ssh_channel_change_pty_size</a> </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#gaf5d55c90f3d98c583df23d21905c1127">ssh_channel_change_pty_size()</a>.</p>
</div>
</div>
<a class="anchor" id="ad14405b4e8c3a8e3d37a49ed793aadde"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ssh::Channel::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>closes a channel </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#ga238f07e0455456a5bfd8a49ead917732" title="Close a channel.">ssh_channel_close</a> </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#ga238f07e0455456a5bfd8a49ead917732">ssh_channel_close()</a>.</p>
</div>
</div>
<a class="anchor" id="a38880d18d0fc357be0f4f8b8ef1c92ef"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ssh::Channel::isClosed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns true if channel is in closed state </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#gab2720b44cb7f1dfe2b38ffe07c2f45c7" title="Check if the channel is closed or not.">ssh_channel_is_closed</a> </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#gab2720b44cb7f1dfe2b38ffe07c2f45c7">ssh_channel_is_closed()</a>.</p>
</div>
</div>
<a class="anchor" id="a3bb4131d82cc033d75f65a5137053532"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ssh::Channel::isEof </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns true if channel is in EOF state </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#gab535264029443d77214c0615a0788b0a" title="Check if remote has sent an EOF.">ssh_channel_is_eof</a> </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#gab535264029443d77214c0615a0788b0a">ssh_channel_is_eof()</a>.</p>
</div>
</div>
<a class="anchor" id="aa2794c09f819f3132b241aa6b72b0664"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ssh::Channel::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns true if channel is in open state </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__libssh__channel.html#gaaafcda943c96ddb91e5c28c0bdee7045" title="Check if the channel is open or not.">ssh_channel_is_open</a> </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#gaaafcda943c96ddb91e5c28c0bdee7045">ssh_channel_is_open()</a>.</p>
</div>
</div>
<a class="anchor" id="a06cf7ffd971eff87783a169444fa09a2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ssh::Channel::write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>is_stderr</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes on a channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>data to write. </td></tr>
<tr><td class="paramname">len</td><td>number of bytes to write. </td></tr>
<tr><td class="paramname">is_stderr</td><td>write should be done on the stderr channel (server only) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of bytes written </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a></td><td>in case of error </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd>channel_write </dd>
<dd>
channel_write_stderr </dd></dl>
<p>References <a class="el" href="group__libssh__channel.html#ga5d658df773ba854b35ff9f905341e2fb">ssh_channel_write()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/libssh/<a class="el" href="libsshpp_8hpp_source.html">libsshpp.hpp</a></li>
</ul>
</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>
