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

Inheritance diagram for xtd::net::sockets::socket_information:

Definition

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

class core_export_ socket_information : public xtd::object

Inheritance

xtd::object → xtd::net::sockets::socket_information

Header

#include <xtd/net/sockets/socket_information>

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.

Public Constructors
	socket_information ()=default
	Initializes a new instance of the xtd::net::sockets::socket_information class.

Public Properties
auto	options () const noexcept -> xtd::net::sockets::socket_information_options
	Gets the options for a xtd::net::sockets::socket.
auto	options (xtd::net::sockets::socket_information_options value) noexcept -> socket_information &
	Sets the options for a xtd::net::sockets::socket.
auto	protocol_information () const noexcept -> const xtd::array< xtd::byte > &
	Gets the protocol information for a xtd::net::sockets::socket.
auto	protocol_information (const xtd::array< xtd::byte > &value) noexcept -> socket_information &
	Sets the protocol information for a xtd::net::sockets::socket.

Additional Inherited Members
	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.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
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_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]

auto xtd::net::sockets::socket_information::options ( ) const -> xtd::net::sockets::socket_information_options

nodiscardnoexcept

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]

auto xtd::net::sockets::socket_information::options ( xtd::net::sockets::socket_information_options value ) -> socket_information &

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]

auto xtd::net::sockets::socket_information::protocol_information ( ) const -> const xtd::array< xtd::byte > &

nodiscardnoexcept

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

Returns

An array of byte.

protocol_information() [2/2]

auto xtd::net::sockets::socket_information::protocol_information ( const xtd::array< xtd::byte > & value ) -> socket_information &

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.hpp