WE310F5  39.00.000
M2MB_WEBSOCKET_EVENT_INFO Struct Reference

Websocket event. Received by M2MB_WEBSOCKETC_EVENT_CB_T callback registered with m2mb_websocketc_new API. More...

#include <m2mb_websocket.h>

Data Fields

M2MB_WEBSOCKET_DATA_TYPE_E data_Type
 
const UINT8data
 
UINT32 data_Length
 
UINT32 end_Of_Message
 
M2MB_WEBSOCKET_CLOSE_STATUS_E close_Status_Code
 
const char * subprotocol
 

Detailed Description

Websocket event. Received by M2MB_WEBSOCKETC_EVENT_CB_T callback registered with m2mb_websocketc_new API.

Definition at line 134 of file m2mb_websocket.h.

Field Documentation

◆ close_Status_Code

M2MB_WEBSOCKET_CLOSE_STATUS_E close_Status_Code

Applies to CLOSE event only.

Definition at line 154 of file m2mb_websocket.h.

◆ data

const UINT8* data

For MESSAGE events contain the message or part of the message. For CLOSE events contains the close reason if specified by the peer. For PONG events contains optional pong data. Assume only valid during callback.

Definition at line 139 of file m2mb_websocket.h.

◆ data_Length

UINT32 data_Length

Length of data

Definition at line 145 of file m2mb_websocket.h.

◆ data_Type

Type of event see definition of M2MB_Websocket_Data_Type_t.

Definition at line 136 of file m2mb_websocket.h.

◆ end_Of_Message

UINT32 end_Of_Message

Applies to MESSAGE event only. Indicates if the end of the current message was reached or if there is more data to be read. Data is read in chunks of at most max_Recv_Chunk_Size (see M2MB_Websocket_Client_Config_t).

Definition at line 148 of file m2mb_websocket.h.

◆ subprotocol

const char* subprotocol

Negotiated sub-protocol. Applies to CONNECT event only. Assume only valid during callback.

Definition at line 157 of file m2mb_websocket.h.


The documentation for this struct was generated from the following file: