nn::rdt::CTR::Receiver::Receive Member Function

Syntax

nn::Result Receive(
     void * pBuf,
     size_t * pRecvSize,
     size_t bufSize
);

Parameters

Name Description
out pBuf Takes the starting address of the buffer where the received data is written.
out pRecvSize Records the number of bytes that were read from the receive buffer. If no data was readable, this is set to 0.
in bufSize Takes the size (in bytes) of the buffer where the received data is written. If this is set to 0, the function does nothing and returns a non-error value.

Return Values

Returns the function's result. Specifically, the value of the nn::Result::IsSuccess function, ResultDoNothing, ResultNotInitialized, ResultNullPointer and ResultUntimelyFunctionCall might be returned.

Description

Reads the data that has accumulated in the receive buffer.

Reads the byte string that was sent from the Sender instance and has accumulated in the receive buffer. The obtained byte string is guaranteed to be preserved in the same order as the byte string sent by nn::rdt::Sender::Send.

Nintendo recommends calling this approximately once per game frame to improve throughput.

Revision History

2011/05/09
Added mention in the Description that the order of the sent byte string is preserved.
2010/06/14
Initial version.

CONFIDENTIAL