nn::ir::CTR::Communicator::RequireConnection Member Functionstatic Result RequireConnection();
None.
Result values listed below.| Value | Description |
|---|---|
Result::IsSuccess |
Process was successful. |
ResultBufferInsufficient |
The buffer was insufficient so the connection process could not proceed. |
ResultAlreadyConnected |
Already in the connected state. |
ResultAlreadyTryingToConnect |
In the process of connecting. |
ResultMachineSleep |
Sleeping because the system is in Sleep Mode. |
ResultFatalError |
The IR module may be malfunctioning. |
Sends a connection request to the partner CTR and tries to make an authenticated connection.
This function returns control before connection authentication with the partner is completed.
When a connection request is sent, this function waits for a connection reply from the partner and then, when the reply is received, transitions to the connected state.
This function will continue to wait until a connection reply comes, so if you want to abort the process call the Disconnect function.
If the connection succeeds, this is signaled by the event returned by the GetConnectionStatusEvent function.
The system always waits after connection authentication. If data have been provided by the Send function, the system sends the data packets after it has received all incoming data and then waits again.
If the size of the region used to save incoming and outgoing packets—as passed to the Initialize function—is smaller than that defined by NECESSARY_BUFFER_SIZE_FOR_CONNECTION or if the size of the region used to manage packets is smaller than GetManagementSize(1), the connection cannot be authenticated and this function fails.
CONFIDENTIAL