xtd::net::sockets::socket_exception Class Reference

Inheritance diagram for xtd::net::sockets::socket_exception:

Definition

The exception that is thrown when a socket error occurs.

class socket_exception : public xtd::system_exception

Inheritance

xtd::system_exception → xtd::net::sockets::socket_exception

Header

#include <xtd/net/sockets/socket_exception>

Namespace

xtd::net::sockets

Library

xtd.core

Examples

The following example demonstrates how to throw and catch an socket_exception.

Public Constructors
	socket_exception (const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (int32 error_code, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception with the specified error code.
	socket_exception (int32 error_code, const std::optional< xtd::string > &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception with the specified error code and message.
	socket_exception (xtd::net::sockets::socket_error socket_errorsocket_error, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception with the specified socket error.
	socket_exception (xtd::net::sockets::socket_error socket_errorsocket_error, const std::optional< xtd::string > &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception with the specified socket error and message.

Public Properties
auto	socket_error_code () const noexcept -> xtd::int32
	Gets the error code that is associated with this exception.
virtual auto	socket_error () const noexcept -> xtd::net::sockets::socket_error
	Gets the socket error that is associated with this exception.

Public Deprecated Constructors
	socket_exception (const xtd::string &message, const std::error_code &error, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const std::error_code &error, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const std::exception &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const std::exception &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const std::exception &inner_exception, const std::error_code &error, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const std::exception &inner_exception, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.
	socket_exception (const xtd::string &message, const std::exception &inner_exception, const std::error_code &error, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class socket_exception.

Additional Inherited Members
using	exception_ref
	Optional reference wrapper on std::exception.
	system_exception (const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::optional< xtd::string > &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
template<typename exception_t>
	system_exception (const xtd::optional< xtd::string > &message, const exception_t &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
virtual auto	file_path () const noexcept -> const xtd::string &
	Gets file path where exception occurred.
virtual auto	line_number () const noexcept -> xtd::usize
	Gets Line number where the exception occurred.
virtual auto	member_name () const noexcept -> const xtd::string &
	Gets file member where exception occurred.
virtual auto	name () const noexcept -> const xtd::string &
	Gets full class name the exception.
	system_exception (const xtd::string &message, const std::error_code &error, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const std::error_code &error, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const std::exception &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const std::exception &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const std::exception &inner_exception, const std::error_code &error, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const std::exception &inner_exception, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	system_exception (const xtd::string &message, const std::exception &inner_exception, const std::error_code &error, const xtd::string &help_link, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class xtd::system_exception.
	exception (const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.
	exception (const xtd::optional< xtd::string > &message, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.
template<typename exception_t>
	exception (const xtd::optional< xtd::string > &message, const exception_t &inner_exception, const xtd::diagnostics::stack_frame &stack_frame=xtd::diagnostics::stack_frame::current())
	Create a new instance of class exception.
virtual auto	help_link () const noexcept -> const xtd::string &
	Gets a link to the help file associated with this exception.
virtual auto	help_link (const xtd::string &value) noexcept -> void
	Sets a link to the help file associated with this exception.
virtual auto	h_result () const noexcept -> xtd::int32
	Gets HRESULT, a coded numerical value that is assigned to a specific exception.
virtual auto	h_result (xtd::int32 value) noexcept -> void
	Sets HRESULT, a coded numerical value that is assigned to a specific exception.
virtual auto	error_code () const noexcept -> const std::error_code &
	Gets error associate to the exception.
virtual auto	error_code (const std::error_code &value) noexcept -> void
	Sets error associate to the exception.
virtual auto	inner_exception () const noexcept -> exception_ref
	Gets the exception instance that caused the current exception.
virtual auto	message () const noexcept -> const xtd::string &
	Gets message associate to the exception.
virtual auto	source () const noexcept -> const xtd::string &
	Gets the name of the application or the object that causes the error.
virtual auto	source (const xtd::string &value) noexcept -> void
	Sets the name of the application or the object that causes the error.
virtual auto	stack_trace () const noexcept -> xtd::string
	Gets a string representation of the immediate frames on the call stack.
virtual auto	get_last_stack_frame () const noexcept -> const xtd::diagnostics::stack_frame &
	Gets the last stack frame where the exception occurred.
auto	to_string () const noexcept -> xtd::string override
	Returns a string that represents the current exception.
auto	what () const noexcept -> const char *override
	Gets message associate to the exception.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
static auto	enable_stack_trace () noexcept -> bool
	Gets if the generation of the stack trace is enabled.
static auto	enable_stack_trace (bool enable) noexcept -> void
	Sets if the generation of the stack trace is enabled. @paran enable triue if stack trace enabled; otherwise false.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

socket_exception() [1/13]

xtd::net::sockets::socket_exception::socket_exception ( const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class socket_exception.

Parameters

stack_frame

(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Remarks

Message is set with the default message associate to the exception.

socket_exception() [2/13]

xtd::net::sockets::socket_exception::socket_exception ( int32 error_code, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class socket_exception with the specified error code.

Parameters

error_code	The error code that indicates the error that occurred.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

socket_exception() [3/13]

xtd::net::sockets::socket_exception::socket_exception ( int32 error_code, const std::optional< xtd::string > & message, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class socket_exception with the specified error code and message.

Parameters

error_code	The error code that indicates the error that occurred.
message	The error code that indicates the error that occurred.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

socket_exception() [4/13]

xtd::net::sockets::socket_exception::socket_exception ( xtd::net::sockets::socket_error socket_error, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class socket_exception with the specified socket error.

Parameters

socket_error	The sockect error that indicates the error that occurred.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

socket_exception() [5/13]

xtd::net::sockets::socket_exception::socket_exception ( xtd::net::sockets::socket_error socket_error, const std::optional< xtd::string > & message, const xtd::diagnostics::stack_frame & stack_frame = xtd::diagnostics::stack_frame::current() )

explicit

Create a new instance of class socket_exception with the specified socket error and message.

Parameters

socket_error	The socket error that indicates the error that occurred.
message	The error code that indicates the error that occurred.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

socket_exception() [6/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::error_code &	error,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
error	Error code associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame) and manually set the property xtd::exception::error_code - Will be removed in version 1.2.0.

socket_exception() [7/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const xtd::string &	help_link,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
help_link	Help link string associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame) and manually set the property xtd::exception::help_link - Will be removed in version 1.2.0.

socket_exception() [8/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::error_code &	error,
		const xtd::string &	help_link,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
error	Error code associate to the exception.
help_link	Help link string associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const xtd::diagnostics::stack_frame& stack_frame) and manually set the properties xtd::exception::error_code and xtd::exception::help_link - Will be removed in version 1.2.0.

socket_exception() [9/13]

xtd::net::sockets::socket_exception::socket_exception	(	const std::exception &	inner_exception,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

inner_exception	The exception that is the cause of the current exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Remarks

Message is set with the default message associate to the exception.

Deprecated

Use xtd::socket_exception (const xtd::string& message, const exception_t& inner_exception, const xtd::diagnostics::stack_frame& stack_frame) - Will be removed in version 1.2.0.

socket_exception() [10/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::exception &	inner_exception,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const exception_t& inner_exception, const xtd::diagnostics::stack_frame& stack_frame) - Will be removed in version 1.2.0.

socket_exception() [11/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::exception &	inner_exception,
		const std::error_code &	error,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
error	Error code associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const exception_t& inner_exception, const xtd::diagnostics::stack_frame& stack_frame) and manually set the property xtd::exception::error_code - Will be removed in version 1.2.0.

socket_exception() [12/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::exception &	inner_exception,
		const xtd::string &	help_link,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
help_link	Help link string associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const exception_t& inner_exception, const xtd::diagnostics::stack_frame& stack_frame) and manually set the property xtd::exception::help_link - Will be removed in version 1.2.0.

socket_exception() [13/13]

xtd::net::sockets::socket_exception::socket_exception	(	const xtd::string &	message,
		const std::exception &	inner_exception,
		const std::error_code &	error,
		const xtd::string &	help_link,
		const xtd::diagnostics::stack_frame &	stack_frame = xtd::diagnostics::stack_frame::current() )

Create a new instance of class socket_exception.

Parameters

message	Message string associate to the exception.
inner_exception	The exception that is the cause of the current exception.
error	Error code associate to the exception.
help_link	Help link string associate to the exception.
stack_frame	(optional) Contains current stack frame about member name, file path and line number in the file where the exception is occurred. Typically xtd::diagnostics::stack_frame::current().

Deprecated

Use xtd::socket_exception (const xtd::string& message, const exception_t& inner_exception, const xtd::diagnostics::stack_frame& stack_frame) and manually set the properties xtd::exception::error_code and xtd::exception::help_link - Will be removed in version 1.2.0.

Member Function Documentation

socket_error_code()

auto xtd::net::sockets::socket_exception::socket_error_code ( ) const -> xtd::int32

nodiscardnoexcept

Gets the error code that is associated with this exception.

Returns

An integer error code that is associated with this exception.

Remarks

The xtd::net::sockets::socket_exception::error property contains the error code that is associated with the error that caused the exception.

The parameterless constructor for xtd::net::sockets::socket_exception sets the xtd::net::sockets::socket_exception::socket_error_code property to the last operating system error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation.

socket_error()

virtual auto xtd::net::sockets::socket_exception::socket_error ( ) const -> xtd::net::sockets::socket_error

virtualnoexcept

Gets the socket error that is associated with this exception.

Returns

A socket error that is associated with this exception.

Remarks

The xtd::net::sockets::socket_exception::socket_error_code property contains the error code that is associated with the error that caused the exception.

The parameterless constructor for xtd::net::sockets::socket_exception sets the xtd::net::sockets::socket_exception::socket_error_code property to the last operating system error that occurred. For more information about socket error codes, see the Windows Sockets version 2 API error code documentation.

---

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

• xtd.core/include/xtd/net/sockets/socket_exception.hpp