<!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: The libssh C++ wrapper</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">The libssh C++ wrapper</div> </div>
</div><!--header-->
<div class="contents">
<p>The C++ bindings for libssh are completely embedded in a single .hpp file, and this for two reasons:
<a href="#details">More...</a></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The C++ bindings for libssh are completely embedded in a single .hpp file, and this for two reasons: </p>
<ul>
<li>C++ is hard to keep binary compatible, C is easy. We try to keep libssh C version as much as possible binary compatible between releases, while this would be hard for C++. If you compile your program with these headers, you will only link to the C version of libssh which will be kept ABI compatible. No need to recompile your C++ program each time a new binary-compatible version of libssh is out</li>
<li>Most of the functions in this file are really short and are probably worth the "inline" linking mode, which the compiler can decide to do in some case. There would be nearly no performance penalty of using the wrapper rather than native calls.</li>
</ul>
<p>Please visit the documentation of <a class="el" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">ssh::Session</a> and <a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">ssh::Channel</a> </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classssh_1_1Session.html" title="The ssh::Session class contains the state of a SSH connection.">ssh::Session</a> </dd>
<dd>
<a class="el" href="classssh_1_1Channel.html" title="the ssh::Channel class describes the state of an SSH channel.">ssh::Channel</a></dd></dl>
<p>If you wish not to use C++ exceptions, please define SSH_NO_CPP_EXCEPTIONS: </p>
<div class="fragment"><div class="line"><span class="preprocessor">#define SSH_NO_CPP_EXCEPTIONS</span></div>
<div class="line"><span class="preprocessor">#include <libssh/libsshpp.hpp></span></div>
</div><!-- fragment --><p> All functions will then return SSH_ERROR in case of error. </p>
</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>
