CTR Pia  4.11.3
Game Communication Engine
nn::pia::common::StationAddress Class Reference

Represents an address used to uniquely identify stations.
. More...

+ Inheritance diagram for nn::pia::common::StationAddress:

Public Member Functions

 StationAddress (void)
 Instantiates the object.
 
 StationAddress (const StationAddress &rhs)
 This is the copy constructor.
 
void Clear (void)
 Clears the StationAddress.
 
nn::Result Deserialize (const bit8 *pData)
 Restores an object from serialized data. More...
 
const nn::pia::common::InetAddressGetInetAddress (void) const
 Gets a const reference to an nn::pia::common::InetAddress instance. More...
 
nn::pia::common::InetAddressGetInetAddress (void)
 Gets a reference to an nn::pia::common::InetAddress instance. More...
 
size_t GetSerializedSize (void) const
 Gets the length of the object as a serialized byte array. The value is in bytes. More...
 
bool operator!= (const StationAddress &rhs) const
 This is an equality operator. Determines whether two StationAddress objects are not equal. More...
 
bool operator< (const StationAddress &rhs) const
 Comparison operator. More...
 
StationAddressoperator= (const StationAddress &rhs)
 This is the assignment operator. More...
 
bool operator== (const StationAddress &rhs) const
 This is an equality operator. Determines whether two StationAddress objects are equal. More...
 
bool operator> (const StationAddress &rhs) const
 Comparison operator. More...
 
nn::Result Serialize (bit8 *pBuffer, size_t *pDataLen, size_t bufferSize) const
 Serializes the object. More...
 
nn::Result SetInetAddress (const nn::pia::common::InetAddress &addr)
 Sets the nn::pia::common::InetAddress instance. More...
 
virtual void Trace (u64 flag) const
 Prints information useful for debugging. More...
 

Static Public Member Functions

static int Compare (const StationAddress &a, const StationAddress &b)
 Comparison function (greater than/less than/equal). More...
 

Detailed Description

Represents an address used to uniquely identify stations.
.

Revision History:

2014-05-29 Made the StationAddress::GetUdsNodeId and StationAddress::SetUdsNodeId functions private.

2013-05-17 Changed the documentation because of the deprecation of StationAddress::GetUdsNodeId and StationAddress::SetUdsNodeId.

2013-02-22 Added greater than and less than comparison functions and operators.

2012-04-23 Removed an unneeded destructor.

2012-04-19 Initial version.

Member Function Documentation

static int nn::pia::common::StationAddress::Compare ( const StationAddress a,
const StationAddress b 
)
static

Comparison function (greater than/less than/equal).

Parameters
[in]aThe left-hand side object to compare.
[in]bThe right-hand side object to compare.
Returns
Returns -1 if b is less than a, 1 if b is greater than a, and 0 if they are equal.
nn::Result nn::pia::common::StationAddress::Deserialize ( const bit8 *  pData)

Restores an object from serialized data.

Parameters
[in]pDataPointer to the serialized data.
Returns
On success, returns a Result value for which the IsSuccess function will return true. Your application's implementation must ensure that this function does not return any errors.
Error Return Values:
ResultInvalidArgument Indicates that an argument is invalid. (For example, a NULL pointer was specified.) Programming error. Fix your program so that this error is not returned.
See also
Serialize, GetSerializedSize
const nn::pia::common::InetAddress& nn::pia::common::StationAddress::GetInetAddress ( void  ) const
inline

Gets a const reference to an nn::pia::common::InetAddress instance.

Returns
Returns a const reference to an nn::pia::common::InetAddress instance.
nn::pia::common::InetAddress& nn::pia::common::StationAddress::GetInetAddress ( void  )
inline

Gets a reference to an nn::pia::common::InetAddress instance.

Returns
Returns a reference to an nn::pia::common::InetAddress instance.
size_t nn::pia::common::StationAddress::GetSerializedSize ( void  ) const

Gets the length of the object as a serialized byte array. The value is in bytes.

Returns
Returns the length of the serialized data. The value is in bytes.
See also
Serialize, Deserialize
bool nn::pia::common::StationAddress::operator!= ( const StationAddress rhs) const
inline

This is an equality operator. Determines whether two StationAddress objects are not equal.

Returns
Returns true if the objects are not equal, and false otherwise.
bool nn::pia::common::StationAddress::operator< ( const StationAddress rhs) const

Comparison operator.

Returns
true if this object is smaller.
StationAddress& nn::pia::common::StationAddress::operator= ( const StationAddress rhs)

This is the assignment operator.

Returns
Returns a reference to the this object.
bool nn::pia::common::StationAddress::operator== ( const StationAddress rhs) const

This is an equality operator. Determines whether two StationAddress objects are equal.

Returns
Returns true if the objects are equal, and false otherwise.
bool nn::pia::common::StationAddress::operator> ( const StationAddress rhs) const

Comparison operator.

Returns
true if this object is larger.
nn::Result nn::pia::common::StationAddress::Serialize ( bit8 *  pBuffer,
size_t *  pDataLen,
size_t  bufferSize 
) const

Serializes the object.

Parameters
[out]pBufferPointer to a buffer for holding the serialized data.
[out]pDataLenHolds the length of the serialized data that was written to the buffer. The value is in bytes.
[in]bufferSizeSpecifies the size of the buffer that was specified in pBuffer.
Returns
On success, returns a Result value for which the IsSuccess function will return true. Your application's implementation must ensure that this function does not return any errors.
Error Return Values:
ResultInvalidArgument Indicates that an argument is invalid. (For example, a NULL pointer was specified.) The function also returns this error if pBuffer or the size specified in bufferSize is too small. Programming error. Fix your program so that this error is not returned.
See also
Deserialize, GetSerializedSize
nn::Result nn::pia::common::StationAddress::SetInetAddress ( const nn::pia::common::InetAddress addr)

Sets the nn::pia::common::InetAddress instance.

Parameters
[in]addrSpecifies the Internet address to set.
Returns
This function always succeeds.
virtual void nn::pia::common::StationAddress::Trace ( u64  flag) const
virtual

Prints information useful for debugging.

Parameters
[in]flagSpecifies the bitwise OR of trace flags. For more information, see the TraceFlag type.