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>;

xtd::iequatable
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition iequatable.hpp:22

xtd::net::end_point
Identifies a network address. This is an abstract class.
Definition end_point.hpp:27

xtd::net::ip_end_point
Represents a network endpoint as an IP address and a port number.
Definition ip_end_point.hpp:28

core_export_
#define core_export_
Define shared library export.
Definition core_export.hpp:13

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.

Examples: network_stream.cpp, socket_tcp_ip_v4.cpp, socket_tcp_ip_v4_without_thread.cpp, socket_tcp_ip_v6.cpp, socket_udp_ip_v4.cpp, socket_udp_ip_v6.cpp, tcp_client_ip_v6.cpp, udp_client_ip_v4.cpp, and udp_client_ip_v6.cpp.

Public Fields
static constexpr 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 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 (uint32 address, uint16 port)
	Initializes a new instance of the xtd::net::ip_end_point class.

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

Public Properties
const xtd::net::ip_address &	address () const noexcept
	Gets the IP address of the endpoint.

ip_end_point &	address (const xtd::net::ip_address &value)
	Sets the IP address of the endpoint.

uint16	port () const noexcept
	Gets or sets the port number of the endpoint.

ip_end_point &	port (uint16 value)
	Sets the port number of the endpoint.

Public Methods
xtd::uptr< end_point >	create (const xtd::net::socket_address &socket_address) const override
	Creates an xtd::net::end_point instance from a xtd::net::socket_address instance.

bool	equals (const object &obj) const noexcept override
	Determines whether the specified object is equal to the current object.

bool	equals (const ip_end_point &other) const noexcept override
	Determines whether the specified object is equal to the current object.

xtd::size	get_hash_code () const noexcept override
	Serves as a hash function for a particular type.

xtd::net::socket_address	serialize () const override
	Serializes endpoint information into a socket_address instance.

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.

Public Member Functions inherited from xtd::object
	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::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.

Public Member Functions inherited from xtd::iequatable< xtd::net::ip_end_point >
Static Public Member Functions inherited from xtd::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.

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

◆ ip_end_point() [1/2]

xtd::net::ip_end_point::ip_end_point	(	uint32	address,
		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,
		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]

const xtd::net::ip_address & xtd::net::ip_end_point::address ( ) const

noexcept

Gets the IP address of the endpoint.

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

◆ address() [2/2]

ip_end_point & xtd::net::ip_end_point::address ( const xtd::net::ip_address & value )

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]

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

noexcept

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]

ip_end_point & xtd::net::ip_end_point::port ( uint16 value )

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()

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

overridevirtual

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]

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

overridevirtualnoexcept

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]

bool xtd::net::ip_end_point::equals ( const ip_end_point & other ) const

overridevirtualnoexcept

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()

xtd::size xtd::net::ip_end_point::get_hash_code ( ) const

overridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

◆ serialize()

xtd::net::socket_address xtd::net::ip_end_point::serialize ( ) const

overridevirtual

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()

xtd::string xtd::net::ip_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::net::end_point.

Member Data Documentation

◆ min_port

constexpr 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

constexpr 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

Definition

Public Fields

Public Constructors

Public Properties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ ip_end_point() [1/2]

◆ ip_end_point() [2/2]

Member Function Documentation

◆ address() [1/2]

◆ address() [2/2]

◆ port() [1/2]

◆ port() [2/2]

◆ create()

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ serialize()

◆ to_string()

Member Data Documentation

◆ min_port

◆ max_port