CTR Pia  4.11.3
Game Communication Engine
nn::pia::util Namespace Reference

Represents the PiaUtil namespace. More...

Classes

class  NetworkErrorCodeConverter
 This class converts nn::Result type errors into network error codes passed to the error/EULA applet. More...
 

Enumerations

Functions

enum HandlingType GetHandlingType (const nn::Result &r)
 Returns the type of handling expected for the Result from Pia. More...
 
const char * GetResultString (const nn::Result &r)
 Returns a string representation of the Pia Result. More...
 
enum ViewerType GetViewerType (const nn::Result &r)
 Determines whether the Pia Result is one for which the Error/EULA applet may be used. More...
 
bool IsPiaResult (const nn::Result &r)
 Determines whether the value is a Pia result. More...
 

Detailed Description

Represents the PiaUtil namespace.


Revision History:
2012-07-06 Initial version.

Enumeration Type Documentation

Enumerates the types of handling expected.

Enumerator
HANDLING_VOID 

Invalid value.

HANDLING_IGNORABLE 

Can be ignored.

HANDLING_RETRY 

Try to execute again after some time has passed.

HANDLING_CLEANUP 

A cleanup process is needed.

HANDLING_LOGOUT 

A logout process is needed.

HANDLING_LEAVE 

A process for leaving a session is needed.

HANDLING_LEAVE_AND_CLEANUP 

After leaving a session, execute a cleanup process.

HANDLING_RECONNECT 

A process for reconnecting is needed.

HANDLING_REINITIALIZE 

Reinitialization is required.

HANDLING_PROGRAMMING_ERROR 

Programming error. The source code must be revised.

Enumerates the policies for using the Error/EULA applet.

Enumerator
VIEWER_VOID 

Invalid value.

VIEWER_SHOULD_USE 

Supposed to be used.

VIEWER_MAY_USE 

Okay to use.

VIEWER_SHOULD_NOT_USE 

Do not use.

Function Documentation

enum HandlingType nn::pia::util::GetHandlingType ( const nn::Result &  r)

Returns the type of handling expected for the Result from Pia.

Parameters
[in]rThe result value that determines the type of handling.
Returns
Returns an enumerated value for the handling that corresponds to the Result. Returns HANDLING_VOID if passed a non-Pia Result or a Result that Pia only uses internally.
const char* nn::pia::util::GetResultString ( const nn::Result &  r)

Returns a string representation of the Pia Result.

Parameters
[in]rThe Pia Result value or ResultSuccess.
Returns
Returns that string representation when the Pia Result or ResultSuccess is passed. Returns an empty string ("") when any other Result is passed.
enum ViewerType nn::pia::util::GetViewerType ( const nn::Result &  r)

Determines whether the Pia Result is one for which the Error/EULA applet may be used.

This API determines whether it is appropriate to pass the network error code that results from feeding the result of a failed Pia API call to NetworkErrorCodeConverter::Convert on to the Error/EULA applet.

For error results returned during local communication, however, do not use the Error/EULA applet, regardless of the return value of this API.

Parameters
[in]rThe result value for the determination.
Returns
Returns the ViewerType that corresponds with the Result passed in. Returns VIEWER_VOID when a non-Pia Result is passed.
See also
NetworkErrorCodeConverter::Convert
bool nn::pia::util::IsPiaResult ( const nn::Result &  r)

Determines whether the value is a Pia result.

Parameters
[in]rThe result value for the determination.
Returns
Returns true if the value is a Pia Result, and returns false otherwise.