nn::rdt::CTR::Sender Class

Syntax

class Sender

Description

Class that represents a device that sends data.

The process below shows how to use the Sender class. Although the description below leaves out calls to Process, in practice Process must be called periodically (at least once every game frame).

1. Create an instance of the Sender class.

2. Call Initialize to initialize the instance. (This assigns memory that the Sender instance will use as working memory and send buffer.)

3. Call Open to attempt a connection to the Receiver instance that is running remotely.

4. Once the state transitions to SENDER_STATE_OPENED, break the data you want to send into small chunks and call Send repeatedly.

5. Once all the data has been sent, call Close to notify the remote party that there is no more data to be sent.

6. Once the state transitions to SENDER_STATE_CLOSED, call Finalize to finalize the Sender class.

Member Constants

S SENDER_WORKBUF_SIZE Size of the working memory required by the Sender instance.

Member Functions

Sender Constructor.
~Sender Destructor.
Initialize Initializes an instance.
Finalize Frees resources that were used by a Sender instance, including the send buffer and the endpoint descriptor(s).
Open Issues a connection request.
Close Issues a request to close a connection.
Send Writes data to the send buffer.
Process Proceeds with communication. The actual communication takes place within this function.
Cancel Cancels processing.
GetStatus Gets the status of a Sender instance.
SetPacketLossRatio Virtually sets the packet loss ratio (for debugging). This function may be removed in a future release without notice.
PrintDebugInfo Prints detailed information about the internal state of a Sender instance (for debugging). This function may be removed in a future release without notice.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL