tstrSocketRecvMsg Struct Reference

Data Fields
uint8 *	pu8Buffer
sint16	s16BufferSize
uint16	u16RemainingSize
struct sockaddr_in	strRemoteAddr

Detailed Description

Socket recv status.

Socket receive information is returned through this structure in response to the asynchronous call to the recv or recvfrom socket functions. This structure together with the events SOCKET_MSG_RECV or SOCKET_MSG_RECVFROM are passed-in parameters to the callback function.

Remarks

In case the received data from the remote peer is larger than the USER buffer size defined during the asynchronous call to the recv function, the data is delivered to the user in a number of consecutive chunks according to the USER Buffer size. a negative or zero buffer size indicates an error with the following code: SOCK_ERR_NO_ERROR : Socket connection closed SOCK_ERR_CONN_ABORTED : Socket connection aborted : Socket receive timed out

Field Documentation

pu8Buffer

uint8* pu8Buffer

Pointer to the USER buffer (passed to recv and recvfrom function) containing the received data chunk.

s16BufferSize

sint16 s16BufferSize

The received data chunk size. Holds a negative value if there is a receive error or ZERO on success upon reception of close socket message.

u16RemainingSize

uint16 u16RemainingSize

The number of bytes remaining in the current recv operation.

strRemoteAddr

struct sockaddr_in strRemoteAddr

Socket address structure for the remote peer. It is valid for SOCKET_MSG_RECVFROM event.