nn::ir::CTR::Communicator Class

Syntax

class Communicator

Description

Class that supports IR communication between CTR systems.

Member Constants

Passphrase String Length
S IR_PASSPHRASE_LENGTH_MIN const size_t Minimum size of the passphrase for generating the encrypted key used in communication.
S IR_PASSPHRASE_LENGTH_MAX const size_t Maximum size of the passphrase for generating the encryption key used in communication.

Member Functions

Initialize/Finalize
S Initialize Initializes the IR library.
S Finalize Finalizes the IR library.
Authenticated Connection
S WaitConnection Waits for a connection request and then tries making an authenticated connection.
S RequireConnection Sends a connection request to the partner CTR and tries to make an authenticated connection.
S AutoConnection Tries to make an authenticated connection.
S GetConnectionRole Gets the connection role.
Networks (Creating, Destroying, Connecting, and Disconnecting)
S CreateCommunicationId Generates a communication ID from a unique ID.
S IsConfirmedId Indicates whether the unique ID and communication ID have been confirmed. You must perform this confirmation before sending or receiving data.
S RequireToConfirmId Requests confirmation of the communication mode ID and communication ID.
S WaitToConfirmId Waits for request to confirm communication ID and communication mode ID.
Disconnection
S Disconnect Disconnects the current connection. Also, aborts the connection authentication process.
Events
S GetReceiveEvent Gets the event used for detection when reception of the packet is complete.
S GetSendEvent Gets the event used for detection when the sending of a packet is complete.
S GetConnectionStatusEvent Gets events that are used to detect changes in the state of the IR library.
Receive/Send
S Receive Receives data.
S Send Sends the specified data.
Status Retrieval
S GetLatestReceiveErrorResult Gets the Result of the most recent error that occurred in the receiving process.
S GetLatestSendErrorResult Gets the Result of the most recent error that occurred in the send process.
S GetConnectionStatus Gets the connection status.
S GetTryingToConnectStatus Gets the status of the connection process.
S GetReceiveSizeFreeAndUsed Returns values for available space, used space, number of available entries, and used entries in the regions used to save and manage received packets.
S GetSendSizeFreeAndUsed Returns values for available space, used space, number of available entries, and used entries in the regions for saving and managing outgoing packets.
S GetNextReceiveDataSize Returns the size of data that will be received in the next call to the Receive function.
Clear Operations
S ClearReceiveBuffer Destroys all received packets and unparsed data.
S ClearSendBuffer Destroys all packets scheduled for sending.
S DropNextReceiveData Ignore the data that is expected to come in the next call to the Receive function and move to the next set of receive data after that.
Other
S GetManagementSize Calculates the size required for the region used to manage recevied or outgoing packets.
S GetPacketSize Calculates the size required for saving one data packet in the buffer used internally by the IR library. This size is equal to the size calculated by the CalculateBufferSizeToCommunicate function plus the fixed-size header and footer.
S GetReservedSize Returns the size of the reserved region of the buffer used internally by the IR library.
S CalculateBufferSizeToCommunicate The size of buffer required in order to use the Send and Receive functions.

Revision History

2011/10/05
Changed one packet to GetManagementSize(1) to describe restrictions specific to the packet management region for each function.
2011/09/28
Added buffer size restrictions to RequireToConfirmId and WaitToConfirmId.
2011/08/30
Initial version.

CONFIDENTIAL