Mistake on this page?
Report an issue in GitHub or email us
Macros
httpd_opts.h File Reference

HTTP server options list. More...

#include "lwip/opt.h"
#include "lwip/prot/iana.h"

Go to the source code of this file.

Macros

#define LWIP_HTTPD_CGI   0
 Set this to 1 to support CGI (old style). More...
 
#define LWIP_HTTPD_CGI_SSI   0
 Set this to 1 to support CGI (new style). More...
 
#define LWIP_HTTPD_SSI   0
 Set this to 1 to support SSI (Server-Side-Includes) More...
 
#define LWIP_HTTPD_SSI_RAW   0
 Set this to 1 to implement an SSI tag handler callback that gets a const char* to the tag (instead of an index into a pre-registered array of known tags) If this is 0, the SSI handler callback function is only called pre-registered tags. More...
 
#define LWIP_HTTPD_SSI_BY_FILE_EXTENSION   1
 Set this to 0 to prevent parsing the file extension at runtime to decide if a file should be scanned for SSI tags or not. More...
 
#define LWIP_HTTPD_SUPPORT_POST   0
 Set this to 1 to support HTTP POST. More...
 
#define LWIP_HTTPD_SSI_MULTIPART   0
 LWIP_HTTPD_SSI_MULTIPART==1: SSI handler function is called with 2 more arguments indicating a counter for insert string that are too long to be inserted at once: the SSI handler function must then set 'next_tag_part' which will be passed back to it in the next call. More...
 
#define HTTPD_SERVER_AGENT   "lwIP/" LWIP_VERSION_STRING " (http://savannah.nongnu.org/projects/lwip)"
 This string is passed in the HTTP header as "Server: ". More...
 
#define LWIP_HTTPD_DYNAMIC_HEADERS   0
 Set this to 1 if you want to include code that creates HTTP headers at runtime. More...
 
#define HTTPD_USE_MEM_POOL   0
 Set this to 1 to use a memp pool for allocating struct http_state instead of the heap. More...
 
#define HTTPD_SERVER_PORT   LWIP_IANA_PORT_HTTP
 The server port for HTTPD to use. More...
 
#define HTTPD_SERVER_PORT_HTTPS   LWIP_IANA_PORT_HTTPS
 The https server port for HTTPD to use. More...
 
#define HTTPD_ENABLE_HTTPS   0
 Enable https support? More...
 
#define HTTPD_MAX_RETRIES   4
 Maximum retries before the connection is aborted/closed. More...
 
#define HTTPD_POLL_INTERVAL   4
 The poll delay is X*500ms. More...
 
#define HTTPD_TCP_PRIO   TCP_PRIO_MIN
 Priority for tcp pcbs created by HTTPD (very low by default). More...
 
#define LWIP_HTTPD_TIMING   0
 Set this to 1 to enable timing each file sent. More...
 
#define HTTPD_DEBUG_TIMING   LWIP_DBG_OFF
 Set this to 1 to enable timing each file sent. More...
 
#define LWIP_HTTPD_SUPPORT_EXTSTATUS   0
 Set this to one to show error pages when parsing a request fails instead of simply closing the connection. More...
 
#define LWIP_HTTPD_SUPPORT_V09   1
 Set this to 0 to drop support for HTTP/0.9 clients (to save some bytes) More...
 
#define LWIP_HTTPD_SUPPORT_11_KEEPALIVE   0
 Set this to 1 to enable HTTP/1.1 persistent connections. More...
 
#define LWIP_HTTPD_SUPPORT_REQUESTLIST   1
 Set this to 1 to support HTTP request coming in in multiple packets/pbufs. More...
 
#define LWIP_HTTPD_REQ_QUEUELEN   5
 Number of rx pbufs to enqueue to parse an incoming request (up to the first newline) More...
 
#define LWIP_HTTPD_REQ_BUFSIZE   LWIP_HTTPD_MAX_REQ_LENGTH
 Number of (TCP payload-) bytes (in pbufs) to enqueue to parse and incoming request (up to the first double-newline) More...
 
#define LWIP_HTTPD_MAX_REQ_LENGTH   LWIP_MIN(1023, (LWIP_HTTPD_REQ_QUEUELEN * PBUF_POOL_BUFSIZE))
 Defines the maximum length of a HTTP request line (up to the first CRLF, copied from pbuf into this a global buffer when pbuf- or packet-queues are received - otherwise the input pbuf is used directly) More...
 
#define LWIP_HTTPD_MAX_REQUEST_URI_LEN   63
 This is the size of a static buffer used when URIs end with '/'. More...
 
#define LWIP_HTTPD_POST_MAX_RESPONSE_URI_LEN   63
 Maximum length of the filename to send as response to a POST request, filled in by the application when a POST is finished. More...
 
#define LWIP_HTTPD_SSI_INCLUDE_TAG   1
 Set this to 0 to not send the SSI tag (default is on, so the tag will be sent in the HTML page. More...
 
#define LWIP_HTTPD_ABORT_ON_CLOSE_MEM_ERROR   0
 Set this to 1 to call tcp_abort when tcp_close fails with memory error. More...
 
#define LWIP_HTTPD_KILL_OLD_ON_CONNECTIONS_EXCEEDED   0
 Set this to 1 to kill the oldest connection when running out of memory for 'struct http_state' or 'struct http_ssi_state'. More...
 
#define LWIP_HTTPD_OMIT_HEADER_FOR_EXTENSIONLESS_URI   0
 Set this to 1 to send URIs without extension without headers (who uses this at all??) More...
 
#define HTTP_IS_TAG_VOLATILE(ptr)   TCP_WRITE_FLAG_COPY
 Default: Tags are sent from struct http_state and are therefore volatile. More...
 
#define LWIP_HTTPD_CUSTOM_FILES   0
 Set this to 1 and provide the functions: More...
 
#define LWIP_HTTPD_DYNAMIC_FILE_READ   0
 Set this to 1 to support fs_read() to dynamically read file data. More...
 
#define LWIP_HTTPD_FILE_STATE   0
 Set this to 1 to include an application state argument per file that is opened. More...
 
#define HTTPD_PRECALCULATED_CHECKSUM   0
 HTTPD_PRECALCULATED_CHECKSUM==1: include precompiled checksums for predefined (MSS-sized) chunks of the files to prevent having to calculate the checksums at runtime. More...
 
#define LWIP_HTTPD_FS_ASYNC_READ   0
 LWIP_HTTPD_FS_ASYNC_READ==1: support asynchronous read operations (fs_read_async returns FS_READ_DELAYED and calls a callback when finished). More...
 
#define HTTPD_FSDATA_FILE   "fsdata.c"
 Filename (including path) to use as FS data file. More...
 

Detailed Description

HTTP server options list.

Definition in file httpd_opts.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.