nn::uds::CTR::ReceiveFrom Function

Syntax

nn::Result ReceiveFrom(
     const EndpointDescriptor & endpointDesc,
     void * pBuffer,
     size_t * pReceivedSize,
     u16 * pSrcNodeId,
     size_t bufferSize,
     bit8 option = 0x00
);

Arguments

Name Description
in endpointDesc Descriptor indicating the endpoint to use. The port and sending source must be attached in advance using the Attach function.
out pBuffer Received data storage location. Specify a buffer aligned to 4 bytes.
out pReceivedSize Size of the received data. The UDS maximum received data size is UDS_PACKET_PAYLOAD_MAX_SIZE bytes.
out pSrcNodeId Sending source node ID.
in bufferSize Size of the receive buffer (pBuffer).
in option Receive options. Specifying NO_WAIT here will cause the function to return immediately, even if no data has been received. If not specified, the function will not return until either it receives data or an error occurs.

Return Values

Returns the function's execution result.

Description

Receives data. (It is possible to get the address of the sender.)

Revision History

2010/09/24
Noted that the buffer specified for pBuffer must be 4-byte aligned.
2010/06/14
Initial version.

CONFIDENTIAL