W60X_Arduino: IPAddress_class

Arduino W60X

W60X_Arduino
IPAddress_class

Functions

 IPAddress::IPAddress ()
 This constructor function is used to construct IPAddress object. More...
 
 IPAddress::IPAddress (uint8_t first_oct, uint8_t sec_oct, uint8_t third_oct, uint8_t fourth_oct)
 This constructor function is used to construct IPAddress object. More...
 
 IPAddress::IPAddress (uint32_t address)
 This constructor function is used to construct IPAddress object. More...
 
 IPAddress::IPAddress (const uint8_t *address)
 This constructor function is used to construct IPAddress object. More...
 
 IPAddress::operator uint32_t () const
 This operator overloading function is used to overloading 'uint32_t' operator. More...
 
bool IPAddress::operator== (const IPAddress &addr) const
 This operator overloading function is used to overloading '==' operator. More...
 
bool IPAddress::operator== (uint32_t addr) const
 This operator overloading function is used to overloading '==' operator. More...
 
bool IPAddress::operator== (const uint8_t *addr) const
 This operator overloading function is used to overloading '==' operator. More...
 
uint8_t IPAddress::operator[] (int index) const
 This operator overloading function is used to overloading '[]' operator. More...
 
uint8_t & IPAddress::operator[] (int index)
 This operator overloading function is used to overloading '[]' operator. More...
 
IPAddressIPAddress::operator= (const uint8_t *address)
 This operator overloading function is used to overloading '=' operator. More...
 
IPAddressIPAddress::operator= (uint32_t address)
 This operator overloading function is used to overloading '=' operator. More...
 
String IPAddress::toString () const
 This function is used to transform from IPAddress object to String object. More...
 
bool IPAddress::fromString (const char *address)
 This function is used to create the object from a string buffer. More...
 
bool IPAddress::fromString (const String &address)
 This function is used to create the object from a String object. More...
 
virtual size_t IPAddress::printTo (Print &p) const
 This virtual function is used to called by print/println function. More...
 

Detailed Description

Function Documentation

◆ fromString() [1/2]

bool IPAddress::fromString ( const char *  address)

This function is used to create the object from a string buffer.

Parameters
[in]addressSpecify the string buffer.
Returns
bool
Note

◆ fromString() [2/2]

bool IPAddress::fromString ( const String &  address)

This function is used to create the object from a String object.

Parameters
[in]addressSpecify the String object.
Returns
bool
Note

◆ IPAddress() [1/4]

IPAddress::IPAddress ( )

This constructor function is used to construct IPAddress object.

Parameters
[in]None
Returns
None
Note

◆ IPAddress() [2/4]

IPAddress::IPAddress ( uint8_t  first_octet,
uint8_t  second_octet,
uint8_t  third_octet,
uint8_t  fourth_octet 
)

This constructor function is used to construct IPAddress object.

Parameters
[in]first_octSpecify the first_oct - uint8_t
[in]sec_octSpecify the sec_oct - uint8_t
[in]third_octSpecify the third_oct - uint8_t
[in]fourth_octSpecify the fourth_oct - uint8_t
Returns
None
Note

◆ IPAddress() [3/4]

IPAddress::IPAddress ( uint32_t  address)

This constructor function is used to construct IPAddress object.

Parameters
[in]addressSpecify the address - uint32_t
Returns
None
Note

◆ IPAddress() [4/4]

IPAddress::IPAddress ( const uint8_t *  address)

This constructor function is used to construct IPAddress object.

Parameters
[in]addressSpecify the address - uint8_t *
Returns
None
Note

◆ operator uint32_t()

IPAddress::operator uint32_t ( ) const
inline

This operator overloading function is used to overloading 'uint32_t' operator.

Parameters
[in]None
Returns
The value of the IPAddress object in uint32_t type.
Note

◆ operator=() [1/2]

IPAddress & IPAddress::operator= ( const uint8_t *  address)

This operator overloading function is used to overloading '=' operator.

Parameters
[in]addressSepcify the address - uint8_t *
Returns
the target IPAddress object.
Note

◆ operator=() [2/2]

IPAddress & IPAddress::operator= ( uint32_t  address)

This operator overloading function is used to overloading '=' operator.

Parameters
[in]addressSepcify the address - uint32_t
Returns
the target IPAddress object.
Note

◆ operator==() [1/3]

bool IPAddress::operator== ( const IPAddress addr) const
inline

This operator overloading function is used to overloading '==' operator.

Parameters
[in]addrSepcify the address - IPAddress
Returns
bool
Note

◆ operator==() [2/3]

bool IPAddress::operator== ( uint32_t  addr) const
inline

This operator overloading function is used to overloading '==' operator.

Parameters
[in]addrSepcify the address - uint32_t
Returns
bool
Note

◆ operator==() [3/3]

bool IPAddress::operator== ( const uint8_t *  addr) const

This operator overloading function is used to overloading '==' operator.

Parameters
[in]addrSepcify the address - uint8_t*
Returns
If they are equal, true is return, otherwise, false is return.
Note

◆ operator[]() [1/2]

uint8_t IPAddress::operator[] ( int  index) const
inline

This operator overloading function is used to overloading '[]' operator.

Parameters
[in]indexSepcify the address value of index.
Returns
the target value of IPAddress object.
Note

◆ operator[]() [2/2]

uint8_t& IPAddress::operator[] ( int  index)
inline

This operator overloading function is used to overloading '[]' operator.

Parameters
[in]indexSepcify the address value of index.
Returns
the target value of IPAddress object.
Note

◆ printTo()

size_t IPAddress::printTo ( Print p) const
virtual

This virtual function is used to called by print/println function.

Parameters
[in]pSpecify the Print object.
Returns
bool
Note
The length of print successfully.

Implements Printable.

◆ toString()

String IPAddress::toString ( ) const

This function is used to transform from IPAddress object to String object.

Parameters
[in]None
Returns
the target String object.
Note
Generated by   doxygen 1.8.14