xtd::net::dns_end_point Class Reference

Inheritance diagram for xtd::net::dns_end_point:

Definition

Represents a network endpoint as a host name or a string representation of an IP address and a port number.

Header

#include <xtd/net/dns_end_point>

Namespace

xtd::net

Library

xtd.core

Public Constructors
	dns_end_point (const xtd::string &host, uint16 port)
	Initializes a new instance of the xtd::net::dns_end_point class with the host name or string representation of an IP address and a port number.
	dns_end_point (const xtd::string &host, uint16 port, sockets::address_family address_family)
	Initializes a new instance of the xtd::net::dns_end_point class with the host name or string representation of an IP address, a port number, and an address family.

Public Properties
const xtd::string &	host () const noexcept
	Gets the host name or string representation of the Internet Protocol (IP) address of the host.
uint16	port () const noexcept
	Gets the port number of the endpoint.

Public Methods
xtd::string	to_string () const noexcept override
	Returns a string that represents the current object.

Additional Inherited Members
Public Member Functions inherited from xtd::net::end_point
sockets::address_family	address_family () const noexcept
	Gets the address family to which the endpoint belongs.
virtual xtd::uptr< end_point >	create (const socket_address &socket_address) const
	Creates an xtd::net::end_point instance from a socket_address instance.
virtual socket_address	serialize () const
	Serializes endpoint information into a socket_address instance.
string	to_string () const noexcept override
	Returns a string that represents the current object.
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.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.
Protected Member Functions inherited from xtd::net::end_point
	end_point (sockets::address_family address_family)
	Initializes a new instance of the xtd::net::end_point class.

Constructor & Destructor Documentation

dns_end_point() [1/2]

xtd::net::dns_end_point::dns_end_point	(	const xtd::string &	host,
		uint16	port
	)

Initializes a new instance of the xtd::net::dns_end_point class with the host name or string representation of an IP address and a port number.

Parameters

host	The host name or a string representation of the IP address.
port	The port number associated with the address, or 0 to specify any available port. port is in host order.

Exceptions

xtd::argument_exception

The host parameter contains an empty string.

Remarks

The xtd::dns_end_point::dns_end_point(const xtd::string& host, int32 port) constructor can be used to initialize a xtd::net::dns_end_point class using either a host name or a string that represents an IP address and a port. This constructor sets the xtd::net::sockets::address_family property to xtd::net::sockets::address_family::unknown.

When using this constructor with a host name rather than a string representation of an IP address, the address family of the dns_end_point will remain Unknown even after use. The xtd::net::sockets::address_family property of any Socket that is created by calls to the ConnectAsync method will be the address family of the first address to which a connection can be successfully established (not necessarily the first address to be resolved).

dns_end_point() [2/2]

xtd::net::dns_end_point::dns_end_point	(	const xtd::string &	host,
		uint16	port,
		sockets::address_family	address_family
	)

Initializes a new instance of the xtd::net::dns_end_point class with the host name or string representation of an IP address, a port number, and an address family.

Parameters

host	The host name or a string representation of the IP address.
port	The port number associated with the address, or 0 to specify any available port. port is in host order.
address_family	One of the xtd::net::sockets::address_family values.

Exceptions

xtd::argument_exception

The host parameter contains an empty string.

Remarks

The xtd::dns_end_point::dns_end_point(const xtd::string& host, int32 port, xtd::net::sockets::address_family) constructor can be used to initialize a dns_end_point class using either a host name or a string that represents an IP address, a port, and an address family.

When using the constructor with a host name rather than a string representation of an IP address, the address family restricts DNS resolution to prefer addresses of the specified address family value. When using the constructor with the address family specified as Unknown, the address family of the dns_end_point will remain Unknown even after use. The xtd::net::sockets::address_family property of any Socket that is created by calls to the ConnectAsync method will be the address family of the first address to which a connection can be successfully established (not necessarily the first address to be resolved).

Member Function Documentation

host()

const xtd::string & xtd::net::dns_end_point::host ( ) const

noexcept

Gets the host name or string representation of the Internet Protocol (IP) address of the host.

Returns

The host name or a string representation of the IP address.

port()

uint16 xtd::net::dns_end_point::port ( ) const

noexcept

Gets the port number of the endpoint.

Returns

An integer value in the range xtd::net::ip_end_point::min_port to xtd::net::ip_end_point::max_port indicating the port number of the endpoint.

to_string()

xtd::string xtd::net::dns_end_point::to_string ( ) const

overridevirtualnoexcept

Returns a string that represents the current object.

Returns

string A string that represents the current object.

Reimplemented from xtd::object.

---

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

• xtd.core/include/xtd/net/dns_end_point.h