blob: 984c5a614c676f9c98f845f168db6b46f7cfa40f [file] [log] [blame]
<!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"/>
<title>activemq-cpp-3.4.0: decaf::internal::net::ssl::openssl::OpenSSLServerSocket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">activemq-cpp-3.4.0</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;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&#160;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>decaf::internal::net::ssl::openssl::OpenSSLServerSocket Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="decaf::internal::net::ssl::openssl::OpenSSLServerSocket" --><!-- doxytag: inherits="decaf::net::ssl::SSLServerSocket" -->
<p>SSLServerSocket based on OpenSSL library code.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_open_s_s_l_server_socket_8h_source.html">src/main/decaf/internal/net/ssl/openssl/OpenSSLServerSocket.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for decaf::internal::net::ssl::openssl::OpenSSLServerSocket:</div>
<div class="dyncontent">
<div class="center"><img src="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket__inherit__graph.png" border="0" usemap="#decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket_inherit__map" alt="Inheritance graph"/></div>
<map name="decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket_inherit__map" id="decaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket_inherit__map">
<area shape="rect" id="node2" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p..." alt="" coords="84,83,329,112"/><area shape="rect" id="node4" href="classdecaf_1_1net_1_1_server_socket.html" title="This class implements server sockets." alt="" coords="109,5,304,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#aa04d93f255ae73e0588a0b41736c97b5">OpenSSLServerSocket</a> (<a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_parameters.html">OpenSSLParameters</a> *parameters)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#ab5e43749871c98bf16943f50bd2e0335">~OpenSSLServerSocket</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#a3c27ff7e17f073fee47e33026156404c">getSupportedCipherSuites</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a vector containing the names of all the cipher suites that are supported by this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.Normally not all of these cipher suites will be enabled on the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>a vector containing the names of all the supported cipher suites.</dd></dl>
<a href="#a3c27ff7e17f073fee47e33026156404c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#a3a4aaa5b894aeeb337930372c2ea6321">getSupportedProtocols</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a vector containing the names of all the protocols that could be enabled for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> instance.<dl class="return"><dt><b>Returns:</b></dt><dd>a vector containing the names of all the supported protocols.</dd></dl>
<a href="#a3a4aaa5b894aeeb337930372c2ea6321"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#ae62bbbfd88e6bbe48c6dde149d406d51">getEnabledCipherSuites</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a vector containing the names of all the currently enabled Cipher Suites for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>vector of the names of all enabled Cipher Suites.</dd></dl>
<a href="#ae62bbbfd88e6bbe48c6dde149d406d51"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#af89d718d4028b64ff9765ef1fd504251">setEnabledCipherSuites</a> (const std::vector&lt; std::string &gt; &amp;suites)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Cipher Suites that are to be enabled on the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> connection.Each of the named Cipher Suites must appear in the list of supported cipher suites for this connection or an exception will be thrown.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">suites</td><td>An Vector of names for all the Cipher Suites that are to be enabled.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the vector is empty or one of the names is invalid.</td></tr>
</table>
</dd>
</dl>
<a href="#af89d718d4028b64ff9765ef1fd504251"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#ad77357bc245d6ee7451ccb0d40555930">getEnabledProtocols</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a vector containing the names of all the currently enabled Protocols for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>vector of the names of all enabled Protocols.</dd></dl>
<a href="#ad77357bc245d6ee7451ccb0d40555930"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#af9fb25daf2c2282824f614e9d1148b63">setEnabledProtocols</a> (const std::vector&lt; std::string &gt; &amp;protocols)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Protocols that are to be enabled on the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> connection.Each of the named Protocols must appear in the list of supported protocols suites for this connection or an exception will be thrown.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">protocols</td><td>An Vector of names for all the Protocols that are to be enabled.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the vector is empty or one of the names is invalid.</td></tr>
</table>
</dd>
</dl>
<a href="#af9fb25daf2c2282824f614e9d1148b63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#ad4f4ec0e47216993d4ad14e276d43ae0">getWantClientAuth</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> request client Authentication.</dd></dl>
<a href="#ad4f4ec0e47216993d4ad14e276d43ae0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#a45d6d1e6dbb5e831ab1488844e2a9aef">setWantClientAuth</a> (bool value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether or not this <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> will request Client Authentication.If set to true the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> (when used in server mode) will request that the client authenticate itself, if the client doesn't send authentication the socket will still allow negotiation to continue.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Whether the server socket should request client authentication.</td></tr>
</table>
</dd>
</dl>
<a href="#a45d6d1e6dbb5e831ab1488844e2a9aef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#a2ad342fa1340a24da8821e2a6af861b3">getNeedClientAuth</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> requires client Authentication.</dd></dl>
<a href="#a2ad342fa1340a24da8821e2a6af861b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#aa60ec77a32a0ecada75b685c672b7a2d">setNeedClientAuth</a> (bool value)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether or not this <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> will require Client Authentication.If set to true the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> (when used in server mode) will require that the client authenticate itself, if the client doesn't send authentication the socket will not allow negotiation to continue.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Whether the server socket should require client authentication.</td></tr>
</table>
</dd>
</dl>
<a href="#aa60ec77a32a0ecada75b685c672b7a2d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classdecaf_1_1net_1_1_socket.html">decaf::net::Socket</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html#aff03b93ea3e03cd106205b123f30a2df">accept</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Listens for a connection request on the bound IPAddress and Port for this <a class="el" href="classdecaf_1_1net_1_1_server_socket.html" title="This class implements server sockets.">ServerSocket</a>, the caller blocks until a connection is made.If the SO_TIMEOUT option is set this method could throw a <a class="el" href="classdecaf_1_1net_1_1_socket_timeout_exception.html">SocketTimeoutException</a> if the operation times out.<dl class="return"><dt><b>Returns:</b></dt><dd>a new <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> object pointer. Never returns NULL, the returned pointer is owned by the caller and must be explicitly freed by them.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td>if an I/O error occurs while binding the socket. </td></tr>
<tr><td class="paramname"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html" title="Exception for errors when manipulating sockets.">SocketException</a></td><td>if an error occurs while blocking on the accept call. </td></tr>
<tr><td class="paramname"><a class="el" href="classdecaf_1_1net_1_1_socket_timeout_exception.html">SocketTimeoutException</a></td><td>if the SO_TIMEOUT option was used and the accept timed out.</td></tr>
</table>
</dd>
</dl>
<a href="#aff03b93ea3e03cd106205b123f30a2df"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>SSLServerSocket based on OpenSSL library code. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.0 </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa04d93f255ae73e0588a0b41736c97b5"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::OpenSSLServerSocket" ref="aa04d93f255ae73e0588a0b41736c97b5" args="(OpenSSLParameters *parameters)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">decaf::internal::net::ssl::openssl::OpenSSLServerSocket::OpenSSLServerSocket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_parameters.html">OpenSSLParameters</a> *&#160;</td>
<td class="paramname"><em>parameters</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab5e43749871c98bf16943f50bd2e0335"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::~OpenSSLServerSocket" ref="ab5e43749871c98bf16943f50bd2e0335" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual decaf::internal::net::ssl::openssl::OpenSSLServerSocket::~OpenSSLServerSocket </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff03b93ea3e03cd106205b123f30a2df"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::accept" ref="aff03b93ea3e03cd106205b123f30a2df" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classdecaf_1_1net_1_1_socket.html">decaf::net::Socket</a>* decaf::internal::net::ssl::openssl::OpenSSLServerSocket::accept </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Listens for a connection request on the bound IPAddress and Port for this <a class="el" href="classdecaf_1_1net_1_1_server_socket.html" title="This class implements server sockets.">ServerSocket</a>, the caller blocks until a connection is made.If the SO_TIMEOUT option is set this method could throw a <a class="el" href="classdecaf_1_1net_1_1_socket_timeout_exception.html">SocketTimeoutException</a> if the operation times out.<dl class="return"><dt><b>Returns:</b></dt><dd>a new <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> object pointer. Never returns NULL, the returned pointer is owned by the caller and must be explicitly freed by them.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td>if an I/O error occurs while binding the socket. </td></tr>
<tr><td class="paramname"><a class="el" href="classdecaf_1_1net_1_1_socket_exception.html" title="Exception for errors when manipulating sockets.">SocketException</a></td><td>if an error occurs while blocking on the accept call. </td></tr>
<tr><td class="paramname"><a class="el" href="classdecaf_1_1net_1_1_socket_timeout_exception.html">SocketTimeoutException</a></td><td>if the SO_TIMEOUT option was used and the accept timed out.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Reimplemented from <a class="el" href="classdecaf_1_1net_1_1_server_socket.html#abaa1ef748df7aab85a35ccebf56418c0">decaf::net::ServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="ae62bbbfd88e6bbe48c6dde149d406d51"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledCipherSuites" ref="ae62bbbfd88e6bbe48c6dde149d406d51" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt;std::string&gt; decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledCipherSuites </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a vector containing the names of all the currently enabled Cipher Suites for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>vector of the names of all enabled Cipher Suites.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a0430c1b4c3c71e002bddd5c3a468265e">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="ad77357bc245d6ee7451ccb0d40555930"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledProtocols" ref="ad77357bc245d6ee7451ccb0d40555930" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt;std::string&gt; decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledProtocols </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a vector containing the names of all the currently enabled Protocols for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>vector of the names of all enabled Protocols.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#ab979fe8369174aa51f5aa14cee86c82d">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a2ad342fa1340a24da8821e2a6af861b3"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getNeedClientAuth" ref="a2ad342fa1340a24da8821e2a6af861b3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getNeedClientAuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> requires client Authentication.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a143e5dea3b7e85bd3c33c24172a5db48">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a3c27ff7e17f073fee47e33026156404c"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedCipherSuites" ref="a3c27ff7e17f073fee47e33026156404c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt;std::string&gt; decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedCipherSuites </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a vector containing the names of all the cipher suites that are supported by this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a>.Normally not all of these cipher suites will be enabled on the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a>.<dl class="return"><dt><b>Returns:</b></dt><dd>a vector containing the names of all the supported cipher suites.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a63bf65fdbb24fd6012ea638713c19719">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a3a4aaa5b894aeeb337930372c2ea6321"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedProtocols" ref="a3a4aaa5b894aeeb337930372c2ea6321" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::vector&lt;std::string&gt; decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedProtocols </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets a vector containing the names of all the protocols that could be enabled for this <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> instance.<dl class="return"><dt><b>Returns:</b></dt><dd>a vector containing the names of all the supported protocols.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a2afabac8421d0d24aca725bf7553d3ab">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="ad4f4ec0e47216993d4ad14e276d43ae0"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getWantClientAuth" ref="ad4f4ec0e47216993d4ad14e276d43ae0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getWantClientAuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><dl class="return"><dt><b>Returns:</b></dt><dd>true if the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> request client Authentication.</dd></dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a100fd644439d6fcec2bc512b10e4c613">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="af89d718d4028b64ff9765ef1fd504251"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledCipherSuites" ref="af89d718d4028b64ff9765ef1fd504251" args="(const std::vector&lt; std::string &gt; &amp;suites)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledCipherSuites </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>suites</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Cipher Suites that are to be enabled on the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> connection.Each of the named Cipher Suites must appear in the list of supported cipher suites for this connection or an exception will be thrown.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">suites</td><td>An Vector of names for all the Cipher Suites that are to be enabled.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the vector is empty or one of the names is invalid.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a73a506d2fda4dc47c97cf8fbd5f72e94">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="af9fb25daf2c2282824f614e9d1148b63"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledProtocols" ref="af9fb25daf2c2282824f614e9d1148b63" args="(const std::vector&lt; std::string &gt; &amp;protocols)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledProtocols </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>protocols</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Protocols that are to be enabled on the <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html" title="Represents a server socket that is used to accept connections from clients using the Secure Sockets p...">SSLServerSocket</a> connection.Each of the named Protocols must appear in the list of supported protocols suites for this connection or an exception will be thrown.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">protocols</td><td>An Vector of names for all the Protocols that are to be enabled.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">IllegalArgumentException</td><td>if the vector is empty or one of the names is invalid.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#a2661d2499a193690373d0335bcd472e4">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="aa60ec77a32a0ecada75b685c672b7a2d"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setNeedClientAuth" ref="aa60ec77a32a0ecada75b685c672b7a2d" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setNeedClientAuth </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether or not this <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> will require Client Authentication.If set to true the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> (when used in server mode) will require that the client authenticate itself, if the client doesn't send authentication the socket will not allow negotiation to continue.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Whether the server socket should require client authentication.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#aed502f104ddbacbc3c8fb7088916184b">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a45d6d1e6dbb5e831ab1488844e2a9aef"></a><!-- doxytag: member="decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setWantClientAuth" ref="a45d6d1e6dbb5e831ab1488844e2a9aef" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setWantClientAuth </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets whether or not this <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> will request Client Authentication.If set to true the <a class="el" href="classdecaf_1_1net_1_1_socket.html">Socket</a> (when used in server mode) will request that the client authenticate itself, if the client doesn't send authentication the socket will still allow negotiation to continue.<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>Whether the server socket should request client authentication.</td></tr>
</table>
</dd>
</dl>
</p>
<p>Implements <a class="el" href="classdecaf_1_1net_1_1ssl_1_1_s_s_l_server_socket.html#ae51de9d3af85214925dd461d9f69a73d">decaf::net::ssl::SSLServerSocket</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/main/decaf/internal/net/ssl/openssl/<a class="el" href="_open_s_s_l_server_socket_8h_source.html">OpenSSLServerSocket.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacedecaf.html">decaf</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal.html">internal</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net.html">net</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net_1_1ssl.html">ssl</a> </li>
<li class="navelem"><a class="el" href="namespacedecaf_1_1internal_1_1net_1_1ssl_1_1openssl.html">openssl</a> </li>
<li class="navelem"><a class="el" href="classdecaf_1_1internal_1_1net_1_1ssl_1_1openssl_1_1_open_s_s_l_server_socket.html">OpenSSLServerSocket</a> </li>
<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>