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

Represents the PiaClone namespace. More...

Classes

class  AtomicSharingClone
 This class is a derivative of CloneBase and provides functionality for exclusively controlling the lock on sending and for bidirectional sending and receiving. More...
 
class  CloneBase
 This is the base class for managing sending and receiving.
. More...
 
class  CloneElementBase
 This is the base class for managing data that is sent and received.
. More...
 
class  CloneProfiler
 This class manages PiaClone profiling. More...
 
class  CloneProfilerBase
 This base class manages PiaClone profiling. More...
 
class  CloneProtocol
 Represents a protocol for sharing values between stations.
More...
 
class  EventCloneElement
 Manages the sending and receiving of events. More...
 
class  EventCloneElementBase
 This is the base class for managing the sending and receiving of events. More...
 
class  HostByteOrderSerializePolicy
 Represents a serialization algorithm based on host byte order. More...
 
class  LittleEndianSerializePolicy
 Represents a serialization algorithm based on little endian. More...
 
class  NetworkByteOrderSerializePolicy
 Represents a serialization algorithm based on network byte order. More...
 
class  ReceiveClone
 This class is a derivative of CloneBase and provides functionality for managing unidirectional receiving.
. More...
 
class  ReliableCloneElement
 Manages the sending and receiving of reliable data. More...
 
class  ReliableCloneElementBase
 This is the base class for managing the sending and receiving of reliable data. More...
 
class  ReliableLargeCloneElement
 Manages sending and receiving reliable large-sized data. More...
 
class  ReliableLargeCloneElementBase
 The base class for managing the sending and receiving of reliable large-sized data. More...
 
class  ReverseSerializePolicy
 Reverses the byte order of the source data and then serializes it. More...
 
class  SendClone
 This class is a derivative of CloneBase and provides functionality for managing unidirectional sending.
. More...
 
class  SequentialSharingClone
 This class is a derivative of CloneBase and provides functionality for bidirectional sending and receiving. It is capable of unlimited sending. More...
 
class  SharingClone
 This class is a derivative of CloneBase and provides functionality for bidirectional sending and receiving.
. More...
 
class  StraightSerializePolicy
 Serializes the source data structure without changes. More...
 
class  UnreliableCloneElement
 Manages the sending and receiving of unreliable data. More...
 
class  UnreliableCloneElementBase
 This is the base class for managing the sending and receiving of unreliable data. More...
 

Typedefs

typedef u32 ClockValue
 Defines a type that holds a clock value.
 

Functions

nn::Result BeginSetup (void)
 Declares the start of setup. More...
 
nn::Result EndSetup (void)
 Declares the end of setup. More...
 
void Finalize (void)
 Finalizes the clone module. This function does nothing and returns if it is called before the Initialize function has been called. More...
 
nn::Result Initialize (void)
 Initializes the clone module. More...
 
bool IsInitialized (void)
 Gets whether the clone module is initialized. More...
 

Variables

static const ClockValue INVALID_CLOCK = 0xffffffff
 Specifies an invalid clock value.
 

Detailed Description

Represents the PiaClone namespace.


Revision History:
2013-07-18 Initial version.

Function Documentation

nn::Result nn::pia::clone::BeginSetup ( void  )

Declares the start of setup.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the clone::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
EndSetup
nn::Result nn::pia::clone::EndSetup ( void  )

Declares the end of setup.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the clone::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
BeginSetup
void nn::pia::clone::Finalize ( void  )

Finalizes the clone module. This function does nothing and returns if it is called before the Initialize function has been called.

See also
IsInitialized, Initialize
nn::Result nn::pia::clone::Initialize ( void  )

Initializes the clone module.

Returns
Returns a Result value indicating success if initialization succeeds. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:
ResultAlreadyInitialized The module is already initialized. Programming error. Fix your program so that this error is not returned.
See also
IsInitialized, Finalize
bool nn::pia::clone::IsInitialized ( void  )

Gets whether the clone module is initialized.

Returns
Returns true if initialized, and false otherwise.
See also
Initialize, Finalize