xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Static Public Attributes | Public Member Functions | List of all members
xtd::net::ip_end_point Class Reference

#include <ip_end_point.h>

Definition

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

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.
Namespace
xtd::net
Library
xtd.core

Static Public Attributes

static constexpr const uint16_t max_port = 0xFFFF
 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. More...
 
static constexpr const uint16_t min_port = 0x0000
 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. More...
 

Public Member Functions

 ip_end_point (uint32_t address, uint16_t port)
 Initializes a new instance of the xtd::net::ip_end_point class. More...
 
 ip_end_point (const xtd::net::ip_address &address, uint16_t port)
 Initializes a new instance of the xtd::net::ip_end_point class. More...
 
const xtd::net::ip_addressaddress () const noexcept
 Gets the IP address of the endpoint. More...
 
ip_end_pointaddress (const xtd::net::ip_address &value)
 Sets the IP address of the endpoint. More...
 
std::unique_ptr< end_pointcreate (const xtd::net::socket_address &socket_address) const override
 Creates an xtd::net::end_point instance from a xtd::net::socket_address instance. More...
 
uint16_t port () const noexcept
 Gets or sets the port number of the endpoint. More...
 
ip_end_pointport (uint16_t value)
 Sets the port number of the endpoint. More...
 
xtd::net::socket_address serialize () const override
 Serializes endpoint information into a socket_address instance. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represents the current object. More...
 
- 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. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 

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. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 
- 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. More...
 

Constructor & Destructor Documentation

◆ ip_end_point() [1/2]

xtd::net::ip_end_point::ip_end_point ( uint32_t  address,
uint16_t  port 
)

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

Parameters
addressThe IP address of the Internet host.
portThe 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_t  port 
)

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

Parameters
addressAn xtd::net::ip_address.
portThe 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
valueAn ip_address instance containing the IP address of the endpoint.
Returns
The current instance.

◆ create()

std::unique_ptr<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_addressThe 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_exceptionAny attempt is made to access the method when the method is not overridden in a descendant class.

Reimplemented from xtd::net::end_point.

◆ port() [1/2]

uint16_t xtd::net::ip_end_point::port ( ) const
noexcept

Gets or sets the port number of the endpoint.

Parameters
valueAn 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_t  value)

Sets the port number of the endpoint.

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

◆ 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::ustring 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

◆ max_port

constexpr const uint16_t xtd::net::ip_end_point::max_port = 0xFFFF
static

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.

◆ min_port

constexpr const uint16_t xtd::net::ip_end_point::min_port = 0x0000
static

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.


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