CTR Pia  4.11.3
Game Communication Engine
nn::pia::transport::StationConnectionInfo Class Reference

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

+ Inheritance diagram for nn::pia::transport::StationConnectionInfo:

Public Member Functions

 StationConnectionInfo (void)
 Instantiates the object.
 
 StationConnectionInfo (const StationConnectionInfo &o)
 This is the copy constructor. More...
 
virtual ~StationConnectionInfo (void)
 Destroys the object.
 
const StationLocationGetMainLocation (void) const
 Gets a const reference to the StationLocation (main address). More...
 
StationLocationGetMainLocation (void)
 Gets a reference to the StationLocation (main address). More...
 
const StationLocationGetPrivateLocation (void) const
 Gets a const reference to the sub-address of the StationLocation. The sub-address is intended to be used for private addresses. More...
 
StationLocationGetPrivateLocation (void)
 Gets a reference to the sub-address of the StationLocation. The sub-address is intended to be used for private addresses. More...
 
const StationLocationGetPublicLocation (void) const
 Gets a const reference to the main address of the StationLocation. The main address is intended to be used for public addresses. More...
 
StationLocationGetPublicLocation (void)
 Gets a reference to the main address of the StationLocation. The main address is intended to be used for public addresses. More...
 
const StationLocationGetSubLocation (void) const
 Gets a const reference to the StationLocation (sub-address). More...
 
StationLocationGetSubLocation (void)
 Gets a reference to the StationLocation (sub-address). More...
 
StationConnectionInfooperator= (const StationConnectionInfo &o)
 This is the assignment operator. More...
 
void SetMainLocation (const StationLocation &o)
 Sets the StationLocation (main address). More...
 
void SetSubLocation (const StationLocation &o)
 Sets the StationLocation (sub-address). More...
 
virtual void Trace (u64 flag) const
 Prints information that is useful for debugging. More...
 

Detailed Description

Represents an address used to uniquely identify stations.

This class includes two instances of StationLocation. One is for the main address and one is for a sub-address.


Revision History:

2012-04-16 Added a serialized group of API functions for streamlining size during serialization.

2012-04-06 Initial version.

Constructor & Destructor Documentation

nn::pia::transport::StationConnectionInfo::StationConnectionInfo ( const StationConnectionInfo o)

This is the copy constructor.

Parameters
[in]oSpecifies the argument to the copy constructor.

Member Function Documentation

const StationLocation& nn::pia::transport::StationConnectionInfo::GetMainLocation ( void  ) const
inline

Gets a const reference to the StationLocation (main address).

Returns
Returns a const reference to the StationLocation (main address).
StationLocation& nn::pia::transport::StationConnectionInfo::GetMainLocation ( void  )
inline

Gets a reference to the StationLocation (main address).

Returns
Returns a reference to the StationLocation (main address).
const StationLocation& nn::pia::transport::StationConnectionInfo::GetPrivateLocation ( void  ) const
inline

Gets a const reference to the sub-address of the StationLocation. The sub-address is intended to be used for private addresses.

Returns
Returns a const reference to the sub-address of the StationLocation.
StationLocation& nn::pia::transport::StationConnectionInfo::GetPrivateLocation ( void  )
inline

Gets a reference to the sub-address of the StationLocation. The sub-address is intended to be used for private addresses.

Returns
Returns a reference to the sub-address of the StationLocation.
const StationLocation& nn::pia::transport::StationConnectionInfo::GetPublicLocation ( void  ) const
inline

Gets a const reference to the main address of the StationLocation. The main address is intended to be used for public addresses.

Returns
Returns a const reference to the main address of the StationLocation.
StationLocation& nn::pia::transport::StationConnectionInfo::GetPublicLocation ( void  )
inline

Gets a reference to the main address of the StationLocation. The main address is intended to be used for public addresses.

Returns
Returns a reference to the main address of the StationLocation.
const StationLocation& nn::pia::transport::StationConnectionInfo::GetSubLocation ( void  ) const
inline

Gets a const reference to the StationLocation (sub-address).

Returns
Returns a const reference to the StationLocation (sub-address).
StationLocation& nn::pia::transport::StationConnectionInfo::GetSubLocation ( void  )
inline

Gets a reference to the StationLocation (sub-address).

Returns
Returns a reference to the StationLocation (sub-address).
StationConnectionInfo& nn::pia::transport::StationConnectionInfo::operator= ( const StationConnectionInfo o)

This is the assignment operator.

Parameters
[in]oThe StationConnectionInfo object to assign.
Returns
Returns a reference to the this object.
void nn::pia::transport::StationConnectionInfo::SetMainLocation ( const StationLocation o)
inline

Sets the StationLocation (main address).

Parameters
[in]oSpecifies the StationLocation to set.
void nn::pia::transport::StationConnectionInfo::SetSubLocation ( const StationLocation o)
inline

Sets the StationLocation (sub-address).

Parameters
[in]oSpecifies the StationLocation to set.
virtual void nn::pia::transport::StationConnectionInfo::Trace ( u64  flag) const
virtual

Prints information that is useful for debugging.

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