xtd::net::ip_address Class Reference

Inheritance diagram for xtd::net::ip_address:

Definition

Provides an Internet Protocol (IP) address.

Definition

class core_export_ ip_address : public xtd::object, public xtd::iequatable<xtd::net::ip_address>

Header

#include <xtd/net/ip_address>

Namespace

xtd::net

Library

xtd.core

Examples

The following code example shows how to query a server to obtain the family addresses and the IP addresses it supports.

#include <xtd/xtd>
#include <regex>
 
class test_ip_address {
public:
  static auto main(const argument_collection& args) {
    auto server = text::string_builder {};
    
    // Define a regular expression to parse user's input.
    // This is a security check. It allows only
    // alphanumeric input string between 2 to 40 character long.
    auto rex = std::regex {R"(^[a-zA-Z]\w{1,39}$)"};
    
    if (args.length() < 1) {
      // If no server name is passed as an argument to this program, use the current
      // server name as default.
      server = net::dns::get_host_name();
      console::write_line("Using current host: {}", server);
    } else {
      server = args[0];
      if (!regex_match(server.chars(), rex)) {
        console::write_line("Input string format not allowed.");
        return;
      }
    }
    
    // Get the list of the addresses associated with the requested server.
    ip_addresses(server.to_string());
    
    // Get additional address information.
    ip_address_additional_info();
  }
  
private:
  static void ip_addresses(const string& server) {
    try {
      // Get server related information.
      auto heserver = net::dns::get_host_entry(server);
      
      // Loop on the AddressList
      for (auto cur_add : heserver.address_list()) {
        // Display the type of address family supported by the server. If the
        // server is IPv6-enabled this value is: InterNetworkV6. If the server
        // is also IPv4-enabled there will be an additional value of InterNetwork.
        console::write_line("address_family: {}", cur_add.address_family());
        
        // Display the ScopeId property in case of IPV6 addresses.
        if (cur_add.address_family() == net::sockets::address_family::inter_network_v6)
          console::write_line("scope id: {}", cur_add.scope_id());
          
          
        // Display the server IP address in the standard format. In
        // IPv4 the format will be dotted-quad notation, in IPv6 it will be
        // in in colon-hexadecimal notation.
        console::write_line("address: {}", cur_add);
        
        // Display the server IP address in byte format.
        console::write("address_bytes: ");
        
        auto bytes = cur_add.get_address_bytes();
        for (size_t i = 0; i < bytes.length(); i++)
          console::write(bytes[i]);
        console::write_line("\r\n");
      }
    } catch (const system_exception& e) {
      console::write_line("[do_resolve] exception: {}", e);
    }
  }
  
  // This IPAddressAdditionalInfo displays additional server address information.
  static void ip_address_additional_info() {
    try {
      // Display the flags that show if the server supports IPv4 or IPv6
      // address schemas.
      console::write_line("\r\nos_supports_ip_v4: {}", net::sockets::socket::os_supports_ip_v4());
      console::write_line("os_supports_ip_v6: {}", net::sockets::socket::os_supports_ip_v6());
      
      if (net::sockets::socket::os_supports_ip_v6()) {
        // Display the server Any address. This IP address indicates that the server
        // should listen for client activity on all network interfaces.
        console::write_line("\r\nip_v6_any: {}", net::ip_address::ip_v6_any);
        
        // Display the server loopback address.
        console::write_line("ip_v6_loopback: {}", net::ip_address::ip_v6_loopback);
        
        // Used during autoconfiguration first phase.
        console::write_line("ip_v6_none: {}", net::ip_address::ip_v6_none);
        
        console::write_line("is_loopback(ip_v6_loopback): {}", net::ip_address::is_loopback(net::ip_address::ip_v6_loopback));
      }
      console::write_line("is_loopback(loopback):{}", net::ip_address::is_loopback(net::ip_address::loopback));
    } catch (const system_exception& e) {
      console::write_line("[ip_addresses] exception: {}", e);
    }
  }
};
 
startup_(test_ip_address::main);
 
// This code produces the following output if no args:
//
// Using current host: !---OMITTED---!.local
// address_family: inter_network
// address: 192.168.1.37
// address_bytes: 192168137
//
//
// os_supports_ip_v4: true
// os_supports_ip_v6: true
//
// ip_v6_any: ::
// ip_v6_loopback: ::1
// ip_v6_none: ::
// is_loopback(ip_v6_loopback): true
// is_loopback(loopback):true

Remarks

The xtd::net::ip_address class contains the address of a computer on an IP network.

Public Fields
static const ip_address	any
	Provides an IP address that indicates that the server must listen for client activity on all network interfaces. This field is constant.
static const ip_address	broadcast
	Provides the IP broadcast address. This field is constant.
static const ip_address	ip_v6_any
	The Socket::Bind method uses the cIPv6Any field to indicate that a Socket must listen for client activity on all network interfaces. This field is constant.
static const ip_address	ip_v6_loopback
	Provides the IP loopback address. This field is constant.
static const ip_address	ip_v6_none
	Provides an IP address that indicates that no network interface should be used. This field is constant.
static const ip_address	loopback
	Provides the IP loopback address. This field is constant.
static const ip_address	none
	Provides an IP address that indicates that no network interface should be used. This field is constant.

Public Constructors
	ip_address ()
	Initializes a new instance of the xtd::net::ip_address.
	ip_address (xtd::uint32 address)
	Initializes a new instance of the xtd::net::ip_address class with the address specified as an uint32.
	ip_address (const xtd::array< xtd::byte > &address)
	Initializes a new instance of the xtd::net::ip_address class with the address specified as a byte array.
	ip_address (const xtd::array< xtd::byte > &address, xtd::uint32 scope_id)
	Initializes a new instance of the xtd::net::ip_address class with the address specified as a byte array.
	ip_address (xtd::byte quad_part_address1, xtd::byte quad_part_address2, xtd::byte quad_part_address3, xtd::byte quad_part_address4)
	Initializes a new instance of the xtd::net::ip_address class with the address specified as a four Bytes.

Public Properties
auto	address_family () const noexcept -> xtd::net::sockets::address_family
	Gets the address family of the IP address.
auto	is_ip_v4_mapped_to_ip_v6 () const noexcept -> bool
	Gets whether the IP address is an IPv4-mapped IPv6 address.
auto	is_ip_v6_link_local () const noexcept -> bool
	Gets whether the address is an IPv6 link local address.
auto	is_ip_v6_multicast () const noexcept -> bool
	Gets whether the address is an IPv6 multicast global address.
auto	is_ip_v6_site_local () const noexcept -> bool
	Gets whether the address is an IPv6 site local address.
auto	is_ip_v6_teredo () const noexcept -> bool
	Gets whether the address is an IPv6 Teredo address.
auto	scope_id () const -> xtd::uint32
	Gets the IPv6 address scope identifier.
auto	scope_id (xtd::uint32 value) -> ip_address &
	Sets the IPv6 address scope identifier.

Public Methods
auto	equals (const object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const ip_address &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_address_bytes () const -> xtd::array< xtd::byte >
	Provides a copy of the IPAddress as an array of bytes.
auto	get_hash_code () const noexcept -> xtd::size override
	Serves as a hash function for a particular type.
auto	map_to_ip_v4 () const noexcept -> ip_address
	Maps the xtd::net::ip_address object to an IPv4 address.
auto	map_to_ip_v6 () const noexcept -> ip_address
	Maps the xtd::net::ip_address object to an IPv6 address.
auto	to_string () const noexcept -> xtd::string override
	Converts an Internet address to its standard notation.

Public Static Methods
static auto	host_to_network_order (double host) -> double
	Converts a Double value from host byte order to network byte order.
static auto	host_to_network_order (xtd::int16 host) -> xtd::int16
	Converts a short value from host byte order to network byte order.
static auto	host_to_network_order (xtd::int32 host) -> xtd::int32
	Converts a integer value from host byte order to network byte order.
static auto	host_to_network_order (xtd::int64 host) -> xtd::int64
	Converts a long value from host byte order to network byte order.
static auto	host_to_network_order (float host) -> float
	Converts a Single value from host byte order to network byte order.
static auto	host_to_network_order (xtd::uint16 host) -> xtd::uint16
	Converts a short value from host byte order to network byte order.
static auto	host_to_network_order (xtd::uint32 host) -> xtd::uint32
	Converts a integer value from host byte order to network byte order.
static auto	host_to_network_order (xtd::uint64 host) -> xtd::uint64
	Converts a long value from host byte order to network byte order.
static auto	is_loopback (const ip_address &address) -> bool
	Indicates whether the specified IP address is the loopback address.
static auto	network_to_host_order (double network) -> double
	Converts a Double value from network byte order to host byte order.
static auto	network_to_host_order (xtd::int16 network) -> xtd::int16
	Converts a short value from network byte order to host byte order.
static auto	network_to_host_order (xtd::int32 host) -> xtd::int32
	Converts a integer value from network byte order to host byte order.
static auto	network_to_host_order (xtd::int64 network) -> xtd::int64
	Converts a long value from network byte order to host byte order.
static auto	network_to_host_order (float network) -> float
	Converts a Single value from network byte order to host byte order.
static auto	network_to_host_order (xtd::uint16 network) -> xtd::uint16
	Converts a short value from network byte order to host byte order.
static auto	network_to_host_order (xtd::uint32 network) -> xtd::uint32
	Converts a integer value from network byte order to host byte order.
static auto	network_to_host_order (xtd::uint64 network) -> xtd::uint64
	Converts a long value from network byte order to host byte order.
static auto	parse (const xtd::string &str) -> ip_address
	Converts an IP address string to an xtd::net::ip_address instance.
static auto	try_parse (const xtd::string &str, ip_address &address) noexcept -> bool
	Determines whether a string is a valid IP address.

Additional Inherited Members
	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.

Constructor & Destructor Documentation

ip_address() [1/5]

xtd::net::ip_address::ip_address

(

)

Initializes a new instance of the xtd::net::ip_address.

Remarks

ip_address is initialized by default value xtd::net::ip_address::none.

ip_address() [2/5]

xtd::net::ip_address::ip_address ( xtd::uint32 address )

explicit

Initializes a new instance of the xtd::net::ip_address class with the address specified as an uint32.

Parameters

address

The value of the IP address. For example, the value 0x2414188F in big-endian format would be the IP address "143.24.20.36".

ip_address() [3/5]

xtd::net::ip_address::ip_address ( const xtd::array< xtd::byte > & address )

explicit

Initializes a new instance of the xtd::net::ip_address class with the address specified as a byte array.

Parameters

address

The byte array value of the IP address.

ip_address() [4/5]

xtd::net::ip_address::ip_address	(	const xtd::array< xtd::byte > &	address,
		xtd::uint32	scope_id )

Initializes a new instance of the xtd::net::ip_address class with the address specified as a byte array.

Parameters

address	The byte array value of the IP address.
scope_id	The long value of the scope identifier.

Exceptions

xtd::argument_out_of_range_exception

scope_id < 0 or scope_id > 0x00000000FFFFFFFF.

Remarks

This constructor instantiates an IPv6 address. The scope_dd identifies a network interface in the case of a link-local address.

The scope is valid only for link-local and site-local addresses.

The byte array is assumed to be in network byte order with the most significant byte first in index position 0.

ip_address() [5/5]

xtd::net::ip_address::ip_address	(	xtd::byte	quad_part_address1,
		xtd::byte	quad_part_address2,
		xtd::byte	quad_part_address3,
		xtd::byte	quad_part_address4 )

Initializes a new instance of the xtd::net::ip_address class with the address specified as a four Bytes.

Parameters

quad_part_address1	The first quad part of the IP address.
quad_part_address2	The second quad part of the IP address.
quad_part_address3	The third quad part of the IP address.
quad_part_address4	The fourth quad part of the IP address.

Member Function Documentation

address_family()

auto xtd::net::ip_address::address_family ( ) const -> xtd::net::sockets::address_family

nodiscardnoexcept

Gets the address family of the IP address.

Returns

Returns sockets::address_family::inter_network for IPv4 or sockets::address_family::inter_network_v6 for IPv6.

is_ip_v4_mapped_to_ip_v6()

auto xtd::net::ip_address::is_ip_v4_mapped_to_ip_v6 ( ) const -> bool

nodiscardnoexcept

Gets whether the IP address is an IPv4-mapped IPv6 address.

Returns

true if the IP address is an IPv4-mapped IPv6 address; otherwise, false.

Remarks

Dual-stack sockets always require IPv6 addresses. The ability to interact with an IPv4 address requires the use of the IPv4-mapped IPv6 address format. Any IPv4 addresses must be represented in the IPv4-mapped IPv6 address format which enables an IPv6 only application to communicate with an IPv4 node. The IPv4-mapped IPv6 address format allows the IPv4 address of an IPv4 node to be represented as an IPv6 address. The IPv4 address is encoded into the low-order 32 bits of the IPv6 address, and the high-order 96 bits hold the fixed prefix 0:0:0:0:0:FFFF. The IPv4-mapped IPv6 address format is specified in RFC 4291. For more information, see www.ietf.org/rfc/rfc4291.txt.

is_ip_v6_link_local()

auto xtd::net::ip_address::is_ip_v6_link_local ( ) const -> bool

nodiscardnoexcept

Gets whether the address is an IPv6 link local address.

Returns

bool true if the IP address is an IPv6 link local address; otherwise, false.

is_ip_v6_multicast()

auto xtd::net::ip_address::is_ip_v6_multicast ( ) const -> bool

nodiscardnoexcept

Gets whether the address is an IPv6 multicast global address.

Returns

bool true if the IP address is an IPv6 multicast global address; otherwise, false.

is_ip_v6_site_local()

auto xtd::net::ip_address::is_ip_v6_site_local ( ) const -> bool

nodiscardnoexcept

Gets whether the address is an IPv6 site local address.

Returns

bool true if the IP address is an IPv6 site local address; otherwise, false.

is_ip_v6_teredo()

auto xtd::net::ip_address::is_ip_v6_teredo ( ) const -> bool

nodiscardnoexcept

Gets whether the address is an IPv6 Teredo address.

Returns

true if the IP address is an IPv6 Teredo address; otherwise, false.

Remarks

A Teredo address is an IPv6 address with the prefix of 2001::/32. Teredo addresses can be returned through normal DNS name resolution or enumerated as an IPv6 address assigned to a local interface.

scope_id() [1/2]

auto xtd::net::ip_address::scope_id ( ) const -> xtd::uint32

nodiscard

Gets the IPv6 address scope identifier.

Returns

A uint32 that specifies the scope of the address.

Exceptions

xtd::net::sockets::socket_exception

if address_family = sockets::address_family::inter_network

scope_id() [2/2]

auto xtd::net::ip_address::scope_id

(

xtd::uint32

value

)

-> ip_address &

Sets the IPv6 address scope identifier.

Parameters

value

A uint32 that specifies the scope of the address.

Exceptions

xtd::net::sockets::socket_exception

if address_family = sockets::address_family::inter_network

equals() [1/2]

auto xtd::net::ip_address::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_address::equals ( const ip_address & 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_address >.

get_address_bytes()

auto xtd::net::ip_address::get_address_bytes ( ) const -> xtd::array< xtd::byte >

nodiscard

Provides a copy of the IPAddress as an array of bytes.

Returns

A byte array.

get_hash_code()

auto xtd::net::ip_address::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.

map_to_ip_v4()

auto xtd::net::ip_address::map_to_ip_v4 ( ) const -> ip_address

nodiscardnoexcept

Maps the xtd::net::ip_address object to an IPv4 address.

Returns

An IPv4 address.

Remarks

Dual-stack sockets always require IPv6 addresses. The ability to interact with an IPv4 address requires the use of the IPv4-mapped IPv6 address format. Any IPv4 addresses must be represented in the IPv4-mapped IPv6 address format which enables an IPv6 only application to communicate with an IPv4 node. The IPv4-mapped IPv6 address format allows the IPv4 address of an IPv4 node to be represented as an IPv6 address. The IPv4 address is encoded into the low-order 32 bits of the IPv6 address, and the high-order 96 bits hold the fixed prefix 0:0:0:0:0:FFFF. The IPv4-mapped IPv6 address format is specified in RFC 4291. For more information, see www.ietf.org/rfc/rfc4291.txt.

map_to_ip_v6()

auto xtd::net::ip_address::map_to_ip_v6 ( ) const -> ip_address

nodiscardnoexcept

Maps the xtd::net::ip_address object to an IPv6 address.

Returns

An IPv6 address.

Remarks

Dual-stack sockets always require IPv6 addresses. The ability to interact with an IPv4 address requires the use of the IPv4-mapped IPv6 address format. Any IPv4 addresses must be represented in the IPv4-mapped IPv6 address format which enables an IPv6 only application to communicate with an IPv4 node. The IPv4-mapped IPv6 address format allows the IPv4 address of an IPv4 node to be represented as an IPv6 address. The IPv4 address is encoded into the low-order 32 bits of the IPv6 address, and the high-order 96 bits hold the fixed prefix 0:0:0:0:0:FFFF. The IPv4-mapped IPv6 address format is specified in RFC 4291. For more information, see www.ietf.org/rfc/rfc4291.txt.

to_string()

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

nodiscardoverridevirtualnoexcept

Converts an Internet address to its standard notation.

Returns

A string that contains the IP address in either IPv4 dotted-quad or in IPv6 colon-hexadecimal notation.

Reimplemented from xtd::object.

host_to_network_order() [1/8]

static auto xtd::net::ip_address::host_to_network_order ( double host ) -> double

staticnodiscard

Converts a Double value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A Double value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [2/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::int16 host ) -> xtd::int16

staticnodiscard

Converts a short value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A short value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [3/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::int32 host ) -> xtd::int32

staticnodiscard

Converts a integer value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A integer value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [4/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::int64 host ) -> xtd::int64

staticnodiscard

Converts a long value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A long value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [5/8]

static auto xtd::net::ip_address::host_to_network_order ( float host ) -> float

staticnodiscard

Converts a Single value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A Single value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [6/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::uint16 host ) -> xtd::uint16

staticnodiscard

Converts a short value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A unsigned short value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [7/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::uint32 host ) -> xtd::uint32

staticnodiscard

Converts a integer value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A unsigned integer value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

host_to_network_order() [8/8]

static auto xtd::net::ip_address::host_to_network_order ( xtd::uint64 host ) -> xtd::uint64

staticnodiscard

Converts a long value from host byte order to network byte order.

Parameters

host	The number to convert, expressed in host byte order.

Returns

A unsigned long value, expressed in network byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values.Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::host_to_network_order method converts multibyte integer values that are stored on the host system from the byte order used by the host to the byte order used by the network.

is_loopback()

static auto xtd::net::ip_address::is_loopback ( const ip_address & address ) -> bool

staticnodiscard

Indicates whether the specified IP address is the loopback address.

Parameters

address

An IP address.

Returns

bool true if address is the loopback address; otherwise, false.

network_to_host_order() [1/8]

static auto xtd::net::ip_address::network_to_host_order ( double network ) -> double

staticnodiscard

Converts a Double value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A Double value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [2/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::int16 network ) -> xtd::int16

staticnodiscard

Converts a short value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A short value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [3/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::int32 host ) -> xtd::int32

staticnodiscard

Converts a integer value from network byte order to host byte order.

Parameters

host	The number to convert, expressed in network byte order.

Returns

A integer value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [4/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::int64 network ) -> xtd::int64

staticnodiscard

Converts a long value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A long value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [5/8]

static auto xtd::net::ip_address::network_to_host_order ( float network ) -> float

staticnodiscard

Converts a Single value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in host byte order.

Returns

A Single value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [6/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::uint16 network ) -> xtd::uint16

staticnodiscard

Converts a short value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A unsigned short value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [7/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::uint32 network ) -> xtd::uint32

staticnodiscard

Converts a integer value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A unsigned integer value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

network_to_host_order() [8/8]

static auto xtd::net::ip_address::network_to_host_order ( xtd::uint64 network ) -> xtd::uint64

staticnodiscard

Converts a long value from network byte order to host byte order.

Parameters

network

The number to convert, expressed in network byte order.

Returns

A unsigned long value, expressed in host byte order.

Remarks

Different computers use different conventions for ordering the bytes within multibyte integer values. Some computers put the most significant byte first (known as big-endian order) and others put the least-significant byte first (known as little-endian order). To work with computers that use different byte ordering, all integer values that are sent over the network are sent in network byte order which has the most significant byte first.

The xtd::net::sockets::socket::network_to_host_order method converts multibyte integer values that are stored on the host system from the byte order used by the network to the byte order used by the host.

parse()

static auto xtd::net::ip_address::parse ( const xtd::string & str ) -> ip_address

staticnodiscard

Converts an IP address string to an xtd::net::ip_address instance.

Parameters

str	A string that contains an IP address in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6.

Returns

An xtd::net::ip_address instance.

Exceptions

xtd::format_exception

str is not a valid IP address.

Remarks

The static xtd::net::ip_address::parse method creates an xtd::net::ip_address instance from an IP address expressed in dotted-quad notation for IPv4 and in colon-hexadecimal notation for IPv6.

The number of parts (each part is separated by a period) in str determines how the IP address is constructed. A one part address is stored directly in the network address. A two part address, convenient for specifying a class A address, puts the leading part in the first byte and the trailing part in the right-most three bytes of the network address. A three part address, convenient for specifying a class B address, puts the first part in the first byte, the second part in the second byte, and the final part in the right-most two bytes of the network address.

try_parse()

static auto xtd::net::ip_address::try_parse ( const xtd::string & str, ip_address & address ) -> bool

staticnoexcept

Determines whether a string is a valid IP address.

Parameters

str	The string to validate.
address	The xtd::net::ip_address version of the string.

Returns

bool true if str is a valid IP address; otherwise, false.

Member Data Documentation

any

const ip_address xtd::net::ip_address::any

static

Provides an IP address that indicates that the server must listen for client activity on all network interfaces. This field is constant.

Remarks

The xtd::net::ip_address::any field is equivalent to 0.0.0.0 in dotted-quad notation

broadcast

const ip_address xtd::net::ip_address::broadcast

static

Provides the IP broadcast address. This field is constant.

Remarks

The xtd::net::ip_address::broadcast field is equivalent to 255.255.255.255 in dotted-quad notation.

ip_v6_any

const ip_address xtd::net::ip_address::ip_v6_any

static

The Socket::Bind method uses the cIPv6Any field to indicate that a Socket must listen for client activity on all network interfaces. This field is constant.

Remarks

The xtd::net::ip_address::ip_v6_any field is equivalent to 0:0:0:0:0:0:0:0 in colon-hexadecimal notation, or to :: in compact notation.

ip_v6_loopback

const ip_address xtd::net::ip_address::ip_v6_loopback

static

Provides the IP loopback address. This field is constant.

Remarks

The xtd::net::ip_address::ip_v6_loopback field is equivalent to 0:0:0:0:0:0:0:1 in colon-hexadecimal notation, or to ::1 in compact notation.

ip_v6_none

const ip_address xtd::net::ip_address::ip_v6_none

static

Provides an IP address that indicates that no network interface should be used. This field is constant.

Remarks

The Socket::Bind method uses the cIPv6None field to indicate that a Socket must not listen for client activity.

The xtd::net::ip_address::ip_v6_none field is equivalent to 0:0:0:0:0:0:0:0 in colon-hexadecimal notation, or to ::0 in compact notation.

loopback

const ip_address xtd::net::ip_address::loopback

static

Provides the IP loopback address. This field is constant.

Remarks

The xtd::net::ip_address::loopback field is equivalent to 127.0.0.1 in dotted-quad notation.

none

const ip_address xtd::net::ip_address::none

static

Provides an IP address that indicates that no network interface should be used. This field is constant.

Remarks

The xtd::net::ip_address::none field is equivalent to 255.255.255.255 in dotted-quad notation.

---

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

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