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

Subclass of the standard SocketException that knows how to produce an error message from the OpenSSL error stack. More...

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

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

[legend]

Public Member Functions
	OpenSSLSocketException ()
	Creates an new OpenSSLSocketException with default values.
	OpenSSLSocketException (const Exception &ex)
	Conversion Constructor from some other Exception.
	OpenSSLSocketException (const OpenSSLSocketException &ex)
	Copy Constructor.
	OpenSSLSocketException (const char *file, const int lineNumber, const std::exception *cause, const char *msg,...)
	Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.
	OpenSSLSocketException (const std::exception *cause)
	Creates a new OpenSSLSocketException with the passed exception set as the cause of this exception.
	OpenSSLSocketException (const char *file, const int lineNumber, const char *msg,...)
	Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.
	OpenSSLSocketException (const char *file, const int lineNumber)
	Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.
virtual OpenSSLSocketException *	clone () const
	Clones this exception.
virtual	~OpenSSLSocketException () throw ()
Protected Member Functions
std::string	getErrorString () const
	Gets and formats an error message string from the OpenSSL error stack.

---

Detailed Description

Subclass of the standard SocketException that knows how to produce an error message from the OpenSSL error stack.

Since:

1.0

---

Constructor & Destructor Documentation

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException

(

)

Creates an new OpenSSLSocketException with default values.

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException

(

const Exception &

ex

)

Conversion Constructor from some other Exception.

Parameters:

ex

An Exception object that should become this type of Exception.

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException

(

const OpenSSLSocketException &

ex

)

Copy Constructor.

Parameters:

ex

The OpenSSLSocketException whose values should be copied to this instance.

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException	(	const char *	file,
		const int	lineNumber,
		const std::exception *	cause,
		const char *	msg,
			...
	)

Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.

Sets the message to report, using an optional list of arguments to parse into the message.

Parameters:

	file	The file name where exception occurs
	lineNumber	The line number where the exception occurred.
	cause	The exception that was the cause for this one to be thrown (can be null).
	msg	The error message to report.
	...	The list of primitives that are formatted into the message.

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException

(

const std::exception *

cause

)

Creates a new OpenSSLSocketException with the passed exception set as the cause of this exception.

Parameters:

cause

Pointer to the exception that caused this one to be thrown, the object is cloned caller retains ownership.

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException	(	const char *	file,
		const int	lineNumber,
		const char *	msg,
			...
	)

Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.

Sets the message to report, using an optional list of arguments to parse into the message.

Parameters:

	file	The file name where exception occurs.
	lineNumber	The line number where the exception occurred.
	msg	The error message to report.
	...	The list of primitives that are formatted into the message

decaf::internal::net::ssl::openssl::OpenSSLSocketException::OpenSSLSocketException	(	const char *	file,
		const int	lineNumber
	)

Create a new OpenSSLSocketException and initializes the file name and line number where this message occurred.

Sets the message to report by getting the complete set of error messages from the OpenSSL error stack and concatenating them into one string.

Parameters:

	file	The file name where exception occurs.
	lineNumber	The line number where the exception occurred.

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

(

)

throw () [virtual]

---

Member Function Documentation

virtual OpenSSLSocketException* decaf::internal::net::ssl::openssl::OpenSSLSocketException::clone

(

)

const [inline, virtual]

Clones this exception.

This is useful for cases where you need to preserve the type of the original exception as well as the message. All subclasses should override this method.

Returns:

a new Exception instance that is a copy of this Exception object.

Reimplemented from decaf::net::SocketException.

std::string decaf::internal::net::ssl::openssl::OpenSSLSocketException::getErrorString

(

)

const [protected]

Gets and formats an error message string from the OpenSSL error stack.

Returns:

a string containing the complete OpenSSL error string.

---

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

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