decaf::internal::net::ssl::openssl::OpenSSLServerSocket Class Reference

SSLServerSocket based on OpenSSL library code. More...

#include <src/main/decaf/internal/net/ssl/openssl/OpenSSLServerSocket.h>

Inheritance diagram for decaf::internal::net::ssl::openssl::OpenSSLServerSocket:

[legend]

Public Member Functions
	OpenSSLServerSocket (OpenSSLParameters *parameters)
virtual	~OpenSSLServerSocket ()
virtual std::vector< std::string >	getSupportedCipherSuites () const
	Gets a vector containing the names of all the cipher suites that are supported by this SSLServerSocket.Normally not all of these cipher suites will be enabled on the Socket. Returns: a vector containing the names of all the supported cipher suites.
virtual std::vector< std::string >	getSupportedProtocols () const
	Gets a vector containing the names of all the protocols that could be enabled for this SSLServerSocket instance. Returns: a vector containing the names of all the supported protocols.
virtual std::vector< std::string >	getEnabledCipherSuites () const
	Returns a vector containing the names of all the currently enabled Cipher Suites for this SSLServerSocket. Returns: vector of the names of all enabled Cipher Suites.
virtual void	setEnabledCipherSuites (const std::vector< std::string > &suites)
	Sets the Cipher Suites that are to be enabled on the SSLServerSocket 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. Parameters: suites  An Vector of names for all the Cipher Suites that are to be enabled. Exceptions: IllegalArgumentException  if the vector is empty or one of the names is invalid.
virtual std::vector< std::string >	getEnabledProtocols () const
	Returns a vector containing the names of all the currently enabled Protocols for this SSLServerSocket. Returns: vector of the names of all enabled Protocols.
virtual void	setEnabledProtocols (const std::vector< std::string > &protocols)
	Sets the Protocols that are to be enabled on the SSLServerSocket connection.Each of the named Protocols must appear in the list of supported protocols suites for this connection or an exception will be thrown. Parameters: protocols  An Vector of names for all the Protocols that are to be enabled. Exceptions: IllegalArgumentException  if the vector is empty or one of the names is invalid.
virtual bool	getWantClientAuth () const
	Returns: true if the Socket request client Authentication.
virtual void	setWantClientAuth (bool value)
	Sets whether or not this Socket will request Client Authentication.If set to true the Socket (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. Parameters: value  Whether the server socket should request client authentication.
virtual bool	getNeedClientAuth () const
	Returns: true if the Socket requires client Authentication.
virtual void	setNeedClientAuth (bool value)
	Sets whether or not this Socket will require Client Authentication.If set to true the Socket (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. Parameters: value  Whether the server socket should require client authentication.
virtual decaf::net::Socket *	accept ()
	Listens for a connection request on the bound IPAddress and Port for this ServerSocket, the caller blocks until a connection is made.If the SO_TIMEOUT option is set this method could throw a SocketTimeoutException if the operation times out. Returns: a new Socket object pointer. Never returns NULL, the returned pointer is owned by the caller and must be explicitly freed by them. Exceptions: IOException  if an I/O error occurs while binding the socket. SocketException  if an error occurs while blocking on the accept call. SocketTimeoutException  if the SO_TIMEOUT option was used and the accept timed out.

---

Detailed Description

SSLServerSocket based on OpenSSL library code.

Since:

1.0

---

Constructor & Destructor Documentation

decaf::internal::net::ssl::openssl::OpenSSLServerSocket::OpenSSLServerSocket

(

OpenSSLParameters *

parameters

)

virtual decaf::internal::net::ssl::openssl::OpenSSLServerSocket::~OpenSSLServerSocket

(

)

[virtual]

---

Member Function Documentation

virtual decaf::net::Socket* decaf::internal::net::ssl::openssl::OpenSSLServerSocket::accept

(

)

[virtual]

Listens for a connection request on the bound IPAddress and Port for this ServerSocket, the caller blocks until a connection is made.If the SO_TIMEOUT option is set this method could throw a SocketTimeoutException if the operation times out.

Returns:

a new Socket object pointer. Never returns NULL, the returned pointer is owned by the caller and must be explicitly freed by them.

Exceptions:

	IOException	if an I/O error occurs while binding the socket.
	SocketException	if an error occurs while blocking on the accept call.
	SocketTimeoutException	if the SO_TIMEOUT option was used and the accept timed out.

Reimplemented from decaf::net::ServerSocket.

virtual std::vector<std::string> decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledCipherSuites

(

)

const [virtual]

Returns a vector containing the names of all the currently enabled Cipher Suites for this SSLServerSocket.

Returns:

vector of the names of all enabled Cipher Suites.

Implements decaf::net::ssl::SSLServerSocket.

virtual std::vector<std::string> decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getEnabledProtocols

(

)

const [virtual]

Returns a vector containing the names of all the currently enabled Protocols for this SSLServerSocket.

Returns:

vector of the names of all enabled Protocols.

Implements decaf::net::ssl::SSLServerSocket.

virtual bool decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getNeedClientAuth

(

)

const [virtual]

Returns:

true if the Socket requires client Authentication.

Implements decaf::net::ssl::SSLServerSocket.

virtual std::vector<std::string> decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedCipherSuites

(

)

const [virtual]

Gets a vector containing the names of all the cipher suites that are supported by this SSLServerSocket.Normally not all of these cipher suites will be enabled on the Socket.

Returns:

a vector containing the names of all the supported cipher suites.

Implements decaf::net::ssl::SSLServerSocket.

virtual std::vector<std::string> decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getSupportedProtocols

(

)

const [virtual]

Gets a vector containing the names of all the protocols that could be enabled for this SSLServerSocket instance.

Returns:

a vector containing the names of all the supported protocols.

Implements decaf::net::ssl::SSLServerSocket.

virtual bool decaf::internal::net::ssl::openssl::OpenSSLServerSocket::getWantClientAuth

(

)

const [virtual]

Returns:

true if the Socket request client Authentication.

Implements decaf::net::ssl::SSLServerSocket.

virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledCipherSuites

(

const std::vector< std::string > &

suites

)

[virtual]

Sets the Cipher Suites that are to be enabled on the SSLServerSocket 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.

Parameters:

suites

An Vector of names for all the Cipher Suites that are to be enabled.

Exceptions:

IllegalArgumentException

if the vector is empty or one of the names is invalid.

Implements decaf::net::ssl::SSLServerSocket.

virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setEnabledProtocols

(

const std::vector< std::string > &

protocols

)

[virtual]

Sets the Protocols that are to be enabled on the SSLServerSocket connection.Each of the named Protocols must appear in the list of supported protocols suites for this connection or an exception will be thrown.

Parameters:

protocols

An Vector of names for all the Protocols that are to be enabled.

Exceptions:

IllegalArgumentException

if the vector is empty or one of the names is invalid.

Implements decaf::net::ssl::SSLServerSocket.

virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setNeedClientAuth

(

bool

value

)

[virtual]

Sets whether or not this Socket will require Client Authentication.If set to true the Socket (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.

Parameters:

value

Whether the server socket should require client authentication.

Implements decaf::net::ssl::SSLServerSocket.

virtual void decaf::internal::net::ssl::openssl::OpenSSLServerSocket::setWantClientAuth

(

bool

value

)

[virtual]

Sets whether or not this Socket will request Client Authentication.If set to true the Socket (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.

Parameters:

value

Whether the server socket should request client authentication.

Implements decaf::net::ssl::SSLServerSocket.

---

The documentation for this class was generated from the following file:

• src/main/decaf/internal/net/ssl/openssl/OpenSSLServerSocket.h