On Message TX Complete
Called when the message is completely transmitted. Can be also called for every pending message when a connection is close.
Prototype
void HTTPc_WebSockOnMsgTxComplete (HTTPc_CONN_OBJ *p_conn, HTTPc_WEBSOCK_MSG_OBJ *p_msg CPU_BOOLEAN status);
Arguments
p_conn
Pointer to the current HTTPc Connection Object.
p_msg
Pointer to the WebSocket Message transmitted.
status
Bool that indicate if the message has been transmitted successfully.
Return Values
None.
Required Configuration
- The HTTPc_CFG_WEBSOCKET_EN configuration macro MUST be enabled.
Notes / Warnings
- This hook is set in a HTTPc_WEBSOCK_MSG_OBJ using HTTPc_WebSockMsgSetParam() with the parameter HTTPc_PARAM_TYPE_WEBSOCK_MSG_ON_MSG_TX_COMPLETE.
- Must be set to the HTTPc_WEBSOCK_MSG_OBJ before upgrading the connection withHTTPc_WebSockSend.