@CHIP-RTOS C Library - Common Gateway Interface API

Header File: #include <CGIAPI.H>

The CGI ("Common Gateway Interface") API provides access to the CGI implementation of the IPC@CHIP® Web server.
CGI at the IPC@CHIP® provides the possibility to install at the IPC@CHIP® Web server own programmed CGI functions. These functions are bound with a fixed name and are executed by the Web server task, if a http request with such a fixed name comes in. This mechanism allows dynamic usage of the IPC@CHIP® Web server. For better understanding of CGI and possibilities for using, see description of available program examples at the example link below.

File Upload:
Also there is a possibility to upload files to the @CHIP's disk. This does not use the CGI interface but the Web server. Therefore you only need a defined HTML form which sends the required data to the @CHIP Web server. An example can be found in the CGI Example Zip file.

Notes:

For test and demonstration purpose two pages are preinstalled at the IPC@CHIP®:
a)main.htm: Static html introduction page.
b)chipcfg: Dynamic page with system time/date and configuration data of the requested IPC@CHIP®.
For configuring the web server and CGI, see the provided chip.ini entries.
For some useful comments see also under Programming notes

Topics

CGI Functions

CGI_Install Install a CGI function
CGI_Delete Remove a CGI function
CGI_SetMainPage Select a new main page
CGI_GetMainPage Get main page name
CGI_SetMainPagePost Select a new main page (POST method)
CGI_GetMainPagePost Get main page name (POST method)
CGI_SetRootDrive Set Web server's root drive
CGI_GetRootDrive Get Web server's root drive
CGI_SetRootDir Set Web server's root directory
CGI_GetRootDir Get Web server's root directory
CGI_GetArgument Returns the next available argument
CGI_UrlEncode Encodes a URL string
CGI_UrlDecode Decodes a URL string
CGI_GetCookie Returns the next available cookie
CGI_SetCookie Creates a new cookie or modifies an old one
CGI_GetFormItem Deprecated! Split a form item into name and value
CGI_GetNextItem Deprecated! Return pointer to the next form item
CGI_Install_Func_OnErr Install error cgi function
CGI_Install_Func_OnUpload Install upload cgi function
CGI_Enable_Upload Enable/Disable HTTP file upload
CGI_Install_MIME_Table Install a custom MIME table
CGI_Remove_MIME_Table Remove the custom MIME table
CGI_Install_ContentEncoding_Table Install the custom content-encoding table
CGI_Remove_ContentEncoding_Table Remove the custom content-encoding table

SSI Functions

SSI_Set_File_Filter Set a SSI file filter
SSI_Register_Tag Register a SSI tag
SSI_Deregister_Tag Deregister a SSI tag
SSI_Set_TagLength Set the maximum SSI tag length
SSI_Send_Buffer Send a buffer over a HTTP connection
SSI_Get_Connection_Params Get SSI connection parameters

List of C Libraries
@CHIP-RTOS Main Index

End of document