reference_guides/latest/net_2ip__address_8hpp_source.html

#pragma once

#include "sockets/address_family.hpp"

#include "../array.hpp"

#include "../core_export.hpp"

#include "../iequatable.hpp"

#include "../object.hpp"

#include "../types.hpp"

#include "../string.hpp"

#include <vector>


namespace xtd {

  namespace net {

    namespace sockets {

      class socket;

    }


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

    public:


      static const ip_address any;

      static const ip_address broadcast;

      static const ip_address ip_v6_any;

      static const ip_address ip_v6_loopback;

      static const ip_address ip_v6_none;

      static const ip_address loopback;

      static const ip_address none;


      ip_address();

      explicit ip_address(xtd::uint32 address);

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

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

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


      ip_address(ip_address&& ip_address) = default;

      ip_address(const ip_address& ip_address) = default;

      auto operator =(ip_address&&) -> ip_address& = default;

      auto operator =(const ip_address&) -> ip_address& = default;


      [[nodiscard]] auto address_family() const noexcept -> xtd::net::sockets::address_family;


      [[nodiscard]] auto is_ip_v4_mapped_to_ip_v6() const noexcept -> bool;


      [[nodiscard]] auto is_ip_v6_link_local() const noexcept -> bool;


      [[nodiscard]] auto is_ip_v6_multicast() const noexcept -> bool;


      [[nodiscard]] auto is_ip_v6_site_local() const noexcept -> bool;


      [[nodiscard]] auto is_ip_v6_teredo() const noexcept -> bool;


      [[nodiscard]] auto scope_id() const -> xtd::uint32;

      auto scope_id(xtd::uint32 value) -> ip_address&;


      [[nodiscard]] auto equals(const object& obj) const noexcept -> bool override;

      [[nodiscard]] auto equals(const ip_address& other) const noexcept -> bool override;


      [[nodiscard]] auto get_address_bytes() const -> xtd::array<xtd::byte>;


      [[nodiscard]] auto get_hash_code() const noexcept -> xtd::size override;


      [[nodiscard]] auto map_to_ip_v4() const noexcept -> ip_address;


      [[nodiscard]] auto map_to_ip_v6() const noexcept -> ip_address;


      [[nodiscard]] auto to_string() const noexcept -> xtd::string override;


      [[nodiscard]] static auto host_to_network_order(double host) -> double;


      [[nodiscard]] static auto host_to_network_order(xtd::int16 host) -> xtd::int16;


      [[nodiscard]] static auto host_to_network_order(xtd::int32 host) -> xtd::int32;


      [[nodiscard]] static auto host_to_network_order(xtd::int64 host) -> xtd::int64;


      [[nodiscard]] static auto host_to_network_order(float host) -> float;


      [[nodiscard]] static auto host_to_network_order(xtd::uint16 host) -> xtd::uint16;


      [[nodiscard]] static auto host_to_network_order(xtd::uint32 host) -> xtd::uint32;


      [[nodiscard]] static auto host_to_network_order(xtd::uint64 host) -> xtd::uint64;


      [[nodiscard]] static auto is_loopback(const ip_address& address) -> bool;


      [[nodiscard]] static auto network_to_host_order(double network) -> double;


      [[nodiscard]] static auto network_to_host_order(xtd::int16 network) -> xtd::int16;


      [[nodiscard]] static auto network_to_host_order(xtd::int32 host) -> xtd::int32;


      [[nodiscard]] static auto network_to_host_order(xtd::int64 network) -> xtd::int64;


      [[nodiscard]] static auto network_to_host_order(float network) -> float;


      [[nodiscard]] static auto network_to_host_order(xtd::uint16 network) -> xtd::uint16;


      [[nodiscard]] static auto network_to_host_order(xtd::uint32 network) -> xtd::uint32;


      [[nodiscard]] static auto network_to_host_order(xtd::uint64 network) -> xtd::uint64;


      [[nodiscard]] static auto parse(const xtd::string& str) -> ip_address;


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


    private:

      friend xtd::net::sockets::socket;

      static constexpr xtd::size number_of_numbers_ = 8;

      ip_address(const xtd::array<xtd::uint16>& numbers, xtd::uint32 scope_id);

      xtd::uint32 address_or_scope_id_ = 0;

      xtd::array<xtd::uint16> numbers_ = xtd::array<xtd::uint16>(number_of_numbers_);

      sockets::address_family address_family_ = sockets::address_family::inter_network;

    };


  }

}


#include "../literals/ip_address.hpp"

address_family.hpp
Contains xtd::net::sockets::address_family enum.

array.hpp
Contains xtd::array class.

xtd::array
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:64

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

xtd::net::ip_address::is_ip_v6_multicast
auto is_ip_v6_multicast() const noexcept -> bool
Gets whether the address is an IPv6 multicast global address.

xtd::net::ip_address::is_ip_v6_teredo
auto is_ip_v6_teredo() const noexcept -> bool
Gets whether the address is an IPv6 Teredo address.

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

xtd::net::ip_address::is_ip_v4_mapped_to_ip_v6
auto is_ip_v4_mapped_to_ip_v6() const noexcept -> bool
Gets whether the IP address is an IPv4-mapped IPv6 address.

xtd::net::ip_address::ip_v6_none
static const ip_address ip_v6_none
Provides an IP address that indicates that no network interface should be used. This field is constan...
Definition ip_address.hpp:62

xtd::net::ip_address::get_hash_code
auto get_hash_code() const noexcept -> xtd::size override
Serves as a hash function for a particular type.

xtd::net::ip_address::is_loopback
static auto is_loopback(const ip_address &address) -> bool
Indicates whether the specified IP address is the loopback address.

xtd::net::ip_address::map_to_ip_v4
auto map_to_ip_v4() const noexcept -> ip_address
Maps the xtd::net::ip_address object to an IPv4 address.

xtd::net::ip_address::any
static const ip_address any
Provides an IP address that indicates that the server must listen for client activity on all network ...
Definition ip_address.hpp:49

xtd::net::ip_address::address_family
auto address_family() const noexcept -> xtd::net::sockets::address_family
Gets the address family of the IP address.

xtd::net::ip_address::parse
static auto parse(const xtd::string &str) -> ip_address
Converts an IP address string to an xtd::net::ip_address instance.

xtd::net::ip_address::loopback
static const ip_address loopback
Provides the IP loopback address. This field is constant.
Definition ip_address.hpp:65

xtd::net::ip_address::network_to_host_order
static auto network_to_host_order(double network) -> double
Converts a Double value from network byte order to host byte order.

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

xtd::net::ip_address::try_parse
static auto try_parse(const xtd::string &str, ip_address &address) noexcept -> bool
Determines whether a string is a valid IP address.

xtd::net::ip_address::host_to_network_order
static auto host_to_network_order(double host) -> double
Converts a Double value from host byte order to network byte order.

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

xtd::net::ip_address::map_to_ip_v6
auto map_to_ip_v6() const noexcept -> ip_address
Maps the xtd::net::ip_address object to an IPv6 address.

xtd::net::ip_address::is_ip_v6_site_local
auto is_ip_v6_site_local() const noexcept -> bool
Gets whether the address is an IPv6 site local address.

xtd::net::ip_address::get_address_bytes
auto get_address_bytes() const -> xtd::array< xtd::byte >
Provides a copy of the IPAddress as an array of bytes.

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

xtd::net::ip_address::ip_v6_loopback
static const ip_address ip_v6_loopback
Provides the IP loopback address. This field is constant.
Definition ip_address.hpp:58

xtd::net::ip_address::scope_id
auto scope_id() const -> xtd::uint32
Gets the IPv6 address scope identifier.

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

xtd::net::ip_address::broadcast
static const ip_address broadcast
Provides the IP broadcast address. This field is constant.
Definition ip_address.hpp:52

xtd::net::ip_address::ip_v6_any
static const ip_address ip_v6_any
The Socket::Bind method uses the cIPv6Any field to indicate that a Socket must listen for client acti...
Definition ip_address.hpp:55

xtd::net::ip_address::to_string
auto to_string() const noexcept -> xtd::string override
Converts an Internet address to its standard notation.

xtd::net::ip_address::equals
auto equals(const object &obj) const noexcept -> bool override
Determines whether the specified object is equal to the current object.

xtd::net::ip_address::is_ip_v6_link_local
auto is_ip_v6_link_local() const noexcept -> bool
Gets whether the address is an IPv6 link local address.

xtd::net::ip_address::none
static const ip_address none
Provides an IP address that indicates that no network interface should be used. This field is constan...
Definition ip_address.hpp:68

xtd::net::sockets::socket
Implements the Berkeley sockets interface.
Definition socket.hpp:77

xtd::object
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.hpp:45

core_export.hpp
Contains core_export_ keyword.

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

xtd::int64
std::int64_t int64
Represents a 64-bit signed integer.
Definition int64.hpp:23

xtd::uint32
std::uint32_t uint32
Represents a 32-bit unsigned integer.
Definition uint32.hpp:23

xtd::size
size_t size
Represents a size of any object in bytes.
Definition size.hpp:23

xtd::uint16
std::uint16_t uint16
Represents a 16-bit unsigned integer.
Definition uint16.hpp:23

xtd::int32
std::int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23

xtd::int16
std::int16_t int16
Represents a 16-bit signed integer.
Definition int16.hpp:23

xtd::uint64
std::uint64_t uint64
Represents a 64-bit unsigned integer.
Definition uint64.hpp:23

xtd::byte
std::uint8_t byte
Represents a 8-bit unsigned integer.
Definition byte.hpp:23

xtd::uri_components::host
@ host
The xtd::uri::host data.
Definition uri_components.hpp:23

xtd::platform_id::other
@ other
The operating system is other.
Definition platform_id.hpp:60

iequatable.hpp
Contains xtd::iequatable interface.

xtd::net::sockets
The xtd::net::sockets namespace provides a managed implementation of the Berkeley Sockets interface f...
Definition address_family.hpp:16

xtd::net
The xtd::net namespace provides a simple programming interface for many of the protocols used on netw...
Definition cookie_exception.hpp:10

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

object.hpp
Contains xtd::object class.

string.hpp
Contains xtd::string alias.

types.hpp
Contains xtd fundamental types.