On Connection Connect

Called after a connection connect tryout with the remote HTTP server.

Like for every hook functions, it's only available when the µC/HTTP-client internal task is active (HTTPc_CFG_MODE_ASYNC_TASK_EN). This hook function can be set up with the API function HTTPc_ConnSetParam() with parameter type HTTPc_PARAM_TYPE_CONN_CONNECT_CALLBACK. This hook is mandatory when the API function HTTPc_ConnOpen() is called in no-blocking mode.

Prototype

          void  HTTPc_ConnConnectHook (HTTPc_CONN_OBJ  *p_conn_obj,
                                       CPU_BOOLEAN      open_status);

Arguments

p_conn

Pointer to the current HTTPc Connection Object.

open_status

Status of the connection:

DEF_OK,      if the connection with the server was successful.

DEF_FAIL, otherwise.

Return Values

None.

Required Configuration

The HTTPc Internal Task must be active. See the section Task Configuration in the Compile-Time Configuration page.

Notes / Warnings

None.

Example Template

static  void  HTTPc_ConnConnectHook (HTTPc_CONN_OBJ  *p_conn,
                                     CPU_BOOLEAN      open_status)
{
    if (open_status == DEF_OK) {
        printf("Connection to server succeeded.\n\r");
    } else {
        printf("Connection to server failed.\n\r");
    }
}