xtd::net::ip_end_point Class Reference

Inheritance diagram for xtd::net::ip_end_point:

Definition

Represents a network endpoint as an IP address and a port number.

Definition

class core_export_ ip_end_point : public xtd::net::end_point, public xtd::iequatable<xtd::net::ip_end_point>;

Header

#include <xtd/net/ip_end_point>

Namespace

xtd::net

Library

xtd.core

Remarks

The xtd::net::ip_end_point class contains the host and local or remote port information needed by an application to connect to a service on a host. By combining the host's IP address and port number of a service, the ip_end_point class forms a connection point to a service.

Public Fields
static constexpr xtd::uint16	min_port
	Specifies the minimum value that can be assigned to the port property. The min_port value is set to 0x0000. This field is read-only.
static constexpr xtd::uint16	max_port
	Specifies the maximum value that can be assigned to the port property. The max_port value is set to 0xFFFF. This field is read-only.

Public Constructors
	ip_end_point (xtd::uint32 address, xtd::uint16 port)
	Initializes a new instance of the xtd::net::ip_end_point class.
	ip_end_point (const xtd::net::ip_address &address, xtd::uint16 port)
	Initializes a new instance of the xtd::net::ip_end_point class.

Public Properties
auto	address () const noexcept -> const xtd::net::ip_address &
	Gets the IP address of the endpoint.
auto	address (const xtd::net::ip_address &value) -> ip_end_point &
	Sets the IP address of the endpoint.
auto	port () const noexcept -> xtd::uint16
	Gets or sets the port number of the endpoint.
auto	port (xtd::uint16 value) -> ip_end_point &
	Sets the port number of the endpoint.

Public Methods
auto	create (const xtd::net::socket_address &socket_address) const -> xtd::uptr< end_point > override
	Creates an xtd::net::end_point instance from a xtd::net::socket_address instance.
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const ip_end_point &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::size override
	Serves as a hash function for a particular type.
auto	serialize () const -> xtd::net::socket_address override
	Serializes endpoint information into a socket_address instance.
auto	to_string () const noexcept -> xtd::string override
	Returns a string that represents the current object.

Additional Inherited Members
auto	address_family () const noexcept -> xtd::net::sockets::address_family
	Gets the address family to which the endpoint belongs.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
template<class object_a_t, class 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<class object_a_t, class 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.
	end_point (xtd::net::sockets::address_family address_family)
	Initializes a new instance of the xtd::net::end_point class.

Constructor & Destructor Documentation

ip_end_point() [1/2]

xtd::net::ip_end_point::ip_end_point	(	xtd::uint32	address,
		xtd::uint16	port )

Initializes a new instance of the xtd::net::ip_end_point class.

Parameters

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

ip_end_point() [2/2]

xtd::net::ip_end_point::ip_end_point	(	const xtd::net::ip_address &	address,
		xtd::uint16	port )

Initializes a new instance of the xtd::net::ip_end_point class.

Parameters

address	An xtd::net::ip_address.
port	The port number associated with the address, or 0 to specify any available port. port is in host order.

Member Function Documentation

address() [1/2]

auto xtd::net::ip_end_point::address ( ) const -> const xtd::net::ip_address &

nodiscardnoexcept

Gets the IP address of the endpoint.

Returns

An xtd::net::ip_address instance containing the IP address of the endpoint.

address() [2/2]

auto xtd::net::ip_end_point::address

(

const xtd::net::ip_address &

value

)

-> ip_end_point &

Sets the IP address of the endpoint.

Parameters

value

An ip_address instance containing the IP address of the endpoint.

Returns

The current instance.

port() [1/2]

auto xtd::net::ip_end_point::port ( ) const -> xtd::uint16

nodiscardnoexcept

Gets or sets the port number of the endpoint.

Parameters

value

An integer value in the range min_port to max_port indicating the port number of the endpoint.

port() [2/2]

auto xtd::net::ip_end_point::port

(

xtd::uint16

value

)

-> ip_end_point &

Sets the port number of the endpoint.

Parameters

value

An integer value in the range min_port to max_port indicating the port number of the endpoint.

create()

auto xtd::net::ip_end_point::create ( const xtd::net::socket_address & socket_address ) const -> xtd::uptr< end_point >

nodiscardoverridevirtual

Creates an xtd::net::end_point instance from a xtd::net::socket_address instance.

Parameters

socket_address

The socket address that serves as the endpoint for a connection.

Returns

A new end_point instance that is initialized from the specified xtd::net::socket_address instance.

Exceptions

xtd::not_supported_exception

Any attempt is made to access the method when the method is not overridden in a descendant class.

Reimplemented from xtd::net::end_point.

equals() [1/2]

auto xtd::net::ip_end_point::equals ( const object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

equals() [2/2]

auto xtd::net::ip_end_point::equals ( const ip_end_point & other ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

other

The object to compare with the current object.

Returns

true if the specified object is equal to the current object. otherwise, false.

Implements xtd::iequatable< xtd::net::ip_end_point >.

get_hash_code()

auto xtd::net::ip_end_point::get_hash_code ( ) const -> xtd::size

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns

A hash code for the current object.

Reimplemented from xtd::object.

serialize()

auto xtd::net::ip_end_point::serialize ( ) const -> xtd::net::socket_address

nodiscardoverridevirtual

Serializes endpoint information into a socket_address instance.

Returns

A new xtd::net::socket_address instance that contains the endpoint information.

Reimplemented from xtd::net::end_point.

to_string()

auto xtd::net::ip_end_point::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

Returns a string that represents the current object.

Returns

string A string that represents the current object.

Reimplemented from xtd::net::end_point.

Member Data Documentation

min_port

xtd::uint16 xtd::net::ip_end_point::min_port

staticconstexpr

Specifies the minimum value that can be assigned to the port property. The min_port value is set to 0x0000. This field is read-only.

max_port

xtd::uint16 xtd::net::ip_end_point::max_port

staticconstexpr

Specifies the maximum value that can be assigned to the port property. The max_port value is set to 0xFFFF. This field is read-only.

---

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

• xtd.core/include/xtd/net/ip_end_point.hpp