WE310F5  39.00.000
M2MB_HTTPD_CONFIG_S Struct Reference

HTTP server configuration structure. More...

#include <m2mb_httpd.h>

Data Fields

CHAR interface_Name [8]
 
M2MB_HTTPD_MODE_E mode
 
UINT16 http_Port
 
UINT16 https_Port
 
CHAR root_Index_Page [M2MB_HTTPD_PATH_MAX]
 
CHAR root_Path [M2MB_HTTPD_PATH_MAX]
 
CHAR cert_File [M2MB_HTTPD_PATH_MAX]
 
UINT8 family
 
CHARserver_Name
 
VOID(* webfiles_Setup )(void)
 
UINT16 rxbufsize
 
UINT16 txbufsize
 
UINT8 username_auth
 
UINT8username
 
UINT8password
 

Detailed Description

HTTP server configuration structure.

Structure for storing HTTP server configuration. User will fill this structure and give as input to m2mb_httpd_init API to initialize the HTTP server.

Definition at line 176 of file m2mb_httpd.h.

Field Documentation

◆ cert_File

Server's certificate name, e.g., ca.cert.bin.

Definition at line 199 of file m2mb_httpd.h.

◆ family

UINT8 family

Run in IPv4 only (AF_INET), IPv6 only (AF_INET6), or both (AF_INET_DUAL46).

Definition at line 202 of file m2mb_httpd.h.

◆ http_Port

UINT16 http_Port

Listening port of the HTTP server. If 0, the server will listen on port 80.

Definition at line 185 of file m2mb_httpd.h.

◆ https_Port

UINT16 https_Port

Listening port of the HTTPS server. If 0, the server will listen on port 443.

Definition at line 188 of file m2mb_httpd.h.

◆ interface_Name

CHAR interface_Name[8]

Network interface to bind, e.g., wlan1. If not specified, the server will bind to every network interface.

Definition at line 178 of file m2mb_httpd.h.

◆ mode

Supports (nonsecure) HTTP only, HTTPS only, or both.

Definition at line 182 of file m2mb_httpd.h.

◆ password

UINT8* password

This is not set and username authentication is enable, default value is "admin"

Definition at line 227 of file m2mb_httpd.h.

◆ root_Index_Page

CHAR root_Index_Page[M2MB_HTTPD_PATH_MAX]

Landing page if abs_path of URI is empty, or '/'. If not specified, the default page is index.iws.

Definition at line 191 of file m2mb_httpd.h.

◆ root_Path

Root directory of the local file system where all web pages are located. If not specified, the default path is /web/.

Definition at line 195 of file m2mb_httpd.h.

◆ rxbufsize

UINT16 rxbufsize

Size in bytes of the receive buffer, if allocated. If 0, the server will use default size = 1024.

Definition at line 213 of file m2mb_httpd.h.

◆ server_Name

CHAR* server_Name

Value in the server response header field. If NULL, the default is Telit WebServer 1.0.

Definition at line 205 of file m2mb_httpd.h.

◆ txbufsize

UINT16 txbufsize

Size in bytes of the transmit buffer, if allocated. If 0, the server will use default size = 2048.

Definition at line 217 of file m2mb_httpd.h.

◆ username

UINT8* username

This is not set and username authentication is enable, default value is "admin"

Definition at line 224 of file m2mb_httpd.h.

◆ username_auth

UINT8 username_auth

Set it to 1 to enable username authentication, else set it to 0

Definition at line 221 of file m2mb_httpd.h.

◆ webfiles_Setup

VOID(* webfiles_Setup) (void)

User function to set up WEB pages stored in the Virtual File System (VFS). If the VFS is used, this function can be generated by the VFS compiler. If the VFS is not used, this field should be set to NULL.

Definition at line 208 of file m2mb_httpd.h.


The documentation for this struct was generated from the following file: