Receive application data via socket, with error handling. See section NetSock_RxData() for more information.
Files
net_app.h/net_app.c
Prototype
Arguments
sock_id
This is the socket ID returned by NetApp_SockOpen()/ NetSock_Open()/socket() when the socket was created or by NetApp_SockAccept()/NetSock_Accept()/accept() when a connection was accepted.
p_data_buf
Pointer to the application memory buffer to receive data.
data_buf_len
Size of the destination application memory buffer (in bytes).
data_rx_th
Application data receive threshold:
0, no minimum receive threshold; i.e. receive any amount of data. Recommended for datagram sockets;
Minimum amount of application data to receive (in bytes) within maximum number of retries, otherwise.
flags
Flag to select receive options; bit-field flags logically OR’d:
NET_SOCK_FLAG_NONE/0
No socket flags selected
NET_SOCK_FLAG_RX_DATA_PEEK/MSG_PEEK
Receive socket data without consuming it
NET_SOCK_FLAG_RX_NO_BLOCK/MSG_DONTWAIT
Receive socket data without blocking
In most cases, this flag would be set to NET_SOCK_FLAG_NONE/0.
p_addr_remote
Pointer to a socket address structure (see section Network Sockets Concepts) to return the remote host address that sent the received data.
p_addr_len
Pointer to the size of the socket address structure which must be passed the size of the socket address structure [e.g., sizeof(NET_SOCK_ADDR_IPv4)]. Returns size of the accepted connection’s socket address structure, if no errors; returns 0, otherwise.
retry_max
Maximum number of consecutive socket receive retries.
timeout_ms
Socket receive timeout value per attempt/retry.
time_dly_ms
Socket receive delay value, in milliseconds.
p_err
Pointer to variable that will receive the error code from this function:
NET_APP_ERR_NONENET_APP_ERR_INVALID_ARGNET_APP_ERR_INVALID_OPNET_APP_ERR_FAULTNET_APP_ERR_FAULT_TRANSITORYNET_APP_ERR_CONN_CLOSEDNET_APP_ERR_DATA_BUF_OVFNET_ERR_RX
Returned Value
Number of data bytes received, if no errors.
0, otherwise.
Required Configuration
None.
Notes / Warnings
Some socket arguments and/or operations are validated only if validation code is enabled (see section Argument Check Configuration).
If a non-zero number of retries is requested (retry_max) and socket blocking is configured for non-blocking operation; then a non-zero timeout (timeout_ms) and/or a non-zero time delay (time_dly_ms) should also be requested. Otherwise, all retries will most likely fail immediately since no time will elapse to wait for and allow socket operations to successfully complete.