m2mb_websocket.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* Global declarations ==========================================================================*/
#ifndef M2MB_WEBSOCKET_H
#define M2MB_WEBSOCKET_H

/*-----------------------------------------------------------------------------------------------*/

#define WEBSOCKETC_MAX_CLIENTS (4)              
#define WEBSOCKET_MAX_SUBPROTOCOLS (4)  
/* Global typedefs ==============================================================================*/

typedef enum {
        M2MB_WEBSOCKET_STATE_INITIAL_E          = 0, 
        M2MB_WEBSOCKET_STATE_CONNECTING_E       = 1, 
        M2MB_WEBSOCKET_STATE_OPEN_E             = 2, 
        M2MB_WEBSOCKET_STATE_CLOSING_E          = 3, 
        M2MB_WEBSOCKET_STATE_CLOSED_E           = 4, 
} M2MB_WEBSOCKET_STATE_E;

typedef enum {
        M2MB_WEBSOCKET_OPTION_STATE             = 1, 
        M2MB_WEBSOCKET_OPTION_ERRNO             = 2, 
        M2MB_WEBSOCKET_OPTION_SOCKET_ERRNO      = 3, 
        M2MB_WEBSOCKET_OPTION_SSL_ERRNO         = 4, 
        M2MB_WEBSOCKET_OPTION_NUM_RX_BYTES      = 5, 
        M2MB_WEBSOCKET_OPTION_NUM_TX_BYTES      = 6, 
        M2MB_WEBSOCKET_OPTION_NUM_RX_PINGS      = 7, 
        M2MB_WEBSOCKET_OPTION_NUM_TX_PINGS      = 8, 
        M2MB_WEBSOCKET_OPTION_NUM_RX_PONGS      = 9, 
        M2MB_WEBSOCKET_OPTION_NUM_TX_PONGS      = 10 
} M2MB_WEBSOCKET_OPTION_E;

typedef enum {
        M2MB_WEBSOCKET_DATA_TYPE_TEXT_E         = 1, 
        M2MB_WEBSOCKET_DATA_TYPE_BINARY_E       = 2 
} M2MB_WEBSOCKET_DATA_TYPE_E;

typedef enum {
        M2MB_WEBSOCKET_EVENT_CONNECT_E          = 1, 
        M2MB_WEBSOCKET_EVENT_MESSAGE_E          = 2, 
        M2MB_WEBSOCKET_EVENT_PONG_E             = 3, 
        M2MB_WEBSOCKET_EVENT_CLOSE_E            = 4 
} M2MB_WEBSOCKET_EVENT_E;

typedef enum {
        M2MB_WEBSOCKET_CLOSE_STATUS_NORMAL                                                      = 1000, 
        M2MB_WEBSOCKET_CLOSE_STATUS_GOING_AWAY                                          = 1001, 
        M2MB_WEBSOCKET_CLOSE_STATUS_PROTOCOL_ERROR                                      = 1002, 
        M2MB_WEBSOCKET_CLOSE_STATUS_UNSUPPORTED_MESSAGE_TYPE            = 1003, 
        M2MB_WEBSOCKET_CLOSE_STATUS_NO_STATUS_RECEIVED                          = 1005, 
        M2MB_WEBSOCKET_CLOSE_STATUS_ABNORMAL_CLOSURE                            = 1006, 
        M2MB_WEBSOCKET_CLOSE_STATUS_DATA_DOES_NOT_MATCH_MESSAGE_TYPE= 1007, 
        M2MB_WEBSOCKET_CLOSE_STATUS_POLICY_VIOLATION                            = 1008, 
        M2MB_WEBSOCKET_CLOSE_STATUS_MESSAGE_TOO_BIG                             = 1009, 
        M2MB_WEBSOCKET_CLOSE_STATUS_EXPECTED_EXTENSION                          = 1010, 
        M2MB_WEBSOCKET_CLOSE_STATUS_UNEXPECTED_CONDITION                        = 1011 
} M2MB_WEBSOCKET_CLOSE_STATUS_E;

typedef UINT32 M2MB_WEBSOCKET_HANDLE_T;

 typedef struct M2MB_WEBSOCKET_CTX{
        M2MB_WEBSOCKET_HANDLE_T handle;
        BOOLEAN echo_mode;
} M2MB_WEBSOCKET_CTX_T;

typedef struct M2MB_WEBSOCKET_EVENT_INFO
{
        M2MB_WEBSOCKET_DATA_TYPE_E data_Type;
        const UINT8 *data;
        UINT32 data_Length;
        UINT32 end_Of_Message;
        M2MB_WEBSOCKET_CLOSE_STATUS_E close_Status_Code;
        const char *subprotocol;
} M2MB_WEBSOCKET_EVENT_INFO_T;

typedef void (* M2MB_WEBSOCKETC_EVENT_CB_T)(
        M2MB_WEBSOCKET_HANDLE_T handle,
    void * arg,
        M2MB_WEBSOCKET_EVENT_E event,
        M2MB_WEBSOCKET_EVENT_INFO_T *event_Info
    );
typedef UINT32 M2MB_SSL_OBJ_HDL_T;
typedef struct M2MB_WEBSOCKET_OPEN_PARAMS
{
        const char *origin;
        char **subprotocol_List;
        UINT32 subprotocol_List_Length;
        M2MB_SSL_CTXT_HANDLE sslhandle;
        UINT32 max_Recv_Chunk_Size;
        UINT32 handshake_Timeout_Millseconds;
        UINT32 closing_Timeout_Millseconds;
        M2MB_WEBSOCKETC_EVENT_CB_T *pUsercb;
} M2MB_WEBSOCKET_OPEN_PARAMS_T;
typedef enum 
{
        M2MB_WEBSOCKET_CONF_ECHOMODE,
        M2MB_WEBSOCKET_CONF_HTTPHEADERS_ADD,
        M2MB_WEBSOCKET_CONF_HTTPHEADERS_CLEAR
} M2MB_WEBSOCKET_CONF_ID_E;

typedef union M2MB_WEBSOCKET_CONF_PARAMS
{
        BOOLEAN echo_mode;
        struct {
                char *hdr1, *hdr2;
                }httpheaders;
} M2MB_WEBSOCKET_CFG_PARAMS_T;
/* Global variables =============================================================================*/

/* Global functions =============================================================================*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_open(M2MB_WEBSOCKET_CTX_T **pCtx,
                M2MB_WEBSOCKET_OPEN_PARAMS_T *pParams);


/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_close( M2MB_WEBSOCKET_CTX_T *pCtx) ;
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_connect( M2MB_WEBSOCKET_CTX_T *pCtx, 
        INT8 *p_server, UINT16 port,  char *pResource_path ) ;

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_cfg( M2MB_WEBSOCKET_CTX_T *pCtx, 
        M2MB_WEBSOCKET_CONF_ID_E confid, M2MB_WEBSOCKET_CFG_PARAMS_T *cfg)  ;
/*-----------------------------------------------------------------------------------------------*/
int m2mb_websocket_send(M2MB_WEBSOCKET_CTX_T *pCtx, char *pMsg, UINT32 msglen,
        M2MB_WEBSOCKET_DATA_TYPE_E datatype, UINT8 end_of_message) ;
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_ping( M2MB_WEBSOCKET_CTX_T *pCtx, char *pPing_data,
        UINT32 ping_data_length) ;
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_pong( M2MB_WEBSOCKET_CTX_T *pCtx, char *pPong_data,
        UINT32 pong_data_length);
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_websocket_get_opt(M2MB_WEBSOCKET_CTX_T *pCtx, 
        M2MB_WEBSOCKET_OPTION_E opt, void *opt_Value, UINT32 *opt_Length);

#endif /* M2MB_WEBSOCKET_H */