CTR Pia
4.11.3
Game Communication Engine
|
Represents an address used to uniquely identify stations.
.
More...
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::InetAddress & | GetInetAddress (void) const |
Gets a const reference to an nn::pia::common::InetAddress instance. More... | |
nn::pia::common::InetAddress & | GetInetAddress (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... | |
StationAddress & | operator= (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... | |
Represents an address used to uniquely identify stations.
.
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.
|
static |
Comparison function (greater than/less than/equal).
[in] | a | The left-hand side object to compare. |
[in] | b | The right-hand side object to compare. |
-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.
[in] | pData | Pointer to the serialized data. |
Result
value for which the IsSuccess
function will return true
. Your application's implementation must ensure that this function does not return any errors. 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.
|
inline |
Gets a const
reference to an nn::pia::common::InetAddress
instance.
const
reference to an nn::pia::common::InetAddress
instance.
|
inline |
Gets a reference to an nn::pia::common::InetAddress
instance.
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.
|
inline |
This is an equality operator. Determines whether two StationAddress
objects are not equal.
true
if the objects are not equal, and false
otherwise. bool nn::pia::common::StationAddress::operator< | ( | const StationAddress & | rhs | ) | const |
Comparison operator.
true
if this object is smaller. StationAddress& nn::pia::common::StationAddress::operator= | ( | const StationAddress & | rhs | ) |
This is the assignment operator.
this
object. bool nn::pia::common::StationAddress::operator== | ( | const StationAddress & | rhs | ) | const |
This is an equality operator. Determines whether two StationAddress
objects are equal.
true
if the objects are equal, and false
otherwise. bool nn::pia::common::StationAddress::operator> | ( | const StationAddress & | rhs | ) | const |
Comparison operator.
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.
[out] | pBuffer | Pointer to a buffer for holding the serialized data. |
[out] | pDataLen | Holds the length of the serialized data that was written to the buffer. The value is in bytes. |
[in] | bufferSize | Specifies the size of the buffer that was specified in pBuffer. |
Result
value for which the IsSuccess
function will return true
. Your application's implementation must ensure that this function does not return any errors. 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. nn::Result nn::pia::common::StationAddress::SetInetAddress | ( | const nn::pia::common::InetAddress & | addr | ) |
Sets the nn::pia::common::InetAddress
instance.
[in] | addr | Specifies the Internet address to set. |
|
virtual |
Prints information useful for debugging.
[in] | flag | Specifies the bitwise OR of trace flags. For more information, see the TraceFlag type. |