HTTPc_WebSockSetParam()

Owned by Former user (Deleted)
Last updated: Jan 12, 2021 by WES Admin
1 min read

Setups a parameter related to the given HTTPc WebSocket Object.

Files

http-c.h/http-c.c

Prototype

          void  HTTPc_WebSockSetParam (HTTPc_WEBSOCK_OBJ  *p_ws_obj,
                                       HTTPc_PARAM_TYPE    type,
                                       void               *p_param
                                       HTTPc_ERR          *p_err);


Arguments

p_ws_obj

Pointer to the HTTPc WebSocket Object on which to setup parameter.

type

Parameter type:

    HTTPc_PARAM_TYPE_WEBSOCK_ON_OPEN
    HTTPc_PARAM_TYPE_WEBSOCK_ON_CLOSE
    HTTPc_PARAM_TYPE_WEBSOCK_ON_MSG_RX_INIT
    HTTPc_PARAM_TYPE_WEBSOCK_ON_MSG_RX_DATA
    HTTPc_PARAM_TYPE_WEBSOCK_ON_MSG_RX_COMPLETE
    HTTPc_PARAM_TYPE_WEBSOCK_ON_ERR 
    HTTPc_PARAM_TYPE_WEBSOCK_ON_PONG
p_param

Pointer to parameter to setup.

p_err

Pointer to variable that will receive the return error code from this function:

HTTPc_ERR_NONE
HTTPc_ERR_NULL_PTR
HTTPc_ERR_INIT_NOT_COMPLETED
HTTPc_ERR_WEBSOCK_IS_USED 
HTTPc_ERR_PARAM_INVALID

Returned Values

None.

Required Configuration

None.

Notes / Warnings

  • This function MUST be called after the µC/HTTP-client Suite Initialization has been completed.