CTR Pia
4.11.3
Game Communication Engine
|
Represents the PiaTransport
namespace.
More...
Classes | |
struct | ConnectionAnalysisData |
The ConnectionAnalysisData structure contains parameters related to the connection quality (such as the round-trip time (RTT) and the packet loss rate). More... | |
class | NetworkFactory |
An interface (factory pattern) for generating the classes needed by the network. More... | |
struct | PacketAnalysisData |
Stores information required for tabulating the results of an analysis of the data in sent and received packets. More... | |
class | Protocol |
Protocol base class. More... | |
class | ReliableBroadcastProtocol |
Represents a protocol for sending a large volume of data to all stations. More... | |
class | ReliableProtocol |
This protocol sends transmissions that are guaranteed to arrive. More... | |
class | RoundRobinUnreliableProtocol |
This class inherits the UnreliableProtocol class, and adds features to send data while distributing the load. . More... | |
class | SequenceIdController |
Manages the sequence ID of the packet. In conjunction with this, includes a profiling feature for packet loss. More... | |
class | Station |
Represents a station. A station refers to a machine participating in a Pia session. More... | |
class | StationConnectionInfo |
Represents an address used to uniquely identify stations. More... | |
class | StationLocation |
Represents an address used to uniquely identify stations. More... | |
class | StationLocationContainer |
Represents the StationLocation container type. More... | |
class | StationManager |
Represents a class for unifying multiple Station instances. More... | |
class | ThreadStreamManager |
Provides a unified interface for managing sending and receiving threads. More... | |
class | Transport |
Provides core functionality of the transport module. More... | |
struct | TransportAnalysisData |
Contains the results of analyzing send and receive packets, and parameters indicating the quality of the connection (RTT and packet loss) to each station. More... | |
class | TransportAnalyzer |
The TransportAnalyzer class reports on packet analysis results, RTT, packet loss rates, and so on. . More... | |
class | UnreliableProtocol |
Represents the unreliable protocol class, with which data may be lost. UnreliableProtocol does not guarantee that data arrives in the order it was sent. It may not be possible to receive data with the Receive function in the same order it was sent with the Send function. . More... | |
Functions | |
nn::Result | BeginSetup (void) |
Declares the start of setup. More... | |
nn::Result | EndSetup (void) |
Declares the end of setup. More... | |
void | Finalize (void) |
Initializes the transport 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 transport module. More... | |
bool | IsInitialized (void) |
Returns whether the transport module is initialized. More... | |
virtual void | Trace (u64 flag) const |
Prints information that is useful for debugging. More... | |
Represents the PiaTransport
namespace.
2013-10-16 transport.h
now includes transport_PacketAnalysisData.h
.
2012-06-28 Clearly indicated which functions are thread-safe.
2012-05-30 transport.h
now includes transport_ThreadStreamManager.h
.
2012-04-06 Initial version.
nn::Result nn::pia::transport::BeginSetup | ( | void | ) |
Declares the start of setup.
Call this function before creating a singleton of the transport
module. Always call this function and EndSetup
even if your application does not create any singletons of the transport
module.
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. ResultNotInitialized
Indicates that the transport::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.
nn::Result nn::pia::transport::EndSetup | ( | void | ) |
Declares the end of setup.
Call this function after creation of a singleton of the transport
module has finished. Calling this function configures memory to be used by the transport
module singleton and optimizes memory management within the library. Always call BeginSetup
and this function even if your application does not create any singletons of the transport
module.
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. ResultNotInitialized
Indicates that the transport::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.
void nn::pia::transport::Finalize | ( | void | ) |
Initializes the transport
module. This function does nothing and returns if it is called before the Initialize
function has been called.
nn::Result nn::pia::transport::Initialize | ( | void | ) |
Initializes the transport
module.
Result
value indicating success if initialization succeeds. Your application's implementation must ensure that this function does not return any errors. ResultAlreadyInitialized
Specifies that the module is already initialized. Programming error. Fix your program so that this error is not returned. bool nn::pia::transport::IsInitialized | ( | void | ) |
Returns whether the transport
module is initialized.
This function is thread-safe.
true
if initialized, and false
otherwise.
|
virtual |
Prints information that is useful for debugging.
[in] | flag | Bitwise OR of trace flags. For more information, see the TraceFlag type. |