Jump to main content

##

# 1.2.1.12.2 Library Interface

Name | Description
--- | ---
Macros |
TCPIP_STACK_USE_BASE64_DECODE | Authentication requires Base64 decoding Enable basic authentication support
HTTP_CONFIG_H | This is macro HTTP_CONFIG_H.
TCPIP_HTTP_CACHE_LEN | Max lifetime (sec) of static responses as string
TCPIP_HTTP_CONFIG_FLAGS | Define the HTTP module configuration flags Use 0 for default See HTTP_MODULE_FLAGS definition for possible values
TCPIP_HTTP_DEFAULT_FILE | Indicate what HTTP file to serve when no specific one is requested
TCPIP_HTTP_DEFAULT_LEN | For buffer overrun protection. Set to longest length of above two strings.
TCPIP_HTTP_FILE_UPLOAD_ENABLE | Configure MPFS over HTTP updating Comment this line to disable updating via HTTP
TCPIP_HTTP_FILE_UPLOAD_NAME | This is macro TCPIP_HTTP_FILE_UPLOAD_NAME.
TCPIP_HTTP_MAX_CONNECTIONS | Maximum numbers of simultaneous supported HTTP connections.
TCPIP_HTTP_MAX_DATA_LEN | Define the maximum data length for reading cookie and GET/POST arguments (bytes)
TCPIP_HTTP_MAX_HEADER_LEN | Set to length of longest string above
TCPIP_HTTP_MIN_CALLBACK_FREE | Define the minimum number of bytes free in the TX FIFO before executing callbacks
TCPIP_HTTP_NO_AUTH_WITHOUT_SSL | Uncomment to require secure connection before requesting a password
TCPIP_HTTP_SKT_RX_BUFF_SIZE | Define the size of the RX buffer for the HTTP socket Use 0 for default TCP socket value The default recommended value for high throughput is > 2MSS (3 KB). The performance of a socket is highly dependent on the size of its buffers so it's a good idea to use as large as possible buffers for the sockets that need high throughput.
TCPIP_HTTP_SKT_TX_BUFF_SIZE | Define the size of the TX buffer for the HTTP socket Use 0 for default TCP socket value The default recommended value for high throughput is > 2MSS (3 KB). The performance of a socket is highly dependent on the size of its buffers so it's a good idea to use as large as possible buffers for the sockets that need high throughput.
TCPIP_HTTP_TASK_RATE | The HTTP task rate, ms The default value is 33 milliseconds. The lower the rate (higher the frequency) the higher the module priority and higher module performance can be obtained The value cannot be lower than the TCPIP_STACK_TICK_RATE.
TCPIP_HTTP_TIMEOUT | Max time (sec) to await more data before timing out and disconnecting the socket
TCPIP_HTTP_USE_AUTHENTICATION | Enable basic authentication support
TCPIP_HTTP_USE_COOKIES | Enable cookie support
TCPIP_HTTP_USE_POST | Define which HTTP modules to use If not using a specific module, comment it to save resources Enable POST support
TCPIP_HTTP_FREE_FUNC | HTTP corresponding deallocation function, free style This is the function the HTTP will call for freeing the allocated memory Use standard C library 'free' or 0 as a default If it's 0, HTTP will use the allocation functions passed in at the stack initialization
TCPIP_HTTP_MALLOC_FUNC | HTTP allocation function, malloc style This is the function the HTTP will call to allocate memory needed for file uploads. Use standard C library 'malloc' or 0 as a default If it's 0, HTTP will use the allocation functions passed in at the stack initialization
Functions |
TCPIP_HTTP_ArgGet | Locates a form field value in a given data array.
TCPIP_HTTP_FileInclude | Writes a file byte-for-byte to the currently loaded TCP socket.
TCPIP_HTTP_PostNameRead | Reads a name from a URL encoded string in the TCP buffer.
TCPIP_HTTP_PostValueRead | Reads a value from a URL encoded string in the TCP buffer.
TCPIP_HTTP_URLDecode | Parses a string from URL encoding to plain-text.
TCPIP_HTTP_CurrentConnectionByteCountDec | Decrements the connection byte count.
TCPIP_HTTP_CurrentConnectionByteCountGet | Returns how many bytes are available to be read.
TCPIP_HTTP_CurrentConnectionByteCountSet | Sets how many bytes are available to be read.
TCPIP_HTTP_CurrentConnectionCallbackPosGet | Returns the callback position indicator.
TCPIP_HTTP_CurrentConnectionCallbackPosSet | Sets the callback position indicator.
TCPIP_HTTP_CurrentConnectionDataBufferGet | Returns pointer to connection general purpose data buffer.
TCPIP_HTTP_CurrentConnectionFileGet | Get handle to current connection's file.
TCPIP_HTTP_CurrentConnectionPostSmGet | Get the POST state machine state.
TCPIP_HTTP_CurrentConnectionSocketGet | Get the socket for the current connection.
TCPIP_HTTP_CurrentConnectionStatusSet | Sets HTTP status.
TCPIP_HTTP_CurrentConnectionIsAuthorizedGet | Gets the authorized state for the current connection.
TCPIP_HTTP_CurrentConnectionIsAuthorizedSet | Sets the authorized state for the current connection.
TCPIP_HTTP_CurrentConnectionUserDataGet | Gets the user data parameter for the current connection.
TCPIP_HTTP_CurrentConnectionUserDataSet | Sets the user data parameter for the current connection.
TCPIP_HTTP_CurrentConnectionHasArgsGet | Checks whether there are get or cookie arguments.
TCPIP_HTTP_CurrentConnectionPostSmSet | Set the POST state machine state.
TCPIP_HTTP_CurrentConnectionStatusGet | Gets HTTP status.
TCPIP_HTTP_FileAuthenticate | Determines if a given file name requires authentication
TCPIP_HTTP_GetExecute | Processes GET form field variables and cookies.
TCPIP_HTTP_PostExecute | Processes POST form variables and data.
TCPIP_HTTP_Print_varname | Inserts dynamic content into a web page
TCPIP_HTTP_UserAuthenticate | Performs validation on a specific user name and password.
TCPIP_HTTP_ActiveConnectionCountGet | Gets the number of active connections.
TCPIP_HTTP_CurrentConnectionHandleGet | Gets the connection handle of a HTTP connection.
TCPIP_HTTP_CurrentConnectionIndexGet | Gets the index of the HTTP connection.
TCPIP_HTTP_Task | Standard TCP/IP stack module task function.
TCPIP_HTTP_CurrentConnectionDataBufferSizeGet | Returns the size of the connection general purpose data buffer.
TCPIP_HTTP_CurrentConnectionSMSet | Set the HTTP current connection state Machine.
TCPIP_HTTP_CurrentConnectionUploadBufferCurrGet | Gets the current address of current connection upload buffer.
TCPIP_HTTP_CurrentConnectionUploadBufferCurrSet | Set the current address of current connection upload buffer.
TCPIP_HTTP_CurrentConnectionUploadBufferEndGet | Gets the end address of current connection upload buffer.
TCPIP_HTTP_CurrentConnectionUploadBufferEndSet | Set the end address of current connection upload buffer.
TCPIP_HTTP_CurrentConnectionUploadBufferStartGet | Gets the start address of current connection upload buffer.
TCPIP_HTTP_CurrentConnectionUploadBufferStartSet | Set the start address of current connection upload buffer.
Data Types and ConstantsEnumerations |
HTTP_MODULE_FLAGS | HTTP module configuration flags Multiple flags can be OR-ed
HTTP_IO_RESULT | Result states for execution callbacks
HTTP_FILE_TYPE | File type definitions
HTTP_READ_STATUS | Result states for TCPIP_HTTP_PostNameRead, TCPIP_HTTP_PostValueRead and TCPIP_HTTP_PostReadPair
HTTP_STATUS | Supported Commands and Server Response Codes
TCPIP_HTTP_CurrentConnectionHasArgsSet | Sets whether there are get or cookie arguments.
TCPIP_HTTP_MODULE_CONFIG | HTTP module dynamic configuration data
HTTP_CONN_HANDLE | HTTP connection identifier, handle of a HTTP connection