nn::hio::CTR::SerialChannel Class

Header file: nn/hio.h

Syntax

class SerialChannel

Description

Class that represents the channels used for serial communication.

The CTR target board can communicate with a PC by opening serial communication using the same channel on both sides.

The device initiating communication calls Connect, and the device waiting for communication calls WaitHost. For example, if the CTR calls Connect, the PC must call WaitHost.

Enumerated Types

Attribute Enumerated type that represents sending/reception attributes.

Member Functions

SerialChannel Constructor. You must make a separate call to Open to open a channel.
~SerialChannel Destructor. Closes a channel if it is open.
Open Opens a channel.
Close Closes the channel.
Connect Connects to a host. Blocks until the host calls Wait.
WaitHost Waits for a connection from the host.
Disconnect Disconnects from the host.
Flush Waits until the send buffer is empty. This does not involve the status of the host's receive buffer.
GetReadableSize Gets the loadable size from the buffer(s) and returns the result of the operation.
Read Receives data from the host and returns the result of the operation.
GetWritableSize Gets the size of data that can be written to the buffer(s) and returns the result of the operation.
Write Sends data to the host and returns the result of the operation.

Revision History

2010/03/31
Initial version.

CONFIDENTIAL