Asposecpplib

Represents the IP address. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Object.

Public Types

typedef std::shared_ptr< System::Details::ip_address_impl > ImplPtr
 A pointer to the implementation type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

System::Net::Sockets::AddressFamily get_AddressFamily ()
 Returns the address family. More...
 
int64_t get_ScopeId ()
 Gets the scope identifier of the IPv6 address. More...
 
void set_ScopeId (int64_t value)
 Sets the scope identifier of the IPv6 address. More...
 
bool get_IsIPv6Multicast ()
 Returns a value that indicates if the address is an global IPv6 multicast address. More...
 
bool get_IsIPv6LinkLocal ()
 Returns a value that indicates if the address is an IPv6 link-local address. More...
 
bool get_IsIPv6SiteLocal ()
 Returns a value that indicates if the address is an IPv6 site-local address. More...
 
bool get_IsIPv6Teredo ()
 Returns a value that indicates if the address is an IPv6 Teredo address. More...
 
bool get_IsIPv4MappedToIPv6 ()
 Returns a value that indicates if the address is an IPv4 address and is mapped to an IPv6 address. More...
 
 IPAddress (int64_t newAddress)
 Constructs a new instance. More...
 
 IPAddress (System::ArrayPtr< uint8_t > address, int64_t scopeid)
 Constructs a new instance. More...
 
 IPAddress (System::ArrayPtr< uint8_t > address)
 Constructs a new instance. More...
 
System::ArrayPtr< uint8_t > GetAddressBytes ()
 Returns a byte array of the IP address. More...
 
String ToString () const override
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
bool Equals (System::SharedPtr< Object > comparand) override
 Compares objects using C# Object.Equals semantics. More...
 
int32_t GetHashCode () const override
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
System::SharedPtr< IPAddressMapToIPv6 ()
 Maps the address to the IPv6 address. More...
 
System::SharedPtr< IPAddressMapToIPv4 ()
 Maps the address to the IPv4 address. More...
 
 IPAddress ()
 Constructs a new instance. More...
 
ImplPtr GetImpl () const
 Returns a pointer to implementation. More...
 
void SetImpl (ImplPtr impl)
 Sets a pointer to implementation. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Static Public Member Functions

static bool TryParse (String ipString, System::SharedPtr< IPAddress > &address)
 Tries to convert a passed string to an instance of the IPAddress class. More...
 
static System::SharedPtr< IPAddressParse (String ipString)
 Converts a passed string to an instance of the IPAddress class. More...
 
static int64_t HostToNetworkOrder (int64_t host)
 Converts the specified host byte order to the corresponding network byte order. More...
 
static int32_t HostToNetworkOrder (int32_t host)
 Converts the specified host byte order to the corresponding network byte order. More...
 
static int16_t HostToNetworkOrder (int16_t host)
 Converts the specified host byte order to the corresponding network byte order. More...
 
static int64_t NetworkToHostOrder (int64_t network)
 Converts the specified network byte order to the corresponding host byte order. More...
 
static int32_t NetworkToHostOrder (int32_t network)
 Converts the specified network byte order to the corresponding host byte order. More...
 
static int16_t NetworkToHostOrder (int16_t network)
 Converts the specified network byte order to the corresponding host byte order. More...
 
static bool IsLoopback (System::SharedPtr< IPAddress > address)
 Returns a value that indicates if the specified address is a loopback address. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Static Public Attributes

static System::SharedPtr< IPAddressAny
 The IPv4 address that indicates if the server must listen all network interfaces. More...
 
static System::SharedPtr< IPAddressLoopback
 The IPv4 loopback address. More...
 
static System::SharedPtr< IPAddressBroadcast
 The IPv4 broadcast address. More...
 
static System::SharedPtr< IPAddressNone
 The IPv4 address that indicates if the server mustn't listen any network interface. More...
 
static System::SharedPtr< IPAddressIPv6Any
 The IPv6 address that indicates if the server must listen all network interfaces. More...
 
static System::SharedPtr< IPAddressIPv6Loopback
 The IPv6 loopback address. More...
 
static System::SharedPtr< IPAddressIPv6None
 The IPv6 address that indicates if the server mustn't listen any network interface. More...
 

Detailed Description

Represents the IP address. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ ImplPtr

typedef std::shared_ptr<System::Details::ip_address_impl> System::Net::IPAddress::ImplPtr

A pointer to the implementation type.

Constructor & Destructor Documentation

◆ IPAddress() [1/4]

System::Net::IPAddress::IPAddress ( int64_t  newAddress)

Constructs a new instance.

Parameters
newAddressThe integer representation of an IP address.

◆ IPAddress() [2/4]

System::Net::IPAddress::IPAddress ( System::ArrayPtr< uint8_t >  address,
int64_t  scopeid 
)

Constructs a new instance.

Parameters
addressThe byte array that contains an IP address.
scopeidThe scope identifier.

◆ IPAddress() [3/4]

System::Net::IPAddress::IPAddress ( System::ArrayPtr< uint8_t >  address)

Constructs a new instance.

Parameters
addressThe byte array that contains an IP address.

◆ IPAddress() [4/4]

System::Net::IPAddress::IPAddress ( )

Constructs a new instance.

Member Function Documentation

◆ Equals()

bool System::Net::IPAddress::Equals ( System::SharedPtr< Object comparand)
override

Compares objects using C# Object.Equals semantics.

Parameters
comparandObject to compare current one to.
Returns
True if objects are considered equal and false otherwise.

◆ get_AddressFamily()

System::Net::Sockets::AddressFamily System::Net::IPAddress::get_AddressFamily ( )

Returns the address family.

Returns
The address family.

◆ get_IsIPv4MappedToIPv6()

bool System::Net::IPAddress::get_IsIPv4MappedToIPv6 ( )

Returns a value that indicates if the address is an IPv4 address and is mapped to an IPv6 address.

Returns
A value that indicates if the address is an IPv4 address and is mapped to an IPv6 address.

◆ get_IsIPv6LinkLocal()

bool System::Net::IPAddress::get_IsIPv6LinkLocal ( )

Returns a value that indicates if the address is an IPv6 link-local address.

Returns
A value that indicates if the address is an IPv6 link-local address.

◆ get_IsIPv6Multicast()

bool System::Net::IPAddress::get_IsIPv6Multicast ( )

Returns a value that indicates if the address is an global IPv6 multicast address.

Returns
A value that indicates if the address is a global IPv6 multicast address.

◆ get_IsIPv6SiteLocal()

bool System::Net::IPAddress::get_IsIPv6SiteLocal ( )

Returns a value that indicates if the address is an IPv6 site-local address.

Returns
A value that indicates if the address is an IPv6 site-local address.

◆ get_IsIPv6Teredo()

bool System::Net::IPAddress::get_IsIPv6Teredo ( )

Returns a value that indicates if the address is an IPv6 Teredo address.

Returns
A value that indicates if the address is an IPv6 Teredo address.

◆ get_ScopeId()

int64_t System::Net::IPAddress::get_ScopeId ( )

Gets the scope identifier of the IPv6 address.

Returns
The scope identifier of the IPv6 address.

◆ GetAddressBytes()

System::ArrayPtr<uint8_t> System::Net::IPAddress::GetAddressBytes ( )

Returns a byte array of the IP address.

Returns
A byte array of the IP address.

◆ GetHashCode()

int32_t System::Net::IPAddress::GetHashCode ( ) const
overridevirtual

Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

Returns
Hash code value as calculated by corresponding class.

Reimplemented from System::Object.

◆ GetImpl()

ImplPtr System::Net::IPAddress::GetImpl ( ) const

Returns a pointer to implementation.

Returns
A pointer to implementation.

◆ HostToNetworkOrder() [1/3]

static int16_t System::Net::IPAddress::HostToNetworkOrder ( int16_t  host)
static

Converts the specified host byte order to the corresponding network byte order.

Parameters
hostThe value to convert.
Returns
The corresponding network byte order.

◆ HostToNetworkOrder() [2/3]

static int32_t System::Net::IPAddress::HostToNetworkOrder ( int32_t  host)
static

Converts the specified host byte order to the corresponding network byte order.

Parameters
hostThe value to convert.
Returns
The corresponding network byte order.

◆ HostToNetworkOrder() [3/3]

static int64_t System::Net::IPAddress::HostToNetworkOrder ( int64_t  host)
static

Converts the specified host byte order to the corresponding network byte order.

Parameters
hostThe value to convert.
Returns
The corresponding network byte order.

◆ IsLoopback()

static bool System::Net::IPAddress::IsLoopback ( System::SharedPtr< IPAddress address)
static

Returns a value that indicates if the specified address is a loopback address.

Parameters
addressThe address to check.
Returns
True when the specified address is a loopback address, otherwise false.

◆ MapToIPv4()

System::SharedPtr<IPAddress> System::Net::IPAddress::MapToIPv4 ( )

Maps the address to the IPv4 address.

Returns
The corresponding IPv4 address.

◆ MapToIPv6()

System::SharedPtr<IPAddress> System::Net::IPAddress::MapToIPv6 ( )

Maps the address to the IPv6 address.

Returns
The corresponding IPv6 address.

◆ NetworkToHostOrder() [1/3]

static int16_t System::Net::IPAddress::NetworkToHostOrder ( int16_t  network)
static

Converts the specified network byte order to the corresponding host byte order.

Parameters
networkThe value to convert.
Returns
The corresponding host byte order.

◆ NetworkToHostOrder() [2/3]

static int32_t System::Net::IPAddress::NetworkToHostOrder ( int32_t  network)
static

Converts the specified network byte order to the corresponding host byte order.

Parameters
networkThe value to convert.
Returns
The corresponding host byte order.

◆ NetworkToHostOrder() [3/3]

static int64_t System::Net::IPAddress::NetworkToHostOrder ( int64_t  network)
static

Converts the specified network byte order to the corresponding host byte order.

Parameters
networkThe value to convert.
Returns
The corresponding host byte order.

◆ Parse()

static System::SharedPtr<IPAddress> System::Net::IPAddress::Parse ( String  ipString)
static

Converts a passed string to an instance of the IPAddress class.

Parameters
ipStringA string to parse.
Returns
An instance of the IPAddress class.

◆ set_ScopeId()

void System::Net::IPAddress::set_ScopeId ( int64_t  value)

Sets the scope identifier of the IPv6 address.

Parameters
valueThe value that must be set.

◆ SetImpl()

void System::Net::IPAddress::SetImpl ( ImplPtr  impl)

Sets a pointer to implementation.

Parameters
implA pointer that must be set.

◆ ToString()

String System::Net::IPAddress::ToString ( ) const
overridevirtual

Analog of C# Object.ToString() method. Enables converting custom objects to string.

Returns
String representation as provided by final class.

Reimplemented from System::Object.

◆ TryParse()

static bool System::Net::IPAddress::TryParse ( String  ipString,
System::SharedPtr< IPAddress > &  address 
)
static

Tries to convert a passed string to an instance of the IPAddress class.

Parameters
ipStringA string to parse.
addressAn instance where a parsed object will be assigned.
Returns
True when the parsing is successfully done, otherwise false.

Member Data Documentation

◆ Any

System::SharedPtr<IPAddress> System::Net::IPAddress::Any
static

The IPv4 address that indicates if the server must listen all network interfaces.

◆ Broadcast

System::SharedPtr<IPAddress> System::Net::IPAddress::Broadcast
static

The IPv4 broadcast address.

◆ IPv6Any

System::SharedPtr<IPAddress> System::Net::IPAddress::IPv6Any
static

The IPv6 address that indicates if the server must listen all network interfaces.

◆ IPv6Loopback

System::SharedPtr<IPAddress> System::Net::IPAddress::IPv6Loopback
static

The IPv6 loopback address.

◆ IPv6None

System::SharedPtr<IPAddress> System::Net::IPAddress::IPv6None
static

The IPv6 address that indicates if the server mustn't listen any network interface.

◆ Loopback

System::SharedPtr<IPAddress> System::Net::IPAddress::Loopback
static

The IPv4 loopback address.

◆ None

System::SharedPtr<IPAddress> System::Net::IPAddress::None
static

The IPv4 address that indicates if the server mustn't listen any network interface.