1.7.3.20 SYS_WSS_PingClient Function

C

SYS_WSS_RESULT SYS_WSS_PingClient( uint8_t *data, size_t dataLen, int32_t clientIndex)

Summary

Sends a ping message to the client indicated by the parameter clientIndex.

Description

This API sends a ping message to the client indicated by the parameter clientIndex.

Precondition

The connection state of the client indicated by the clientIndex (g_wssSrvcObj.wssState) shall be SYS_WSS_STATE_CONNECTED

Parameters

ParamDescription
*dataA pointer to buffer with the data (if any).
dataLenLength of the data
clientIndexThe clientID, for identifying the client which caused the event to occur.

Returns

SYS_WSS_RESULT.

Example

SYS_WSS_RESULT res;
res =SYS_WSS_PingClient(&data, dataLen, 1);

Remarks

None.