Hook Functions 1
µC/HTTP-client provides a set of hook functions to be notify and to customize the stack behavior for your application needs. Those are only available when the µC/HTTP-client internal task is active (HTTPc_CFG_MODE_ASYNC_TASK_EN
). Here a list of description for the different hooks type:
Hook Type | Description | Structure name | SetParam function | Must be set before calling |
---|---|---|---|---|
Connection Hooks | Notify event about the connection status | HTTPc_CONN_OBJ | HTTPc_ConnSetParam() | HTTPc_ConnOpen() |
Request Hooks | Notify event that happen during a HTTP request and allows the application to customize it. | HTTPc_REQ_OBJ | HTTPc_ReqSetParam() | HTTPc_ReqSend() |
Hook Functions WebSocket | Notify event that happen after a WebSocket Upgrade is successful and gives access to the application to the messages when received. | HTTPc_WEBSOCK_OBJ | HTTPc_WebSockSetParam() | |
WebSocket Message Hooks | Notify event that happen during a WebSocket Message transmission allows the application to customize it. | HTTPc_WEBSOCK_MSG_OBJ | HTTPc_WebSockMsgSetParam() | HTTPc_WebSockSend() |
µC/HTTP-client provides a set of hook functions to be notify and to customize the stack behavior for your application needs. Those are only available when the µC/HTTP-client internal task is active (HTTPc_CFG_MODE_ASYNC_TASK_EN
). Here a list of description for the different hooks type:
Hook Type | Description | Structure name | SetParam function | Must be set before calling |
---|---|---|---|---|
Connection Hooks | Notify event about the connection status | HTTPc_CONN_OBJ | HTTPc_ConnSetParam() | HTTPc_ConnOpen() |
Request Hooks | Notify event that happen during a HTTP request and allows the application to customize it. | HTTPc_REQ_OBJ | HTTPc_ReqSetParam() | HTTPc_ReqSend() |
Hook Functions WebSocket | Notify event that happen after a WebSocket Upgrade is successful and gives access to the application to the messages when received. | HTTPc_WEBSOCK_OBJ | HTTPc_WebSockSetParam() | |
WebSocket Message Hooks | Notify event that happen during a WebSocket Message transmission allows the application to customize it. | HTTPc_WEBSOCK_MSG_OBJ | HTTPc_WebSockMsgSetParam() | HTTPc_WebSockSend() |