nn::ir::CTR::Communicator::Disconnect Member Function

Syntax

static Result Disconnect(
     void
);

Parameters

None.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.

Value Description
Result::IsSuccess Process was successful.
ResultNotConnected Neither connected nor in the process of connecting.
ResultMachineSleep Sleeping because the system is in Sleep Mode.
ResultFatalError The IR module may be malfunctioning.

Description

Disconnects the current connection or aborts the connection authentication process.

This function returns control before the disconnection process is completed.

If the system is in the connected state, a disconnection request is sent to the peer. If the system is performing the connection authentication process, that process is cancelled.

If there are unprocessed outgoing packets, these will be destroyed and the disconnection process will proceed. If this is going to be a problem, do not call this function until you have confirmed that the sending of packets has completed.

All packets that have been received before disconnection can be processed by the Receive function even after the disconnection is completed. However, note that these packets will be deleted at the start of the next connection or connection authentication process.

Revision History

2011/08/30
Initial version.

CONFIDENTIAL