<!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/libsshpp.hpp 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">libsshpp.hpp</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) 2010 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 LIBSSHPP_HPP_</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define LIBSSHPP_HPP_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/* do not use deprecated functions */</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define LIBSSH_LEGACY_0_4</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#include <libssh/libssh.h></span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#include <libssh/server.h></span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include <stdlib.h></span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#include <stdarg.h></span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#include <stdio.h></span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">namespace </span>ssh {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">class </span>Channel;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#ifndef SSH_NO_CPP_EXCEPTIONS</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="classssh_1_1SshException.html"> 74</a></span> <span class="keyword">class </span><a class="code" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a>{</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a>(ssh_session csession){</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  code=<a class="code" href="group__libssh__error.html#ga036433b7bf3d4ca94206253f58d136f9" title="Retrieve the error code from the last error.">ssh_get_error_code</a>(csession);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  description=std::string(<a class="code" href="group__libssh__error.html#ga9241586665bf21f823806473fc386258" title="Retrieve the error text message from the last error.">ssh_get_error</a>(csession));</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="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a>(<span class="keyword">const</span> <a class="code" href="classssh_1_1SshException.html" title="Some people do not like C++ exceptions.">SshException</a> &e){</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  code=e.code;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  description=e.description;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
<div class="line"><a name="l00089"></a><span class="lineno"><a class="code" href="classssh_1_1SshException.html#a3f736fef0b7dbf062d11f64aa41a61f4"> 89</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1SshException.html#a3f736fef0b7dbf062d11f64aa41a61f4" title="returns the Error code">getCode</a>(){</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">return</span> code;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  }</div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="classssh_1_1SshException.html#a712f65602f9ae8bc6737ed4b1e4ee4cc"> 96</a></span>  std::string <a class="code" href="classssh_1_1SshException.html#a712f65602f9ae8bc6737ed4b1e4ee4cc" title="returns the error message of the last exception">getError</a>(){</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> description;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">int</span> code;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  std::string description;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#define ssh_throw(x) if((x)==SSH_ERROR) throw SshException(getCSession())</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="preprocessor"></span><span class="preprocessor">#define ssh_throw_null(CSession,x) if((x)==NULL) throw SshException(CSession)</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="preprocessor"></span><span class="preprocessor">#define void_throwable void</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor"></span><span class="preprocessor">#define return_throwable return</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/* No exception at all. All functions will return an error code instead</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * of an exception</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="preprocessor">#define ssh_throw(x) if((x)==SSH_ERROR) return SSH_ERROR</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"></span><span class="preprocessor">#define ssh_throw_null(CSession,x) if((x)==NULL) return NULL</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor"></span><span class="preprocessor">#define void_throwable int</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="preprocessor"></span><span class="preprocessor">#define return_throwable return SSH_OK</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html"> 126</a></span> <span class="keyword">class </span><a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a> {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a>;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a>(){</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  c_session=<a class="code" href="group__libssh__session.html#gaadadc0f9601547c30db7c4d62017d32c" title="Create a new ssh session.">ssh_new</a>();</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  ~<a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a>(){</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="group__libssh__session.html#gae5af27a98a7488e9f5ded6b37c274156" title="Deallocate a SSH session handle.">ssh_free</a>(c_session);</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  c_session=NULL;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  }</div>
<div class="line"><a name="l00142"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#ad19ae4a0927094c12f383907cbf40ccc"> 142</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#ad19ae4a0927094c12f383907cbf40ccc" title="sets an SSH session options">setOption</a>(<span class="keyword">enum</span> ssh_options_e type, <span class="keyword">const</span> <span class="keywordtype">char</span> *option){</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  ssh_throw(<a class="code" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a>(c_session,type,option));</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  return_throwable;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div>
<div class="line"><a name="l00152"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#ad6dc221d1212370608516c89115f6470"> 152</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#ad6dc221d1212370608516c89115f6470" title="sets an SSH session options">setOption</a>(<span class="keyword">enum</span> ssh_options_e type, <span class="keywordtype">long</span> <span class="keywordtype">int</span> option){</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  ssh_throw(<a class="code" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a>(c_session,type,&option));</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  return_throwable;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  }</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a1bd14b987212698c146ed05f25454046"> 162</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#a1bd14b987212698c146ed05f25454046" title="sets an SSH session options">setOption</a>(<span class="keyword">enum</span> ssh_options_e type, <span class="keywordtype">void</span> *option){</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  ssh_throw(<a class="code" href="group__libssh__session.html#ga7a801b85800baa3f4e16f5b47db0a73d" title="This function can set all possible ssh options.">ssh_options_set</a>(c_session,type,option));</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  return_throwable;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  }</div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a2a88d7dd524e81cb9152a87cb6fefc40"> 170</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#a2a88d7dd524e81cb9152a87cb6fefc40" title="connects to the remote host">connect</a>(){</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__session.html#ga032e07cbd8bc3f14cb2dd375db0b03d7" title="Connect to the ssh server.">ssh_connect</a>(c_session);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  return_throwable;</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  }</div>
<div class="line"><a name="l00180"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a5a4d5abc13091ef27542aaa0a1caf6b4"> 180</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a5a4d5abc13091ef27542aaa0a1caf6b4" title="Authenticates automatically using public key.">userauthAutopubkey</a>(<span class="keywordtype">void</span>){</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#gad07655f2c742ce68271422197cf2acda" title="Tries to automatically authenticate with public key and "none".">ssh_userauth_autopubkey</a>(c_session,NULL);</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  }</div>
<div class="line"><a name="l00192"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a988398835fc131b0eb5a83a4adaec532"> 192</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a988398835fc131b0eb5a83a4adaec532" title="Authenticates using the "none" method.">userauthNone</a>(){</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga58e7c265236edbc97a2f117d3f23b4dd" title="Try to authenticate through the "none" method.">ssh_userauth_none</a>(c_session,NULL);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  }</div>
<div class="line"><a name="l00203"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#ac2d10826877bec6598961614eb62f0f7"> 203</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#ac2d10826877bec6598961614eb62f0f7" title="Authenticates using the password method.">userauthPassword</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *password){</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga50c0c150f8c4703e7ee49b3e3e3ca215" title="Try to authenticate by password.">ssh_userauth_password</a>(c_session,NULL,password);</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  }</div>
<div class="line"><a name="l00216"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a8ac19de04c5c6c396ce8d042052be4ca"> 216</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a8ac19de04c5c6c396ce8d042052be4ca" title="Try to authenticate using the publickey method.">userauthOfferPubkey</a>(<span class="keywordtype">int</span> type, ssh_string pubkey){</div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga78b485bf5c4e68ddfbc25f17de8b6521" title="Try to authenticate through public key.">ssh_userauth_offer_pubkey</a>(c_session,NULL,type,pubkey);</div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  }</div>
<div class="line"><a name="l00228"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a8356cb653749ecb816a3f1aefa37e687"> 228</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a8356cb653749ecb816a3f1aefa37e687" title="Authenticates using the publickey method.">userauthPubkey</a>(ssh_string pubkey, ssh_private_key privkey){</div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga18f0c63c75b9af6c28c032e93628a7c5" title="Try to authenticate through public key.">ssh_userauth_pubkey</a>(c_session,NULL,pubkey,privkey);</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  }</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a8356cb653749ecb816a3f1aefa37e687" title="Authenticates using the publickey method.">userauthPubkey</a>(ssh_private_key privkey){</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga18f0c63c75b9af6c28c032e93628a7c5" title="Try to authenticate through public key.">ssh_userauth_pubkey</a>(c_session,NULL,NULL,privkey);</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  }</div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  <span class="keywordtype">int</span> userauthPrivatekeyFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename,</div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *passphrase);</div>
<div class="line"><a name="l00245"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b"> 245</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a08d70b5cdb5bd1a2a8f5f9ebbdf67b3b" title="Returns the available authentication methods from the server.">getAuthList</a>(){</div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__auth.html#ga35d44897a44b4bb3b7c01108c1812a37" title="retrieves available authentication methods for this session">ssh_userauth_list</a>(c_session, NULL);</div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span>  }</div>
<div class="line"><a name="l00253"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#aaa6972fe2757370a0cf2b90576eb6edc"> 253</a></span>  <span class="keywordtype">void</span> <a class="code" href="classssh_1_1Session.html#aaa6972fe2757370a0cf2b90576eb6edc" title="Disconnects from the SSH server and closes connection.">disconnect</a>(){</div>
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <a class="code" href="group__libssh__session.html#ga0f048a4c0dbe02cfb7e9c5b6d0db0f27" title="Disconnect from a session (client or server).">ssh_disconnect</a>(c_session);</div>
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  }</div>
<div class="line"><a name="l00260"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a4e0c0bcc2cc0d129e049b5b51bf1cbe8"> 260</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classssh_1_1Session.html#a4e0c0bcc2cc0d129e049b5b51bf1cbe8" title="Returns the disconnect message from the server, if any.">getDisconnectMessage</a>(){</div>
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *msg=<a class="code" href="group__libssh__session.html#gad19e368e35d48e02ba95970a7d1e87f5" title="Get the disconnect message from the server.">ssh_get_disconnect_message</a>(c_session);</div>
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordflow">return</span> msg;</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  }</div>
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *getError(){</div>
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__error.html#ga9241586665bf21f823806473fc386258" title="Retrieve the error text message from the last error.">ssh_get_error</a>(c_session);</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  }</div>
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keywordtype">int</span> getErrorCode(){</div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__error.html#ga036433b7bf3d4ca94206253f58d136f9" title="Retrieve the error code from the last error.">ssh_get_error_code</a>(c_session);</div>
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  }</div>
<div class="line"><a name="l00282"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a30c021f6138124d785f151583e5656bd"> 282</a></span>  socket_t <a class="code" href="classssh_1_1Session.html#a30c021f6138124d785f151583e5656bd" title="returns the file descriptor used for the communication">getSocket</a>(){</div>
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__session.html#gafe509fcea47714b5cd277d1e35e83276" title="Get the fd of a connection.">ssh_get_fd</a>(c_session);</div>
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span>  }</div>
<div class="line"><a name="l00289"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a9969ed8dcaccef321ac519271758b406"> 289</a></span>  std::string <a class="code" href="classssh_1_1Session.html#a9969ed8dcaccef321ac519271758b406" title="gets the Issue banner from the ssh server">getIssueBanner</a>(){</div>
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  <span class="keywordtype">char</span> *banner=<a class="code" href="group__libssh__session.html#ga89864d4d5cc6d3d6ef1c39652f2a688f" title="Get the issue banner from the server.">ssh_get_issue_banner</a>(c_session);</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  std::string ret= std::string(banner);</div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  ::free(banner);</div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  }</div>
<div class="line"><a name="l00299"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a9e0af590062a73a0927bb513bc19dd8e"> 299</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a9e0af590062a73a0927bb513bc19dd8e" title="returns the OpenSSH version (server) if possible">getOpensshVersion</a>(){</div>
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__session.html#gac55d2895467a1e898ee75b4710d836a5" title="Get the version of the OpenSSH server, if it is not an OpenSSH server then 0 will be returned...">ssh_get_openssh_version</a>(c_session);</div>
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  }</div>
<div class="line"><a name="l00306"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a5d7b4df57ed97f2592893b0493336b88"> 306</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a5d7b4df57ed97f2592893b0493336b88" title="returns the version of the SSH protocol being used">getVersion</a>(){</div>
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__session.html#ga8467735e4735165336f68ee82e24de0e" title="Get the protocol version of the session.">ssh_get_version</a>(c_session);</div>
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  }</div>
<div class="line"><a name="l00315"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a0b7055cb236685a9c18cb79c5492b40f"> 315</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#a0b7055cb236685a9c18cb79c5492b40f" title="verifies that the server is known">isServerKnown</a>(){</div>
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span>  <span class="keywordtype">int</span> ret=<a class="code" href="group__libssh__session.html#ga6f37e3d7bb6b938b44d6a34a76fdfa0b" title="Check if the server is known.">ssh_is_server_known</a>(c_session);</div>
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  }</div>
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span>  <span class="keywordtype">void</span> log(<span class="keywordtype">int</span> priority, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...){</div>
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="keywordtype">char</span> buffer[1024];</div>
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span>  va_list va;</div>
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div>
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span>  va_start(va, format);</div>
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  vsnprintf(buffer, <span class="keyword">sizeof</span>(buffer), format, va);</div>
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  va_end(va);</div>
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  <a class="code" href="group__libssh__log.html#ga0bb252b81e0c497fc559c9e4007cf6c5" title="Log a SSH event.">ssh_log</a>(c_session,priority, <span class="stringliteral">"%s"</span>, buffer);</div>
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  }</div>
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> </div>
<div class="line"><a name="l00334"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a05cbc79d7b3ef14499fe258f56031957"> 334</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#a05cbc79d7b3ef14499fe258f56031957" title="copies options from a session to another">optionsCopy</a>(<span class="keyword">const</span> <a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a> &source){</div>
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  ssh_throw(<a class="code" href="group__libssh__session.html#gaead8cef1f39e785139bc510852ce1dff" title="Duplicate the options of a session structure.">ssh_options_copy</a>(source.c_session,&c_session));</div>
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  return_throwable;</div>
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  }</div>
<div class="line"><a name="l00343"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a0fe8a68c45f9f150bb306ae840f68f0f"> 343</a></span>  void_throwable <a class="code" href="classssh_1_1Session.html#a0fe8a68c45f9f150bb306ae840f68f0f" title="parses a configuration file for options">optionsParseConfig</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *file){</div>
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span>  ssh_throw(<a class="code" href="group__libssh__session.html#ga82371e723260c7572ea061edecc2e9f1" title="Parse the ssh config file.">ssh_options_parse_config</a>(c_session,file));</div>
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span>  return_throwable;</div>
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span>  }</div>
<div class="line"><a name="l00350"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a15b2a58607cc42628e17c94c8f7eb793"> 350</a></span>  <span class="keywordtype">void</span> <a class="code" href="classssh_1_1Session.html#a15b2a58607cc42628e17c94c8f7eb793" title="silently disconnect from remote host">silentDisconnect</a>(){</div>
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  <a class="code" href="group__libssh__session.html#gae1bd16255ba373325adf76307d0c8c42" title="Disconnect impolitely from a remote host by closing the socket.">ssh_silent_disconnect</a>(c_session);</div>
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  }</div>
<div class="line"><a name="l00358"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#ae55f054025dcbe4ceeaec87c9ca064c7"> 358</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Session.html#ae55f054025dcbe4ceeaec87c9ca064c7" title="Writes the known host file with current host key.">writeKnownhost</a>(){</div>
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  <span class="keywordtype">int</span> ret = <a class="code" href="group__libssh__session.html#gaf61a9cfdc40c76ffce9f9a8543755d36" title="Write the current server as known in the known hosts file.">ssh_write_knownhost</a>(c_session);</div>
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  }</div>
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span> </div>
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> *<a class="code" href="classssh_1_1Session.html#a6cd5318d71a3850a87b87bdfd89a5983" title="accept an incoming forward connection">acceptForward</a>(<span class="keywordtype">int</span> timeout_ms);</div>
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  <span class="comment">/* acceptForward is implemented later in this file */</span></div>
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span> </div>
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  void_throwable cancelForward(<span class="keyword">const</span> <span class="keywordtype">char</span> *address, <span class="keywordtype">int</span> port){</div>
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gac474d071d80e725c8b5633cb1d35c010" title="Sends the "cancel-tcpip-forward" global request to ask the server to cancel the tcpip-forward request...">ssh_forward_cancel</a>(c_session, address, port);</div>
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  ssh_throw(err);</div>
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  return_throwable;</div>
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span>  }</div>
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span> </div>
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  void_throwable listenForward(<span class="keyword">const</span> <span class="keywordtype">char</span> *address, <span class="keywordtype">int</span> port,</div>
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span>  <span class="keywordtype">int</span> &boundport){</div>
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga041a495f0230bb017cdf7459e6773664" title="Sends the "tcpip-forward" global request to ask the server to begin listening for inbound connections...">ssh_forward_listen</a>(c_session, address, port, &boundport);</div>
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span>  ssh_throw(err);</div>
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span>  return_throwable;</div>
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span>  }</div>
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> </div>
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span>  ssh_session c_session;</div>
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span>  ssh_session getCSession(){</div>
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span>  <span class="keywordflow">return</span> c_session;</div>
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span>  }</div>
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span>  <span class="comment">/* No copy constructor, no = operator */</span></div>
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span>  Session(<span class="keyword">const</span> Session &);</div>
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span>  Session& operator=(<span class="keyword">const</span> Session &);</div>
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> };</div>
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> </div>
<div class="line"><a name="l00402"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html"> 402</a></span> <span class="keyword">class </span><a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> {</div>
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a>;</div>
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span>  <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a>(<a class="code" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">Session</a> &session){</div>
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span>  channel=<a class="code" href="group__libssh__channel.html#gada8ccda7bf65165fe145d3096a252dcc" title="Allocate a new channel.">ssh_channel_new</a>(session.getCSession());</div>
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span>  this->session=&session;</div>
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span>  }</div>
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span>  ~<a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a>(){</div>
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span>  <a class="code" href="group__libssh__channel.html#gad1417f9eae8928fed20faafe2d9dbfff" title="Close and free a channel.">ssh_channel_free</a>(channel);</div>
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span>  channel=NULL;</div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  }</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> </div>
<div class="line"><a name="l00422"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#a62000c16999e74525d296f0a1cb19c95"> 422</a></span>  <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> *<a class="code" href="classssh_1_1Channel.html#a62000c16999e74525d296f0a1cb19c95" title="accept an incoming X11 connection">acceptX11</a>(<span class="keywordtype">int</span> timeout_ms){</div>
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span>  ssh_channel x11chan = <a class="code" href="group__libssh__channel.html#ga548bd0f77a50b7c8180942544b375866" title="Accept an X11 forwarding channel.">ssh_channel_accept_x11</a>(channel,timeout_ms);</div>
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span>  ssh_throw_null(getCSession(),x11chan);</div>
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span>  <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> *newchan = <span class="keyword">new</span> <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a>(getSession(),x11chan);</div>
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  <span class="keywordflow">return</span> newchan;</div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span>  }</div>
<div class="line"><a name="l00434"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#a196b0eab10bf168330f569ff3881562c"> 434</a></span>  void_throwable <a class="code" href="classssh_1_1Channel.html#a196b0eab10bf168330f569ff3881562c" title="change the size of a pseudoterminal">changePtySize</a>(<span class="keywordtype">int</span> cols, <span class="keywordtype">int</span> rows){</div>
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gaf5d55c90f3d98c583df23d21905c1127" title="Change the size of the terminal associated to a channel.">ssh_channel_change_pty_size</a>(channel,cols,rows);</div>
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span>  ssh_throw(err);</div>
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  return_throwable;</div>
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span>  }</div>
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> </div>
<div class="line"><a name="l00444"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#ad14405b4e8c3a8e3d37a49ed793aadde"> 444</a></span>  void_throwable <a class="code" href="classssh_1_1Channel.html#ad14405b4e8c3a8e3d37a49ed793aadde" title="closes a channel">close</a>(){</div>
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  ssh_throw(<a class="code" href="group__libssh__channel.html#ga238f07e0455456a5bfd8a49ead917732" title="Close a channel.">ssh_channel_close</a>(channel));</div>
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span>  return_throwable;</div>
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  }</div>
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> </div>
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span>  <span class="keywordtype">int</span> getExitStatus(){</div>
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__channel.html#ga9eea019dd0bbaa8a817fff2c762d1a2d" title="Get the exit status of the channel (error code from the executed instruction).">ssh_channel_get_exit_status</a>(channel);</div>
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  }</div>
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span>  Session &getSession(){</div>
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span>  <span class="keywordflow">return</span> *session;</div>
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span>  }</div>
<div class="line"><a name="l00458"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#a38880d18d0fc357be0f4f8b8ef1c92ef"> 458</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classssh_1_1Channel.html#a38880d18d0fc357be0f4f8b8ef1c92ef" title="returns true if channel is in closed state">isClosed</a>(){</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__channel.html#gab2720b44cb7f1dfe2b38ffe07c2f45c7" title="Check if the channel is closed or not.">ssh_channel_is_closed</a>(channel) != 0;</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  }</div>
<div class="line"><a name="l00464"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#a3bb4131d82cc033d75f65a5137053532"> 464</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classssh_1_1Channel.html#a3bb4131d82cc033d75f65a5137053532" title="returns true if channel is in EOF state">isEof</a>(){</div>
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__channel.html#gab535264029443d77214c0615a0788b0a" title="Check if remote has sent an EOF.">ssh_channel_is_eof</a>(channel) != 0;</div>
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span>  }</div>
<div class="line"><a name="l00470"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#aa2794c09f819f3132b241aa6b72b0664"> 470</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classssh_1_1Channel.html#aa2794c09f819f3132b241aa6b72b0664" title="returns true if channel is in open state">isOpen</a>(){</div>
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span>  <span class="keywordflow">return</span> <a class="code" href="group__libssh__channel.html#gaaafcda943c96ddb91e5c28c0bdee7045" title="Check if the channel is open or not.">ssh_channel_is_open</a>(channel) != 0;</div>
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span>  }</div>
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span>  <span class="keywordtype">int</span> openForward(<span class="keyword">const</span> <span class="keywordtype">char</span> *remotehost, <span class="keywordtype">int</span> remoteport,</div>
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *sourcehost=NULL, <span class="keywordtype">int</span> localport=0){</div>
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gae86b0704a1f2bdebb268b55567f7f47b" title="Open a TCP/IP forwarding channel.">ssh_channel_open_forward</a>(channel,remotehost,remoteport,</div>
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  sourcehost, localport);</div>
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span>  ssh_throw(err);</div>
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  <span class="keywordflow">return</span> err;</div>
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span>  }</div>
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span>  <span class="comment">/* TODO: completely remove this ? */</span></div>
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span>  void_throwable openSession(){</div>
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gaf051dd30d75bf6dc45d1a5088cf970bd" title="Open a session channel (suited for a shell, not TCP forwarding).">ssh_channel_open_session</a>(channel);</div>
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span>  ssh_throw(err);</div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span>  return_throwable;</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  }</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  <span class="keywordtype">int</span> poll(<span class="keywordtype">bool</span> is_stderr=<span class="keyword">false</span>){</div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga157f7d1df5de07ec6c6976e2034ba6e2" title="Polls a channel for data to read.">ssh_channel_poll</a>(channel,is_stderr);</div>
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span>  ssh_throw(err);</div>
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span>  <span class="keywordflow">return</span> err;</div>
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span>  }</div>
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span>  <span class="keywordtype">int</span> read(<span class="keywordtype">void</span> *dest, <span class="keywordtype">size_t</span> count, <span class="keywordtype">bool</span> is_stderr=<span class="keyword">false</span>){</div>
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span>  <span class="keywordtype">int</span> err;</div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span>  <span class="comment">/* handle int overflow */</span></div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  <span class="keywordflow">if</span>(count > 0x7fffffff)</div>
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span>  count = 0x7fffffff;</div>
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span>  err=<a class="code" href="group__libssh__channel.html#gac92381c4c5d4a7eab35f6e84686f033d" title="Reads data from a channel.">ssh_channel_read</a>(channel,dest,count,is_stderr);</div>
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span>  ssh_throw(err);</div>
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span>  <span class="keywordflow">return</span> err;</div>
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span>  }</div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span>  <span class="keywordtype">int</span> readNonblocking(<span class="keywordtype">void</span> *dest, <span class="keywordtype">size_t</span> count, <span class="keywordtype">bool</span> is_stderr=<span class="keyword">false</span>){</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  <span class="keywordtype">int</span> err;</div>
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span>  <span class="comment">/* handle int overflow */</span></div>
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span>  <span class="keywordflow">if</span>(count > 0x7fffffff)</div>
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span>  count = 0x7fffffff;</div>
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span>  err=<a class="code" href="group__libssh__channel.html#gaaca5a3fbe9839c3ffb37b746afc35f4c" title="Do a nonblocking read on the channel.">ssh_channel_read_nonblocking</a>(channel,dest,count,is_stderr);</div>
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span>  ssh_throw(err);</div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span>  <span class="keywordflow">return</span> err;</div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  }</div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span>  void_throwable requestEnv(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *value){</div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga7aede2f9af4c494ff9e41fc08a4572f1" title="Set environment variables.">ssh_channel_request_env</a>(channel,name,value);</div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span>  ssh_throw(err);</div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  return_throwable;</div>
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span>  }</div>
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> </div>
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span>  void_throwable requestExec(<span class="keyword">const</span> <span class="keywordtype">char</span> *cmd){</div>
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga567d509183ade0a77190f390e2b5747d" title="Run a shell command without an interactive shell.">ssh_channel_request_exec</a>(channel,cmd);</div>
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span>  ssh_throw(err);</div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span>  return_throwable;</div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span>  }</div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  void_throwable requestPty(<span class="keyword">const</span> <span class="keywordtype">char</span> *term=NULL, <span class="keywordtype">int</span> cols=0, <span class="keywordtype">int</span> rows=0){</div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span>  <span class="keywordtype">int</span> err;</div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  <span class="keywordflow">if</span>(term != NULL && cols != 0 && rows != 0)</div>
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span>  err=<a class="code" href="group__libssh__channel.html#gabb175414352256e1602286e0ab50886c" title="Request a pty with a specific type and size.">ssh_channel_request_pty_size</a>(channel,term,cols,rows);</div>
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span>  <span class="keywordflow">else</span></div>
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span>  err=<a class="code" href="group__libssh__channel.html#ga37c1cec33fe5a2f184768aba52e3a0db" title="Request a PTY.">ssh_channel_request_pty</a>(channel);</div>
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span>  ssh_throw(err);</div>
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span>  return_throwable;</div>
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span>  }</div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> </div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  void_throwable requestShell(){</div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gaed4c5fb30c9df2b2548421ccf4e81bf1" title="Request a shell.">ssh_channel_request_shell</a>(channel);</div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  ssh_throw(err);</div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span>  return_throwable;</div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  }</div>
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span>  void_throwable requestSendSignal(<span class="keyword">const</span> <span class="keywordtype">char</span> *signum){</div>
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gaa98315fca818b561970a6950683f4053" title="Send a signal to remote process (as described in RFC 4254, section 6.9).">ssh_channel_request_send_signal</a>(channel, signum);</div>
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span>  ssh_throw(err);</div>
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span>  return_throwable;</div>
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span>  }</div>
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span>  void_throwable requestSubsystem(<span class="keyword">const</span> <span class="keywordtype">char</span> *subsystem){</div>
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga06024b070f9b2a3d6964b79ae36695b7" title="Request a subsystem (for example "sftp").">ssh_channel_request_subsystem</a>(channel,subsystem);</div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span>  ssh_throw(err);</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  return_throwable;</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  }</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  <span class="keywordtype">int</span> requestX11(<span class="keywordtype">bool</span> single_connection,</div>
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *protocol, <span class="keyword">const</span> <span class="keywordtype">char</span> *cookie, <span class="keywordtype">int</span> screen_number){</div>
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#gadfa34624c28164bd73453cd04aa64c1f" title="Sends the "x11-req" channel request over an existing session channel.">ssh_channel_request_x11</a>(channel,single_connection,</div>
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span>  protocol, cookie, screen_number);</div>
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span>  ssh_throw(err);</div>
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span>  <span class="keywordflow">return</span> err;</div>
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span>  }</div>
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span>  void_throwable sendEof(){</div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span>  <span class="keywordtype">int</span> err=<a class="code" href="group__libssh__channel.html#ga072f82fdf3e50514f747653af2c99004" title="Send an end of file on the channel.">ssh_channel_send_eof</a>(channel);</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  ssh_throw(err);</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  return_throwable;</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  }</div>
<div class="line"><a name="l00566"></a><span class="lineno"><a class="code" href="classssh_1_1Channel.html#a06cf7ffd971eff87783a169444fa09a2"> 566</a></span>  <span class="keywordtype">int</span> <a class="code" href="classssh_1_1Channel.html#a06cf7ffd971eff87783a169444fa09a2" title="Writes on a channel.">write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">bool</span> is_stderr=<span class="keyword">false</span>){</div>
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span>  <span class="keywordtype">int</span> ret;</div>
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span>  <span class="keywordflow">if</span>(is_stderr){</div>
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span>  ret=ssh_channel_write_stderr(channel,data,len);</div>
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span>  } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span>  ret=<a class="code" href="group__libssh__channel.html#ga5d658df773ba854b35ff9f905341e2fb" title="Blocking write on a channel.">ssh_channel_write</a>(channel,data,len);</div>
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span>  }</div>
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span>  ssh_throw(ret);</div>
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span>  <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span>  }</div>
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span>  ssh_session getCSession(){</div>
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span>  <span class="keywordflow">return</span> session->getCSession();</div>
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span>  }</div>
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span>  Channel (Session &session, ssh_channel c_channel){</div>
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span>  this->channel=c_channel;</div>
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span>  this->session=&session;</div>
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span>  }</div>
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span>  Session *session;</div>
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span>  ssh_channel channel;</div>
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span>  <span class="comment">/* No copy and no = operator */</span></div>
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span>  Channel(<span class="keyword">const</span> Channel &);</div>
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  Channel &operator=(<span class="keyword">const</span> Channel &);</div>
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> };</div>
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> </div>
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> </div>
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment">/* This code cannot be put inline due to references to Channel */</span></div>
<div class="line"><a name="l00593"></a><span class="lineno"><a class="code" href="classssh_1_1Session.html#a6cd5318d71a3850a87b87bdfd89a5983"> 593</a></span> <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> *<a class="code" href="classssh_1_1Session.html#a6cd5318d71a3850a87b87bdfd89a5983" title="accept an incoming forward connection">Session::acceptForward</a>(<span class="keywordtype">int</span> timeout_ms){</div>
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span>  ssh_channel forward = <a class="code" href="group__libssh__channel.html#ga205d5ea76fb140075ebb1c20b8f193d3" title="Accept an incoming TCP/IP forwarding channel.">ssh_forward_accept</a>(c_session,</div>
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span>  timeout_ms);</div>
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span>  ssh_throw_null(c_session,forward);</div>
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span>  <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a> *newchan = <span class="keyword">new</span> <a class="code" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">Channel</a>(*<span class="keyword">this</span>,forward);</div>
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span>  <span class="keywordflow">return</span> newchan;</div>
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span>  }</div>
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> </div>
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> } <span class="comment">// namespace ssh</span></div>
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> </div>
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="preprocessor">#endif </span><span class="comment">/* LIBSSHPP_HPP_ */</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>
