Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 3.00.00

Setups a parameter related to the given HTTPc WebSocket Message Object.

Files

http-c.h/http-c.c

Prototype

Arguments

p_ws_obj

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

type

Parameter type:

    HTTPc_PARAM_TYPE_WEBSOCK_MSG_USER_DATA
HTTPc_PARAM_TYPE_WEBSOCK_MSG_ON_TX_INIT
HTTPc_PARAM_TYPE_WEBSOCK_MSG_ON_TX_DATA
HTTPc_PARAM_TYPE_WEBSOCK_MSG_ON_TX_COMPLETE
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_MSG_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.