Overview

This library provides the HTTP Server implementation that can work on Infineon MCUs with Wi-Fi connectivity.It supports RESTful methods such as GET, PUT, and POST for the client to communicate with this HTTP Server library.

Features

• Supports Wi-Fi and Ethernet connections.
• Supports HTTP/1.1 protocol version.
• Secure [with TLS security] and non-secure modes of connection.
• Supports RESTful HTTP methods: GET, PUT, and POST.
• Handles various resource content types such as HTML, Plain, and JSON.
• Capable of handling content payload greater than the MTU size using the Content-Length HTTP header. This feature is supported only for CY_RAW_DYNAMIC_URL_CONTENT and CY_DYNAMIC_URL_CONTENT content types
• Supports chunked encoding for GET and POST methods.
  

  Note: For a POST request, chunked encoding is supported only for the data that is less than a single MTU; Content-Length headers are recommended for larger data.

  * Supports Server-Sent Events (SSE). SSE is a server push technology, enabling an HTTP client (for example, a browser or any device running an HTTP client) to receive automatic updates from the HTTP server via the HTTP connection.

Supported Platforms

ModusToolbox™

• PSoC™ 6 WiFi-BT Prototyping Kit (CY8CPROTO-062-4343W)
• PSoC™ 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-LAI-4373M2)
• PSoC™ 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WiFi-BT)
• CYW943907AEVAL1F evaluation kit (CYW943907AEVAL1F)
• CYW954907AEVAL1F evaluation kit (CYW954907AEVAL1F)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-MUR-43439M2)
• XMC7200D-E272K8384 kit (KIT-XMC72-EVK)
• XMC7200D-E272K8384 kit (KIT_XMC72_EVK_MUR_43439M2)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-CYW43022CUB)
• CYW955913EVK-01 Wi-Fi Bluetooth® Prototyping Kit (CYW955913EVK-01)
• PSoC™ 62S2 evaluation kit (CY8CEVAL-062S2-CYW955513SDM2WLIPA)

Supported Frameworks

• ModusToolbox™ environment: In this environment the HTTP Server Library uses the abstraction-rtos library that provides the RTOS abstraction API and uses the secure-sockets library for implementing socket functions.

Quick Start

This library is supported on ModusToolbox™ framework and below section provides information on how to build this library in ModusToolbox™ framework.

ModusToolbox™

• To use http-server library with Wi-Fi kits on FreeRTOS, lwIP, and Mbed TLS combination, the application should pull http-server library and wifi-core-freertos-lwip-mbedtls library which will internally pull secure-sockets, wifi-connection-manager, FreeRTOS, lwIP, Mbed TLS and other dependent modules. To pull wifi-core-freertos-lwip-mbedtls and http-server libraries create the following *.mtb* files in deps folder.
  • wifi-core-freertos-lwip-mbedtls.mtb: https://github.com/Infineon/wifi-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/wifi-core-freertos-lwip-mbedtls/latest-v1.X
  • http-server.mtb: https://github.com/Infineon/http-server#latest-v2.X#$$ASSET_REPO$$/http-server/latest-v2.X
• To use http-server library with Ethernet kits on FreeRTOS, lwIP, and Mbed TLS combination, the application should pull http-server library and ethernet-core-freertos-lwip-mbedtls library which will internally pull secure-sockets, ethernet-connection-manager, FreeRTOS, lwIP, Mbed TLS and other dependent modules. To pull ethernet-core-freertos-lwip-mbedtls and http-server libraries create the following *.mtb* files in deps folder.
  • ethernet-core-freertos-lwip-mbedtls.mtb: https://github.com/Infineon/ethernet-core-freertos-lwip-mbedtls#latest-v1.X#$$ASSET_REPO$$/ethernet-core-freertos-lwip-mbedtls/latest-v1.X
  • http-server.mtb: https://github.com/Infineon/http-server#latest-v2.X#$$ASSET_REPO$$/http-server/latest-v2.X
• Review and make the required changes to the pre-defined configuration files.
  • The configuration files are bundled with the wifi-core-freertos-lwip-mbedtls library for FreeRTOS, lwIP, and Mbed TLS. See README.md for more details.
  • If the application is using bundle library then the configuration files are in the bundle library. For example if the application is using Wi-Fi core freertos lwip mbedtls bundle library, the configuration files are in wifi-core-freertos-lwip-mbedtls/configs folder. Similarly if the application is using Ethernet Core FreeRTOS lwIP mbedtls library, the configuration files are in ethernet-core-freertos-lwip-mbedtls/configs folder.
• Define following COMPONENTS in the application's Makefile for the HTTP Server Library. For additional information, see the "Quick Start" section in README.md.

  COMPONENTS=FREERTOS MBEDTLS LWIP SECURE_SOCKETS

• HTTP Server Library disables all the debug log messages by default. To enable log messages, the application must perform the following:
  
  • Add ENABLE_HTTP_SERVER_LOGS macro to the DEFINES in the code example's Makefile. The Makefile entry would look like as follows:

    DEFINES+=ENABLE_HTTP_SERVER_LOGS

  • Call the cy_log_init() function provided by the cy-log module. cy-log is part of the connectivity-utilities library. See connectivity-utilities library API documentation for cy-log details.
• Define the following macro in application's Makefile to configure the maximum number of HTTP server resources to 'N':

  DEFINES+=MAX_NUMBER_OF_HTTP_SERVER_RESOURCES=<N>

• Define the following macro in application's Makefile to configure the socket receive timeout in 'N' milliseconds. Default value is set to 10ms.

  DEFINES+=HTTP_SERVER_SOCKET_RECEIVE_TIMEOUT=<N>

Code Snippets

This section provides code snippets for this library on ModusToolbox™ framework. The code snippets given under this section uses C APIs.

• ModusToolbox™ - Snippets for HTTP Server create, start, stop, and delete (C implementation).

ModusToolbox™

These code snippets demonstrate the initialization of the configuration structures required for the operation such as creating a secure or non-secure connection and registering a static or dynamic resource with the HTTP server.

Code Snippet 1: Creation and Initialization of Handle for Non-Secure HTTP Server

Creates an HTTP server handle for a non-secure HTTP connection using the cy_http_server_create API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT         80
#define MAX_SOCKETS       2
 
cy_http_server_t          httpSer_1;
cy_network_interface_t    nw_interface_1;
cy_socket_sockaddr_t      IP_address_1;
 
void snippet_http_non_secure_create(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_1.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_1.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_1.object  = (void *) &IP_address_1;
    nw_interface_1.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_1, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_1 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 2: Creation and Initialization of Handle for Secure HTTP Server

Creates an HTTP server handle for a secure HTTP connection using the cy_http_server_create API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTPS_PORT             443
#define MAX_SOCKETS            2
 
/* Configure the following credentials for a secure HTTP connection */
/* SSL server certificate */
#define SSL_SERVERCERT_PEM      \
"-----BEGIN CERTIFICATE-----\n" \
"........base64 data........\n" \
"-----END CERTIFICATE-----"
 
/* SSL server private key */
#define SSL_SERVERKEY_PEM          \
"-----BEGIN RSA PRIVATE KEY-----\n" \
"..........base64 data..........\n" \
"-----END RSA PRIVATE KEY-----"
 
cy_http_server_t          httpSer_2;
cy_network_interface_t    nw_interface_2;
cy_socket_sockaddr_t      IP_address_2;
 
void snippet_http_secure_create(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    cy_https_server_security_info_t security_cred;
 
    security_cred.certificate                = (uint8_t*) SSL_SERVERCERT_PEM;
    security_cred.certificate_length         = strlen(SSL_SERVERCERT_PEM);
    security_cred.private_key                = (uint8_t*) SSL_SERVERKEY_PEM;
    security_cred.key_length                 = strlen(SSL_SERVERKEY_PEM);
    security_cred.root_ca_certificate        = NULL;
    security_cred.root_ca_certificate_length = 0;
 
    /* IP address of the server */
    IP_address_2.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_2.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_2.object  = (void *) &IP_address_2;
    nw_interface_2.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_2, HTTPS_PORT, MAX_SOCKETS, &security_cred, &httpSer_2 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 3: Registering a Static Resource

Registers a static resource with the HTTP server using the cy_http_server_register_resource API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT            80
#define MAX_SOCKETS          2
 
/* HTML page sent in response to the client */
#define CAPTIVE_PORTAL_REDIRECT_PAGE \
"<html><head>" \
"Hello, This is a reference HTTP server application" \
"</head></html>"
 
cy_http_server_t          httpSer_3;
cy_network_interface_t    nw_interface_3;
cy_socket_sockaddr_t      IP_address_3;
 
void snippet_http_static_reg_resource(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_3.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_3.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_3.object  = (void *) &IP_address_3;
    nw_interface_3.type = CY_NW_INF_TYPE_WIFI;
    
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_3, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_3 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Register a static resource with the HTTP server */
    cy_resource_static_data_t static_resource;
    static_resource.data = CAPTIVE_PORTAL_REDIRECT_PAGE;
    static_resource.length = sizeof( CAPTIVE_PORTAL_REDIRECT_PAGE );
    TestRes = cy_http_server_register_resource( httpSer_3, (uint8_t*) "/get", (uint8_t*)"text/html", CY_STATIC_URL_CONTENT, &static_resource);
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 4: Registering a Dynamic Resource

Registers a dynamic resource with the HTTP server using the cy_http_server_register_resource API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT            80
#define MAX_SOCKETS          2
#define BUFFER_LENGTH        1500
 
/* HTML page sent in response to the client */
#define CAPTIVE_PORTAL_REDIRECT_PAGE \
"<html><head>" \
"Hello, This is a reference HTTP server application" \
"</head></html>"
 
cy_http_server_t          httpSer_4;
cy_network_interface_t    nw_interface_4;
cy_socket_sockaddr_t      IP_address_4;
static char               buffer[BUFFER_LENGTH];
static int                length = 0;
 
int32_t process_handler( const char* url_path, const char* url_parameters, cy_http_response_stream_t* stream,
                         void* arg, cy_http_message_body_t* http_message_body )
{
    memset(buffer, 0, BUFFER_LENGTH);
    memcpy( buffer, http_message_body->data, http_message_body->data_length);
    length += http_message_body->data_length;
    if (http_message_body->data_remaining == 0)
    {
        cy_http_server_response_stream_write_payload(stream, CAPTIVE_PORTAL_REDIRECT_PAGE, sizeof(CAPTIVE_PORTAL_REDIRECT_PAGE));
        length = 0;
        memset(buffer, 0, BUFFER_LENGTH);
    }
    return 0;
}
 
void snippet_http_dynamic_reg_resource(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_4.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_4.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_4.object  = (void *) &IP_address_4;
    nw_interface_4.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_4, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_4 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Register a dynamic resource with the HTTP server */
    cy_resource_dynamic_data_t dynamic_resource;
    dynamic_resource.resource_handler = process_handler;
    dynamic_resource.arg = NULL;
    TestRes = cy_http_server_register_resource( httpSer_4, (uint8_t*) "/post", (uint8_t*)"text/html", CY_DYNAMIC_URL_CONTENT, &dynamic_resource);
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 5: Registering a Server-Sent Event (SSE)

Registers a Server-Sent Event using the cy_http_server_register_resource API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT                80
#define MAX_SOCKETS              2
#define CHUNKED_CONTENT_LENGTH   0
 
cy_http_server_t               httpSer_5;
cy_network_interface_t         nw_interface_5;
cy_http_response_stream_t*     http_event_stream_5;
cy_socket_sockaddr_t           IP_address_5;
 
int32_t anycloud_process_SSE_handler( const char* url_path, const char* url_parameters,
                                      cy_http_response_stream_t* stream, void* arg,
                                      cy_http_message_body_t* http_message_body )
{
    http_event_stream_5 = stream;
    /* Enable chunked transfer encoding on the HTTP stream */
    cy_http_server_response_stream_enable_chunked_transfer( http_event_stream_5 );
    cy_http_server_response_stream_write_header( http_event_stream_5, CY_HTTP_200_TYPE, CHUNKED_CONTENT_LENGTH,
                                               CY_HTTP_CACHE_DISABLED, MIME_TYPE_TEXT_EVENT_STREAM );
    /* Disable chunked transfer encoding on the HTTP stream after header write is completed */
    cy_http_server_response_stream_disable_chunked_transfer( http_event_stream_5 );
    return 0;
}
 
void snippet_http_server_event_reg(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_5.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_5.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_5.object  = (void *) &IP_address_5;
    nw_interface_5.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_5, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_5 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    cy_resource_dynamic_data_t dynamic_sse_resource;
    dynamic_sse_resource.resource_handler = anycloud_process_SSE_handler;
    dynamic_sse_resource.arg = NULL;
    TestRes = cy_http_server_register_resource( httpSer_5, (uint8_t*) "/events", (uint8_t*)"text/event-stream", CY_RAW_DYNAMIC_URL_CONTENT, &dynamic_sse_resource);
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 6: HTTP Server Start

Starts the HTTP server using the cy_http_server_start API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT            80
#define MAX_SOCKETS          2
 
/* HTML page sent in response to the client */
#define CAPTIVE_PORTAL_REDIRECT_PAGE \
"<html><head>" \
"Hello, This is a reference HTTP server application" \
"</head></html>"
 
cy_http_server_t          httpSer_6;
cy_network_interface_t    nw_interface_6;
cy_socket_sockaddr_t      IP_address_6;
 
void snippet_http_server_start(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_6.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_6.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_6.object  = (void *) &IP_address_6;
    nw_interface_6.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_6, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_6 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Register a static resource with the HTTP server */
    cy_resource_static_data_t static_resource;
    static_resource.data = CAPTIVE_PORTAL_REDIRECT_PAGE;
    static_resource.length = sizeof( CAPTIVE_PORTAL_REDIRECT_PAGE );
    TestRes = cy_http_server_register_resource( httpSer_6, (uint8_t*) "/get", (uint8_t*)"text/html", CY_STATIC_URL_CONTENT, &static_resource );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Start HTTP server */
    TestRes = cy_http_server_start( httpSer_6 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 7: Sending HTTP Server Events

Sends HTTP server events using the cy_http_server_response_stream_write_header API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT              80
#define MAX_SOCKETS            2
 
#define SSE_PAYLOAD            "Hello, This is server sent events \r\n"
#define LFLF                   "\n\n"
#define EVENT_STREAM_DATA      "data: "
#define CHUNKED_CONTENT_LENGTH 0
 
cy_http_response_stream_t*     http_event_stream_7;
cy_http_server_t               httpSer_7;
cy_network_interface_t         nw_interface_7;
cy_socket_sockaddr_t           IP_address_7;
 
int32_t process_SSE_handler( const char* url_path, const char* url_parameters,
                                           cy_http_response_stream_t* stream, void* arg,
                                           cy_http_message_body_t* http_message_body )
{
    http_event_stream_7 = stream;
    cy_http_server_response_stream_enable_chunked_transfer( http_event_stream_7 );
    cy_http_server_response_stream_write_header( http_event_stream_7, CY_HTTP_200_TYPE, CHUNKED_CONTENT_LENGTH,
                                                 CY_HTTP_CACHE_DISABLED, MIME_TYPE_TEXT_EVENT_STREAM );
    return 0;
}
 
void send_events()
{
    cy_rslt_t result;
    if( http_event_stream_7 == NULL )
    {
        return;
    }
    result = cy_http_server_response_stream_write_payload( http_event_stream_7, (const void*)EVENT_STREAM_DATA, sizeof( EVENT_STREAM_DATA ) - 1 );
    if ( result != CY_RSLT_SUCCESS )
    {
        http_event_stream_7 = NULL;
        return;
    }
    /* Send message to client */
    result = cy_http_server_response_stream_write_payload( http_event_stream_7, SSE_PAYLOAD, sizeof(SSE_PAYLOAD) - 1);
    if ( result != CY_RSLT_SUCCESS )
    {
        http_event_stream_7 = NULL;
        return;
    }
    /* SSE is ended with two line feeds */
    result = cy_http_server_response_stream_write_payload( http_event_stream_7, (const void*)LFLF, sizeof( LFLF ) - 1 );
    if ( result != CY_RSLT_SUCCESS )
    {
        http_event_stream_7 = NULL;
        return;
    }
 
    return;
}
 
void snippet_http_server_send_events(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_7.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_7.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_7.object  = (void *) &IP_address_7;
    nw_interface_7.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_7, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_7 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    cy_resource_dynamic_data_t dynamic_sse_resource;
    dynamic_sse_resource.resource_handler = process_SSE_handler;
    dynamic_sse_resource.arg = NULL;
    TestRes = cy_http_server_register_resource( httpSer_7, (uint8_t*) "/events", (uint8_t*)"text/event-stream", CY_RAW_DYNAMIC_URL_CONTENT, &dynamic_sse_resource);
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Start HTTP server */
    TestRes = cy_http_server_start( httpSer_7 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Send server events */
    if( http_event_stream_7 != NULL )
    {
        send_events();
    }
    /* Disconnect event stream */
    TestRes = cy_http_server_response_stream_disconnect( http_event_stream_7 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Disconnect all streams */
    TestRes = cy_http_server_response_stream_disconnect_all( httpSer_7 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 8: HTTP Server Stop

Stops the HTTP server using the cy_http_server_stop API function.

#define MAKE_IPV4_ADDRESS(a, b, c, d)     ((((uint32_t) d) << 24) | \
                                          (((uint32_t) c) << 16) | \
                                          (((uint32_t) b) << 8) |\
                                          ((uint32_t) a))
 
#define SERVER_IP_ADDRESS                 MAKE_IPV4_ADDRESS(192, 168, 18, 9)
 
#define HTTP_PORT            80
#define MAX_SOCKETS          2
 
/* HTML page sent in response to the client */
#define CAPTIVE_PORTAL_REDIRECT_PAGE \
"<html><head>" \
"Hello, This is a reference HTTP server application" \
"</head></html>"
 
cy_http_server_t          httpSer_8;
cy_network_interface_t    nw_interface_8;
cy_socket_sockaddr_t      IP_address_8;
 
void snippet_http_server_stop(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    /* IP address of the server */
    IP_address_8.ip_address.ip.v4 = SERVER_IP_ADDRESS;
    IP_address_8.ip_address.version = CY_SOCKET_IP_VER_V4;
 
    /* Add the IP_address information to the network interface object */
    nw_interface_8.object  = (void *) &IP_address_8;
    nw_interface_8.type = CY_NW_INF_TYPE_WIFI;
 
    /* Initialize the network socket */
    TestRes = cy_http_server_network_init();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    TestRes = cy_http_server_create( &nw_interface_8, HTTP_PORT, MAX_SOCKETS, NULL, &httpSer_8 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Register a static resource with the HTTP server */
    cy_resource_static_data_t static_resource;
    static_resource.data = CAPTIVE_PORTAL_REDIRECT_PAGE;
    static_resource.length = sizeof( CAPTIVE_PORTAL_REDIRECT_PAGE );
    cy_http_server_register_resource( httpSer_8, (uint8_t*) "/get", (uint8_t*)"text/html", CY_STATIC_URL_CONTENT, &static_resource );
    /* Start HTTP server */
    TestRes = cy_http_server_start( httpSer_8 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Stop the HTTP server */
    TestRes = cy_http_server_stop( httpSer_8 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Delete the HTTP server object */
    TestRes = cy_http_server_delete( httpSer_8 );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
    /* Deinitialize the network socket */
    TestRes = cy_http_server_network_deinit();
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* Failure path */
    }
}

Code Snippet 9: HTTP URL query

Search a key-value pair, fetch the value of a key, and get the number of queries from the given URL using URL-processing functions.

void snippet_http_server_url_query(void)
{
    /* Status variables for various operations */
    cy_rslt_t TestRes = CY_RSLT_ERROR;
    (void)TestRes;
    const char url[] = "https://example.com/?product=shirt&color=blue&newuser&size=m\n";
    const char key[] = "product\n";
    const char value[] = "shirt\n";
    char *value_found = NULL;
    uint32_t value_length = 0;
    uint32_t query_param_count = 0;
 
    /* Check if the provided key-value pair is present in the given URL */
    TestRes = cy_http_server_match_query_parameter( url, key, value );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* URL query failed */
    }
    /* Retrieve the value and length for a given key from the URL */
    TestRes = cy_http_server_get_query_parameter_value( url, key, &value_found, &value_length );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* URL query failed */
    }
    /* Get the number of query parameters found in the URL query string. */
    TestRes = cy_http_server_get_query_parameter_count( url, &query_param_count );
    if( TestRes != CY_RSLT_SUCCESS )
    {
        /* URL query failed */
    }
}