The μC/HTTPs HTTP-server module has to be configured according to specific needs. A template configuration file (http-s_cfg.h) is included in the module package (see µC/HTTPs HTTP-server Directories and Files), and this configuration should be copied into the application directory and included to the project. Here is the list of the values and description of each of the configuration variable. However, keep in mind that future releases of this module might include more configuration options.
The configurations set in the Module configuration affect all Web server instances. The following configuration values allow to reduce the memory footprint (RAM & ROM) and can impact the overall performance of all web server instances.
| Anchor |
|---|
| Argument Checking and Debug Configuration |
|---|
| Argument Checking and Debug Configuration |
|---|
|
Argument Checking and Debug ConfigurationMost functions in μC/HTTPs HTTP-server include code to validate arguments that are passed to it. Specifically, μC/TCP-IP checks to see if passed pointers are NULL, if arguments are within valid ranges, etc. The following constants configure additional argument checking.
A fair amount of code in μC/HTTPs HTTP-server has been included to simplify debugging. There are several configuration constants used to aid debugging.
...
| Panel |
|---|
| title | Table - Argument Checking and Debug Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_ARG_CHK_EXT_ |
|
...
EN | Allows code to be generated to check arguments for functions that can be called by the user and, for functions which are internal but receive arguments from an API that the user can call. |
|
...
| DEF_ENABLED or DEF_DISABLED | HTTPs_CFG_
|
|
...
...
...
| HTTP-server debug information: Internal constants assigned to global variables. |
|
...
| DEF_ENABLED or DEF_DISABLED |
|
| Anchor |
|---|
| Counter Configuration |
|---|
| Counter Configuration |
|---|
|
Counter ConfigurationμC/HTTPs HTTP-server contains code that increments counters to keep track of statistics such as the number of request received, the number of connection processed, etc. Also, μC/HTTPs HTTP-server contains counters that are incremented when error conditions are detected. The following constants enable or disable HTTP counters.
| Panel |
|---|
| title | Table - Statistics and Error Counter Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_CTR_STAT_EN
| Determines whether the code and data space used to keep track of statistics will be included. | DEF_ENABLED or DEF_DISABLED | HTTPs_CFG_CTR_
|
|
STAT_EN determines ERR_EN
| Determines whether the code and data space used to keep track of |
|
statistics . . | DEF_ENABLED or DEF_DISABLED |
|
File System Configuration
| Anchor |
|---|
| File System Configuration |
|---|
| File System Configuration |
|---|
|
µC/HTTP-server can be used with or without a File System. See section Interface with File System for more details on the File System with the HTTP server.
| Panel |
|---|
| title | Table - File System Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_ |
|
CTRSTAT_EN can be set to either PRESENT_EN | Determines whether or not a File System is present and must be used with HTTP server. | DEF_DISABLED or DEF_ENABLED |
|
| Anchor |
|---|
| Persistent Connection Configuration |
|---|
| Persistent Connection Configuration |
|---|
|
Persistent Connection ConfigurationµC/HTTP-server supports persistent connection when HTTP protocol version 1.1 is used.
The configuration related to Persistent Connection must also be enabled in the run-time configuration of each server instance for which this feature is wished. See section Parameters Configuration for more details.
See section Persistent Connection for more details on HTTP Persistent Connection.
| Panel |
|---|
| title | Table - Persistent Connection Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_ |
|
CTRERRHTTPs_CFG_CTR_ERR_EN determines | Determines whether the code and data |
|
space keep track of errors | support the persistent connection feature will be included. |
|
HTTPs_CFG_CTR_ERR_EN can be set to either | DEF_DISABLED or DEF_ENABLED |
|
.Dynamic Content Configuration
A considerable amount of code in μC/HTTPs has been included to parse, replace and transmit html document with dynamic content.| Anchor |
|---|
| Header Field Configuration |
|---|
| Header Field Configuration |
|---|
|
Header Field ConfigurationμC/HTTP-server contains code that allow the upper application to receive header field received in the request message and add header field to be transmitted with the response message.
The header parameters must also be defined in the run-time configuration of each server instance for which this feature is wished. See section Parameters Configuration and HTTP Header Configurationfor more details.
See section Headers for more details on HTTP header fields concept.
| Panel |
|---|
| title | Panel - Header Field Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_
|
|
TOKENPARSERX_EN
| Determines whether the code and data space used to support additional header field in request will be included. | DEF_ENABLED or DEF_DISABLED | HTTPs_CFG_ |
|
TOKENPARSE_EN determines TX_EN | Determines whether the code and data space used to support additional header field in response will be included. | DEF_ENABLED or DEF_DISABLED |
|
Query String Configuration
| Anchor |
|---|
| Query String Configuration |
|---|
| Query String Configuration |
|---|
|
μC/HTTP-server contains code to allow the parsing and saving of the tokens found in HTML files for dynamic content will be included. Query String received in HTTP requests.
To enable this feature for a specific server instance, the parameter associated with the Query String must also be enabled in the the run-time configuration of the instance. See section Parameters Configuration and Query String Configuration for more details on the configuration.
See section Query String for additional details on the HTTP Query String concept.
| Panel |
|---|
| title | Table - Query String Configuration |
|---|
|
| Constant | Description | Possibles Values |
|---|
HTTPs_CFG_ |
|
TOKENPARSE_EN can be set to either DEF_DISABLED or DEF_ENABLED.If the server does not host dynamic content, the feature should be disabled in order to speed up processing.
CGI / STR_EN | Determines whether the code and data space used to support Query String in HTTP request will be included. | DEF_ENABLED or DEF_DISABLED |
|
| Anchor |
|---|
| Form Submission Configuration |
|---|
| Form Submission Configuration |
|---|
|
Form Submission ConfigurationµC/HTTPs allows to use forms in HTML documents HTTP-server can support the reception of HTML forms using the HTTP POST method. µC/HTTPs HTTP-server is designed to manage different type of form encoding and also to upload files from an HTML form.
To enable this feature for a specific server instance, the parameter associated with the Form feature must also be enabled in the the run-time configuration of the instance. See section Parameters Configuration and HTTP Form Configuration for more details on the configuration.
See section Form for additional details on the HTML Form concept.
| Panel |
|---|
| title | Table - Form HandlingConfiguration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_
|
|
CGIHTTPs_CFG_CGI_EN determines | Determines whether the code and data space used to support forms submission will be included |
|
. HTTPs_CFG_CGI_EN can be set to either DEF_DISABLED or DEF_ENABLED| If the server does not host form, this feature should be disabled in order to speed up processing. |
|
| If this feature is set as disabled all other |
|
CGI | Form's configurations are automatically disabled. |
|
HTTPs_CFG_POLL_ENHTTPs_CFG_CGI_POLL_EN determines whether the code and data space used to support hook function to poll the upper application will be called to know the end of form processing. HTTPs_CFG_CGI_POLL_EN can be set to either DEF_DISABLED or DEF_ENABLED.
Note that all hook functions must be non-blocking, if the processing of forms can take a while, poll hook function should be use and implemented to avoid the CGI submit hook function to take a long time to return.DEF_ENABLED or DEF_DISABLED | HTTPs_CFG_FORM_MULTIPART_EN
|
|
HTTPs_CFG_CGI_MULTIPART_EN determines | Determines whether the code and data space used to support forms submission with “multipart/form-data” encoding will be included. |
|
HTTPs_CFG_CGI_MULTIPART_EN can be set to either DISABLEDENABLED.HTTPs_CFG_CGI_FILE_UPLOAD_EN
HTTPs_CFG_CGI_FILE_UPLOAD_EN determines whether the code and data space used to support file uploading will be included. HTTPs_CFG_CGI_FILE_UPLOAD_EN can be set to either DEF_DISABLED or DEF_ENABLED.
Note that file upload is only supported using “multipart/form-data” encoding.
μC/HTTPs contains code that allow the upper application to receive header field received in the request message and add header field to be transmitted with the response message.
HTTPs_CFG_CGI_HDR_EN
HTTPs_CFG_HDR_EN determines
| Anchor |
|---|
| Token Replacement Configuration |
|---|
| Token Replacement Configuration |
|---|
|
Token Replacement ConfigurationA considerable amount of code in μC/HTTP-server has been included to parse, replace and transmit HTML document with dynamic content using token replacement and the HTTP Chunked Transfer encoding.
To enable this feature for a specific server instance, the parameter associated with the Token feature must also be enabled in the the run-time configuration of the instance. See section Parameters Configuration and Token Configuration for more details on the configuration.
See section Dynamic Content for additional details on the HTTP concepts behind dynamic content.
| Panel |
|---|
| title | Table - Dynamic Content Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_TOKEN_PARSE_EN
| Determines whether the code and data space used to support |
|
header field from request and response. HTTPs_CFG_HDR_EN can be set to either the parsing of the tokens found in HTML files for dynamic content will be included. If the server does not host dynamic content, the feature should be disabled in order to speed up processing. | DEF_DISABLED or DEF_ENABLED |
|
| Anchor |
|---|
| Proxy Configuration |
|---|
| Proxy Configuration |
|---|
|
Proxy Configuration
µC/HTTPs HTTP-server can be accessed even if it’s located behind a proxy.
| Panel |
|---|
| title | Table - Proxy Configuration |
|---|
|
| Constant | Description | Possible Values |
|---|
HTTPs_CFG_ABSOLUTE_URI_EN
|
|
HTTPs_CFG_ABSOLUTE_URI_EN determines Determines whether the code and data space used to support header field for absolute URI. |
|
HTTPs_CFG_ABSOLUTE_URI_EN can be set to either DISABLEDENABLED.