CTR Pia
4.11.3
Game Communication Engine
|
Represents a class for unifying multiple Station
instances.
More...
Classes | |
class | ConstIterator |
Represents an iterator for referring to the Station s participating in a session (const version). More... | |
class | Iterator |
Represents an iterator for referring to the Station s participating in a session (non-const version). More... | |
Public Member Functions | |
Iterator | Begin (void) |
Returns the iterator of the Station instance (non-const version). More... | |
ConstIterator | Begin (void) const |
Returns the iterator of the Station instance ( const version). More... | |
Iterator | End (void) |
Returns the iterator of the Station instance (non-const version). More... | |
ConstIterator | End (void) const |
Returns the iterator of the Station instance ( const version). More... | |
Station * | GetLocalStation (void) |
Gets the local station (non-const version). More... | |
const Station * | GetLocalStation (void) const |
Gets the local station ( const version). More... | |
Station * | GetStation (StationId id) |
Gets the Station corresponding to the StationId (non-const version). More... | |
const Station * | GetStation (StationId id) const |
Gets the Station corresponding to the StationId ( const version). More... | |
Station * | GetStation (const common::StationAddress &addr) |
Gets the Station corresponding to the StationAddress (non-const version). More... | |
const Station * | GetStation (const common::StationAddress &addr) const |
Gets the Station corresponding to the StationAddress ( const version). More... | |
nn::Result | GetStationAddress (common::StationAddress *pAddr, StationId id) const |
Gets the StationAddress for the Station corresponding to the StationId . More... | |
Station * | GetStationByAddress (const common::InetAddress &addr) |
Gets the station with the specified Internet address (non-const version). More... | |
const Station * | GetStationByAddress (const common::InetAddress &addr) const |
Gets the Station corresponding to the Internet address ( const version). More... | |
virtual void | Trace (u64 flag) const |
Prints information that is useful for debugging. More... | |
Static Public Member Functions | |
static nn::Result | CreateInstance (void) |
Creates the StationManager class instance (singleton pattern). More... | |
static void | DestroyInstance (void) |
Destroys the StationManager class instance (singleton pattern). More... | |
static StationManager * | GetInstance (void) |
Gets the StationManager class instance (singleton pattern). This function returns a NULL pointer if the instance has not yet been created using the CreateInstance function. This function is thread-safe. More... | |
Represents a class for unifying multiple Station
instances.
The Transport
class constructs and destroys the StationManager
instance. There is no need for the application to call the CreateInstance
or DestroyInstance
functions of the StationManager
class.
2014-09-18 Changed the specifications so that ResultAlreadyExists
is returned if you call CreateInstance
when an instance already exists.
2014-07-15 Changed how the GetStationAddress
and GetStation
functions operate when they are passed invalid arguments.
2012-06-28 Clearly indicated which functions are thread-safe.
2012-04-06 Initial version.
|
inline |
Returns the iterator of the Station
instance (non-const
version).
Station
instances managed by StationManager
.
|
inline |
Returns the iterator of the Station
instance ( const
version).
Station
instances managed by StationManager
.
|
static |
Creates the StationManager
class instance (singleton pattern).
Result
value that indicates success if the instance is created successfully. ResultNotInitialized
Indicates that the transport
module is not initialized. Programming error. Fix your program so that this error is not returned.
ResultInvalidState
Indicates that the timing at which the CreateInstance
function was called is incorrect. Make this call between the BeginSetup
and EndSetup
functions. Programming error. Fix your program so that this error is not returned.
ResultAlreadyExists
Indicates that an instance has already been created. Programming error. Fix your program so that this error is not returned.
|
static |
Destroys the StationManager
class instance (singleton pattern).
|
inline |
Returns the iterator of the Station
instance (non-const
version).
Station
instances managed by StationManager
.
|
inline |
Returns the iterator of the Station
instance ( const
version).
Station
instances managed by StationManager
.
|
inlinestatic |
Gets the StationManager
class instance (singleton pattern). This function returns a NULL
pointer if the instance has not yet been created using the CreateInstance
function. This function is thread-safe.
|
inline |
Gets the local station (non-const
version).
This function is thread-safe.
NULL
pointer is returned.
|
inline |
Gets the local station ( const
version).
This function is thread-safe.
NULL
pointer is returned. Gets the Station
corresponding to the StationId
(non-const
version).
[in] | id | Specifies the StationId . |
Station
corresponding to the specified StationId
exists, a pointer to that Station
is returned. A NULL
pointer is returned if the StationId
does not exist or is invalid. Gets the Station
corresponding to the StationId
( const
version).
[in] | id | Specifies the StationId . |
Station
corresponding to the specified StationId
exists, a pointer to that Station
is returned. A NULL
pointer is returned if the StationId
does not exist or is invalid. Station* nn::pia::transport::StationManager::GetStation | ( | const common::StationAddress & | addr | ) |
Gets the Station
corresponding to the StationAddress
(non-const
version).
[in] | addr | Specifies the station address. |
Station
with the specified station address exists, a pointer to that Station
is returned. If none exists, a NULL
pointer is returned. const Station* nn::pia::transport::StationManager::GetStation | ( | const common::StationAddress & | addr | ) | const |
Gets the Station
corresponding to the StationAddress
( const
version).
[in] | addr | Specifies the station address. |
Station
with the specified station address exists, a pointer to that Station
is returned. If none exists, a NULL
pointer is returned. nn::Result nn::pia::transport::StationManager::GetStationAddress | ( | common::StationAddress * | pAddr, |
StationId | id | ||
) | const |
Gets the StationAddress
for the Station
corresponding to the StationId
.
[out] | pAddr | Specifies a pointer to a StationAddress instance that will hold the result. |
[in] | id | Specifies the StationId . |
Result
value for which the IsSuccess
function returns true
if execution succeeds. ResultInvalidArgument
Specifies that one or more arguments are invalid. This Result
is returned if the StationId
is invalid. Programming error. Fix your program so that this error is not returned.
ResultNotFound
Indicates that the Station
specified in the arguments was not found. Handle appropriately in the application.
Station* nn::pia::transport::StationManager::GetStationByAddress | ( | const common::InetAddress & | addr | ) |
Gets the station with the specified Internet address (non-const
version).
[in] | addr | Specifies the Internet address. |
Station
corresponding to the specified Internet address exists, a pointer to that Station
is returned. If none exists, a NULL
pointer is returned. ResultInvalidArgument
Specifies that one or more arguments are invalid. Programming error. Fix your program so that this error is not returned. const Station* nn::pia::transport::StationManager::GetStationByAddress | ( | const common::InetAddress & | addr | ) | const |
Gets the Station
corresponding to the Internet address ( const
version).
[in] | addr | Specifies the Internet address. |
Station
corresponding to the specified Internet address exists, a pointer to that Station
is returned. If none exists, a NULL
pointer is returned. ResultInvalidArgument
Specifies that one or more arguments are invalid. Programming error. Fix your program so that this error is not returned.
|
virtual |
Prints information that is useful for debugging.
[in] | flag | Specifies the bitwise OR of trace flags. For more information, see the TraceFlag type. |