xtd::net::sockets::socket_information Class Reference

#include <socket_information.h>

Definition

Encapsulates the information that is necessary to duplicate a xtd::net::sockets::socket.

Namespace

xtd::net::sockets

Library

xtd.core

Remarks

xtd::net::sockets::socket::duplicate_and_close creates a xtd::net::sockets::socket_information instance for use with the xtd::net::sockets::socket::socket constructor.

Inherits xtd::object.

Public Member Functions
	socket_information ()=default
	Initializes a new instance of the xtd::net::sockets::socket_information class.
xtd::net::sockets::socket_information_options	options () const noexcept
	Gets the options for a xtd::net::sockets::socket.
socket_information &	options (xtd::net::sockets::socket_information_options value) noexcept
	Sets the options for a xtd::net::sockets::socket.
const std::vector< byte_t > &	protocol_information () const noexcept
	Gets the protocol information for a xtd::net::sockets::socket.
socket_information &	protocol_information (const std::vector< byte_t > &value) noexcept
	Sets the protocol information for a xtd::net::sockets::socket.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
Static Public Member Functions inherited from xtd::object
static bool	equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are considered equal.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

socket_information()

xtd::net::sockets::socket_information::socket_information ( )

default

Initializes a new instance of the xtd::net::sockets::socket_information class.

Member Function Documentation

options() [1/2]

xtd::net::sockets::socket_information_options xtd::net::sockets::socket_information::options ( ) const

noexcept

Gets the options for a xtd::net::sockets::socket.

Returns

A xtd::net::sockets::socket_information_options instance.

Remarks

Options include xtd::net::sockets::socket_information_options::connected, xtd::net::sockets::socket_information_options::listening, xtd::net::sockets::socket_information_options::non_blocking, and xtd::net::sockets::socket_information_options::use_only_overlapped_io.

options() [2/2]

socket_information & xtd::net::sockets::socket_information::options ( xtd::net::sockets::socket_information_options  value )

noexcept

Sets the options for a xtd::net::sockets::socket.

Parameters

value

A xtd::net::sockets::socket_information_options instance.

Returns

This current instance.

Remarks

Options include xtd::net::sockets::socket_information_options::connected, xtd::net::sockets::socket_information_options::listening, xtd::net::sockets::socket_information_options::non_blocking, and xtd::net::sockets::socket_information_options::use_only_overlapped_io.

protocol_information() [1/2]

const std::vector< byte_t > & xtd::net::sockets::socket_information::protocol_information ( ) const

noexcept

Gets the protocol information for a xtd::net::sockets::socket.

Returns

An array of byte.

protocol_information() [2/2]

socket_information & xtd::net::sockets::socket_information::protocol_information ( const std::vector< byte_t > &  value )

noexcept

Sets the protocol information for a xtd::net::sockets::socket.

Parameters

value

An array of byte.

Returns

This current instance.

---

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

• xtd.core/include/xtd/net/sockets/socket_information.h