Events generated by the Network - HTTP Server functions. More...

Functions
__STATIC_INLINE void	EvrNetHTTPs_InitServer (uint32_t num_sessions, uint16_t port)
	Event on HTTP server initialize (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewRootFolder (const char *root_folder, uint32_t length)
	Event on HTTP server display root folder (Op)

__STATIC_INLINE void	EvrNetHTTPs_GetSocketFailed (uint8_t session)
	Event on HTTP server failed to allocate TCP socket (Error)

__STATIC_INLINE void	EvrNetHTTPs_SetRootPath (const char *path, uint32_t length)
	Event on HTTP server netHTTPs_SetRootPath (API)

__STATIC_INLINE void	EvrNetHTTPs_SetUsername (const char *username, uint32_t length)
	Event on HTTP server netHTTPs_SetUsername (API)

__STATIC_INLINE void	EvrNetHTTPs_SetPassword (const char *password, uint32_t length)
	Event on HTTP server netHTTPs_SetPassword (API)

__STATIC_INLINE void	EvrNetHTTPs_StartService (uint16_t port)
	Event on HTTP server start service (Op)

__STATIC_INLINE void	EvrNetHTTPs_StopService (void)
	Event on HTTP server stop service (Op)

__STATIC_INLINE void	EvrNetHTTPs_FileNotFound (uint8_t session)
	Event on HTTP server requested resource file not found (Error)

__STATIC_INLINE void	EvrNetHTTPs_FileAccessForbidden (uint8_t session)
	Event on HTTP server access to requested resource not allowed (Error)

__STATIC_INLINE void	EvrNetHTTPs_FileCached (uint8_t session)
	Event on HTTP server requested resource file cached on the client (Op)

__STATIC_INLINE void	EvrNetHTTPs_CloseSession (uint8_t session)
	Event on HTTP server session close (Op)

__STATIC_INLINE void	EvrNetHTTPs_SendFile (uint8_t session)
	Event on HTTP server send a resource file (Op)

__STATIC_INLINE void	EvrNetHTTPs_CgiSendFile (uint8_t session)
	Event on HTTP server CGI send dynamic resource file (Op)

__STATIC_INLINE void	EvrNetHTTPs_CgiIncludeFile (uint8_t session)
	Event on HTTP server CGI include a file (Op)

__STATIC_INLINE void	EvrNetHTTPs_CgiStopEngine (uint8_t session)
	Event on HTTP server stop CGI script interpreter engine (Op)

__STATIC_INLINE void	EvrNetHTTPs_CgiScriptError (uint8_t session)
	Event on HTTP server CGI script error found (Error)

__STATIC_INLINE void	EvrNetHTTPs_UnauthorizedAccess (uint8_t session)
	Event on HTTP server unauthorized access (Error)

__STATIC_INLINE void	EvrNetHTTPs_MethodNotImplemented (uint8_t session)
	Event on HTTP server requested method not implemented (Error)

__STATIC_INLINE void	EvrNetHTTPs_UserAccessDenied (const void *net_addr)
	Event on HTTP server user denied access (Error)

__STATIC_INLINE void	EvrNetHTTPs_SetCookie (const char *cookie, uint32_t length)
	Event on HTTP server netCGI_SetCookie (API)

__STATIC_INLINE void	EvrNetHTTPs_SessionOpen (uint8_t session)
	Event on HTTP server session open (Op)

__STATIC_INLINE void	EvrNetHTTPs_SocketAborted (uint8_t session)
	Event on HTTP server socket aborted (Op)

__STATIC_INLINE void	EvrNetHTTPs_SocketClosed (uint8_t session)
	Event on HTTP server socket closed (Op)

__STATIC_INLINE void	EvrNetHTTPs_ReceiveFrame (uint8_t session, uint32_t length)
	Event on HTTP server receive frame (Op)

__STATIC_INLINE void	EvrNetHTTPs_FrameTooShort (uint8_t session, uint32_t length, uint32_t min_length)
	Event on HTTP server receive frame too short (Error)

__STATIC_INLINE void	EvrNetHTTPs_RequestMethod (uint8_t session, uint8_t method)
	Event on HTTP server display requested method (Op)

__STATIC_INLINE void	EvrNetHTTPs_CgiStartEngine (uint8_t session)
	Event on HTTP server start CGI script interpreter engine (Op)

__STATIC_INLINE void	EvrNetHTTPs_RequestedFile (const char *fname, uint32_t length)
	Event on HTTP server requested resource file (Op)

__STATIC_INLINE void	EvrNetHTTPs_FileOpenDrive (uint32_t drive)
	Event on HTTP server resource file location (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewFileStatus (uint32_t size, uint32_t lm_time)
	Event on HTTP server display open file status (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewRedirectionUrl (const char *url, uint32_t length)
	Event on HTTP server display resource file redirection URL (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewUserCredentials (const char *credentials, uint32_t length)
	Event on HTTP server display user credentials (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewAcceptLanguage (const char *accept_lang, uint32_t length)
	Event on HTTP server display accept language http header (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewCookie (const char *cookie, uint32_t length)
	Event on HTTP server display cookie header (Op)

__STATIC_INLINE void	EvrNetHTTPs_ViewXmlType (const char *xml_type, uint32_t length)
	Event on HTTP server display xml content type header (Op)

__STATIC_INLINE void	EvrNetHTTPs_PostXmlEncoded (uint32_t length)
	Event on HTTP server POST type: xml-encoded (Op)

__STATIC_INLINE void	EvrNetHTTPs_PostCompleteMultipacket (uint32_t length)
	Event on HTTP server POST complete for multipacket POST (Op)

__STATIC_INLINE void	EvrNetHTTPs_PostFormUrlEncoded (uint32_t length)
	Event on HTTP server POST type: www-form-urlencoded (Op)

__STATIC_INLINE void	EvrNetHTTPs_PostDataTruncated (uint32_t new_length)
	Event on HTTP server POST data truncated in buffer mode (Error)

__STATIC_INLINE void	EvrNetHTTPs_FileUploadRequested (const char *fname, uint32_t length)
	Event on HTTP server file upload requested (Op)

__STATIC_INLINE void	EvrNetHTTPs_FileUploadDataReceived (uint32_t length)
	Event on HTTP server data received in file upload process (Op)

__STATIC_INLINE void	EvrNetHTTPs_FileUploadRemaining (uint32_t length)
	Event on HTTP server file upload remaining data size to complete (Op)

__STATIC_INLINE void	EvrNetHTTPs_FileUploadComplete (void)
	Event on HTTP server file upload completed (Op)

__STATIC_INLINE void	EvrNetHTTPs_TlsGetContextFailed (uint8_t session)
	Event on HTTP server failed to allocate secure TLS context (Error)

__STATIC_INLINE void	EvrNetHTTPs_UninitServer (void)
	Event on HTTP server de-initialize (Op)

Description

Events generated by the Network - HTTP Server functions.

The HTTP server functions generate events that make it easier to troubleshoot errors, and allow the user to understand how the HTTP server works.

Function Documentation

◆ EvrNetHTTPs_CgiIncludeFile()

__STATIC_INLINE void EvrNetHTTPs_CgiIncludeFile ( uint8_t session )

Event on HTTP server CGI include a file (Op)

Parameters

session session number

The event CgiIncludeFile is created when the HTTP server script interpreter includes an external resource file in the requested dynamic web page. This happens when the command i is used in the script.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_CgiScriptError()

__STATIC_INLINE void EvrNetHTTPs_CgiScriptError ( uint8_t session )

Event on HTTP server CGI script error found (Error)

Parameters

session session number

The event CgiScriptError is created when the HTTP server stops the script interpreter because it has detected an error in the requested script. This usually means that an invalid CGI command is found in the script.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_CgiSendFile()

__STATIC_INLINE void EvrNetHTTPs_CgiSendFile ( uint8_t session )

Event on HTTP server CGI send dynamic resource file (Op)

Parameters

session session number

The event CgiSendFile is created when the HTTP script interpreter starts to to send the requested dynamic web page to the web browser.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_CgiStartEngine()

__STATIC_INLINE void EvrNetHTTPs_CgiStartEngine ( uint8_t session )

Event on HTTP server start CGI script interpreter engine (Op)

Parameters

session session number

The event CgiStartEngine is created when the HTTP server starts the script interpreter to process the requested script.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_CgiStopEngine()

__STATIC_INLINE void EvrNetHTTPs_CgiStopEngine ( uint8_t session )

Event on HTTP server stop CGI script interpreter engine (Op)

Parameters

session session number

The event CgiStopEngine is created when the HTTP server stops the script interpreter because it has finished processing the requested script.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_CloseSession()

__STATIC_INLINE void EvrNetHTTPs_CloseSession ( uint8_t session )

Event on HTTP server session close (Op)

Parameters

session session number

The event CloseSession is created when the HTTP server closes a session that has finished serving the requested resource.

Value in the Event Recorder shows:

session: HTTP server session to close.

◆ EvrNetHTTPs_FileAccessForbidden()

__STATIC_INLINE void EvrNetHTTPs_FileAccessForbidden ( uint8_t session )

Event on HTTP server access to requested resource not allowed (Error)

Parameters

session session number

The event FileAccessForbidden is created when the HTTP server can not deliver the requested resource, because the access to the file for this user is not allowed. This happens when the web resource requested by the web browser, needs a permission to access. The server then sends the error 403 to the browser.

Value in the Event Recorder shows:

session: HTTP session that failed.

◆ EvrNetHTTPs_FileCached()

__STATIC_INLINE void EvrNetHTTPs_FileCached ( uint8_t session )

Event on HTTP server requested resource file cached on the client (Op)

Parameters

session session number

The event FileCached is created when the HTTP server determines, that the requested resource is already cached in the browser. The HTTP server then instructs the web browser to use the local cached resource by sending an error 304 to the browser.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_FileNotFound()

__STATIC_INLINE void EvrNetHTTPs_FileNotFound ( uint8_t session )

Event on HTTP server requested resource file not found (Error)

Parameters

session session number

The event FileNotFound is created when the HTTP server can not deliver the requested resource, because the file can not be found. This happens when the web page that the web browser has requested, does not exist on the server. The server then sends the error 404 to the browser.

Value in the Event Recorder shows:

session: HTTP session that failed.

◆ EvrNetHTTPs_FileOpenDrive()

__STATIC_INLINE void EvrNetHTTPs_FileOpenDrive ( uint32_t drive )

Event on HTTP server resource file location (Op)

Parameters

drive

where the resource file is stored

0: ROM Image
1: External Drive

The event FileOpenDrive is created when the HTTP server determines the drive on which the requested resource file was found on the server.

Value in the Event Recorder shows:

ROM image, or External drive.

◆ EvrNetHTTPs_FileUploadComplete()

__STATIC_INLINE void EvrNetHTTPs_FileUploadComplete ( void )

Event on HTTP server file upload completed (Op)

The event FileUploadComplete is created when the HTTP wants to notify that the file transfer is complete.

◆ EvrNetHTTPs_FileUploadDataReceived()

__STATIC_INLINE void EvrNetHTTPs_FileUploadDataReceived ( uint32_t length )

Event on HTTP server data received in file upload process (Op)

Parameters

length length of a file data chunk

Remarks: File data is received in multiple packets.

The event FileUploadDataReceived is created when the HTTP server receives a part of the file content. The data is then delivered to the user application in the callback function netCGI_ProcessData.

Value in the Event Recorder shows:

len: length of the file fragment.

◆ EvrNetHTTPs_FileUploadRemaining()

__STATIC_INLINE void EvrNetHTTPs_FileUploadRemaining ( uint32_t length )

Event on HTTP server file upload remaining data size to complete (Op)

Parameters

length length of the remaining data

Remarks: File data is received in multiple packets.

The event FileUploadRemaining is created when the HTTP wants to display the remaining data length that needs to be transferred to complete the file upload process.

Value in the Event Recorder shows:

len: remaining length of data.

◆ EvrNetHTTPs_FileUploadRequested()

__STATIC_INLINE void EvrNetHTTPs_FileUploadRequested	(	const char *	fname,
		uint32_t	length
	)

Event on HTTP server file upload requested (Op)

Parameters

fname	name of the requested file
length	length of the fname string

The event FileUploadRequested is created when the HTTP server receives a multipart POST request and recognizes the file upload request. The file content is then received in several packets and delivered to the user application in the callback function netCGI_ProcessData.

Value in the Event Recorder shows:

file: name of the file for upload.

◆ EvrNetHTTPs_FrameTooShort()

__STATIC_INLINE void EvrNetHTTPs_FrameTooShort	(	uint8_t	session,
		uint32_t	length,
		uint32_t	min_length
	)

Event on HTTP server receive frame too short (Error)

Parameters

session	session number
length	frame length in bytes
min_length	minimum length of the frame

The event FrameTooShort is created when the HTTP server receives the frame that is too short. The frame is then discarded.

Value in the Event Recorder shows:

session: HTTP server session.
len: length of the received frame in bytes.
min: minimum valid frame length in bytes.

◆ EvrNetHTTPs_GetSocketFailed()

__STATIC_INLINE void EvrNetHTTPs_GetSocketFailed ( uint8_t session )

Event on HTTP server failed to allocate TCP socket (Error)

Parameters

session session number

The event GetSocketFailed is created when the HTTP server is initialized, that is, when the function netInitialize is executed, and the service could not assign the TCP socket. To resolve this error, you must increase the number of available TCP sockets in the TCP socket configuration.

Value in the Event Recorder shows:

session: session that failed to allocate the socket.

◆ EvrNetHTTPs_InitServer()

__STATIC_INLINE void EvrNetHTTPs_InitServer	(	uint32_t	num_sessions,
		uint16_t	port
	)

Event on HTTP server initialize (Op)

Parameters

num_sessions	number of available HTTP sessions
port	listening port number

The event InitServer is created when the HTTP server is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

sessions: number of HTTP sessions available.
port: port number to be used.

◆ EvrNetHTTPs_MethodNotImplemented()

__STATIC_INLINE void EvrNetHTTPs_MethodNotImplemented ( uint8_t session )

Event on HTTP server requested method not implemented (Error)

Parameters

session session number

The event MethodNotImplemented is created when the HTTP server can not deliver the requested resource, because the required HTTP request method on the server is not supported. The server then sends the error 501 to the browser.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_PostCompleteMultipacket()

__STATIC_INLINE void EvrNetHTTPs_PostCompleteMultipacket ( uint32_t length )

Event on HTTP server POST complete for multipacket POST (Op)

Parameters

length data length

The event PostCompleteMultipacket is created when the HTTP server stops receiving XML data in a POST request, that is, when it receives the last packet.

Value in the Event Recorder shows:

len: length of the received XML data.

◆ EvrNetHTTPs_PostDataTruncated()

__STATIC_INLINE void EvrNetHTTPs_PostDataTruncated ( uint32_t new_length )

Event on HTTP server POST data truncated in buffer mode (Error)

Parameters

new_length truncated data length

Remarks: Buffer mode is used for www-form-urlencoded POST type only.

The event PostDataTruncated is created when the HTTP server can not allocate memory for the www-form-urlencoded data cache, because the memory is not available. The server then shortens POST data and ignores the excess data.

Value in the Event Recorder shows:

new_len: truncated length of the data.

◆ EvrNetHTTPs_PostFormUrlEncoded()

__STATIC_INLINE void EvrNetHTTPs_PostFormUrlEncoded ( uint32_t length )

Event on HTTP server POST type: www-form-urlencoded (Op)

Parameters

length content-length

The event PostFormUrlEncoded is created when the HTTP server starts receiving the www-form-urlencoded data in a POST request, that is delivered in multiple packets. The data is cached and delivered to the user application when the last packet is received in the callback function netCGI_ProcessData.

Value in the Event Recorder shows:

len: content-length of the data.

◆ EvrNetHTTPs_PostXmlEncoded()

__STATIC_INLINE void EvrNetHTTPs_PostXmlEncoded ( uint32_t length )

Event on HTTP server POST type: xml-encoded (Op)

Parameters

length content-length

The event PostXmlEncoded is created when the HTTP server begins to receive large XML data in a POST request, that is delivered in multiple packets. XML data is not cached, but delivered to the user application synchronously in the callback function netCGI_ProcessData.

Value in the Event Recorder shows:

len: content-length of the XML data.

◆ EvrNetHTTPs_ReceiveFrame()

__STATIC_INLINE void EvrNetHTTPs_ReceiveFrame	(	uint8_t	session,
		uint32_t	length
	)

Event on HTTP server receive frame (Op)

Parameters

session	session number
length	frame length in bytes

The event ReceiveFrame is created when the HTTP server receives the frame.

Value in the Event Recorder shows:

session: HTTP server session.
len: length of the received frame in bytes.

◆ EvrNetHTTPs_RequestedFile()

__STATIC_INLINE void EvrNetHTTPs_RequestedFile	(	const char *	fname,
		uint32_t	length
	)

Event on HTTP server requested resource file (Op)

Parameters

fname	name of the requested file
length	length of the fname string

The event RequestedFile is created when the HTTP server attempts to open the requested resource file on the server.

Value in the Event Recorder shows:

name: name of the file to open.

◆ EvrNetHTTPs_RequestMethod()

__STATIC_INLINE void EvrNetHTTPs_RequestMethod	(	uint8_t	session,
		uint8_t	method
	)

Event on HTTP server display requested method (Op)

Parameters

session	session number
method	http request method 1: GET 2: POST 3: HEAD 4: PUT 5: DELETE 6: CONNECT 7: OPTIONS 8: TRACE

The event RequestMethod is created when the HTTP server receives the HTTP request and identifies the request method.

Value in the Event Recorder shows:

session: HTTP server session.
method: request method (GET, POST, HEAD, PUT, DELETE, CONNECT, OPTIONS, TRACE).

◆ EvrNetHTTPs_SendFile()

__STATIC_INLINE void EvrNetHTTPs_SendFile ( uint8_t session )

Event on HTTP server send a resource file (Op)

Parameters

session session number

The event SendFile is created when the HTTP server starts to send the requested resource file to the web browser.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_SessionOpen()

__STATIC_INLINE void EvrNetHTTPs_SessionOpen ( uint8_t session )

Event on HTTP server session open (Op)

Parameters

session session number

The event SessionOpen is created when the HTTP server accepts a request to connect from a web browser and opens a server session to handle this connection. This happens when a web browser attempts to open a web page on a server.

Value in the Event Recorder shows:

session: HTTP server session for opening.

◆ EvrNetHTTPs_SetCookie()

__STATIC_INLINE void EvrNetHTTPs_SetCookie	(	const char *	cookie,
		uint32_t	length
	)

Event on HTTP server netCGI_SetCookie (API)

Parameters

cookie	cookie to send to the client
length	length of the cookie string

The event SetCookie is created when the HTTP server sets a cookie to send to the client. This happens when the netCGI_SetCookie function is executed.

Value in the Event Recorder shows:

cookie to send.

◆ EvrNetHTTPs_SetPassword()

__STATIC_INLINE void EvrNetHTTPs_SetPassword	(	const char *	password,
		uint32_t	length
	)

Event on HTTP server netHTTPs_SetPassword (API)

Parameters

password	new password
length	length of the password string

The event SetPassword is created when the HTTP server changes the password for the administrator account. This happens when the netHTTPs_SetPassword function is executed.

Value in the Event Recorder shows:

password: password to be set.

◆ EvrNetHTTPs_SetRootPath()

__STATIC_INLINE void EvrNetHTTPs_SetRootPath	(	const char *	path,
		uint32_t	length
	)

Event on HTTP server netHTTPs_SetRootPath (API)

Parameters

path	path to server root folder
length	length of the path string

The event SetRootPath is created when the HTTP server changes the path to web resources. This happens when the netHTTPs_SetRootPath function is executed.

Value in the Event Recorder shows:

path: path of the root directory to be set.

◆ EvrNetHTTPs_SetUsername()

__STATIC_INLINE void EvrNetHTTPs_SetUsername	(	const char *	username,
		uint32_t	length
	)

Event on HTTP server netHTTPs_SetUsername (API)

Parameters

username	new username
length	length of the username string

The event SetUsername is created when the HTTP server changes the username for the administrator account. This happens when the netHTTPs_SetUsername function is executed.

Value in the Event Recorder shows:

username: username to be set.

◆ EvrNetHTTPs_SocketAborted()

__STATIC_INLINE void EvrNetHTTPs_SocketAborted ( uint8_t session )

Event on HTTP server socket aborted (Op)

Parameters

session session number

The event SocketAborted is created when the HTTP server connection is unexpectedly terminated from the web browser. The corresponding server session is then closed.

Value in the Event Recorder shows:

session: HTTP server session for closing.

◆ EvrNetHTTPs_SocketClosed()

__STATIC_INLINE void EvrNetHTTPs_SocketClosed ( uint8_t session )

Event on HTTP server socket closed (Op)

Parameters

session session number

The event SocketClosed is created when the HTTP server connection is unexpectedly closed from the web browser. The corresponding server session is then closed.

Value in the Event Recorder shows:

session: HTTP server session for closing.

◆ EvrNetHTTPs_StartService()

__STATIC_INLINE void EvrNetHTTPs_StartService ( uint16_t port )

Event on HTTP server start service (Op)

Parameters

port	listening port number

The event StartService is created when the network library starts the HTTP server service. This happens automatically if the auto-start services are enabled, or when the netHTTPs_Start function is executed.

Value in the Event Recorder shows:

port: port number to be used.

◆ EvrNetHTTPs_StopService()

__STATIC_INLINE void EvrNetHTTPs_StopService ( void )

Event on HTTP server stop service (Op)

The event StopService is created when the network library stops the HTTP server service. This happens when the netHTTPs_Stop function is executed.

◆ EvrNetHTTPs_TlsGetContextFailed()

__STATIC_INLINE void EvrNetHTTPs_TlsGetContextFailed ( uint8_t session )

Event on HTTP server failed to allocate secure TLS context (Error)

Parameters

session session number

The event TlsGetContextFailed is created when the HTTP server is initialized, that is, when the function netInitialize is executed, and the service could not assign the TLS context.

Value in the Event Recorder shows:

session: session that failed to allocate the TLS context.

◆ EvrNetHTTPs_UnauthorizedAccess()

__STATIC_INLINE void EvrNetHTTPs_UnauthorizedAccess ( uint8_t session )

Event on HTTP server unauthorized access (Error)

Parameters

session session number

The event UnauthorizedAccess is created when the HTTP server can not deliver the requested resource, because the client did not authenticate or the provided credentials were invalid. The server then sends the error 401 to the browser.

Value in the Event Recorder shows:

session: HTTP server session.

◆ EvrNetHTTPs_UninitServer()

__STATIC_INLINE void EvrNetHTTPs_UninitServer ( void )

Event on HTTP server de-initialize (Op)

The event UninitServer is created when the function netUninitialize is executed.

Value in the Event Recorder shows:

http

◆ EvrNetHTTPs_UserAccessDenied()

__STATIC_INLINE void EvrNetHTTPs_UserAccessDenied ( const void * net_addr )

Event on HTTP server user denied access (Error)

Parameters

net_addr pointer to NET_ADDR address structure

The event UserAccessDenied is created when the HTTP server rejects the pending connection request for the client, because the user application has denied connection for this client. This happens when the netHTTPs_AcceptClient function returns false.

Value in the Event Recorder shows:

ip: IPv4 or IPv6 address of the client.
port: port number of the client.

◆ EvrNetHTTPs_ViewAcceptLanguage()

__STATIC_INLINE void EvrNetHTTPs_ViewAcceptLanguage	(	const char *	accept_lang,
		uint32_t	length
	)

Event on HTTP server display accept language http header (Op)

Parameters

accept_lang	accept language header content
length	length of the accept_lang string

The event ViewAcceptLanguage is created when the HTTP server wants to display the http accept-language header received from a web browser.

Value in the Event Recorder shows:

lang: accept language information.

◆ EvrNetHTTPs_ViewCookie()

__STATIC_INLINE void EvrNetHTTPs_ViewCookie	(	const char *	cookie,
		uint32_t	length
	)

Event on HTTP server display cookie header (Op)

Parameters

cookie	cookie header content
length	length of the cookie header

The event ViewCookie is created when the HTTP server wants to display the http cookie header received from a web browser. The cookie header contains one or more cookies separated by a semicolon.

Value in the Event Recorder shows:

cookie header information.

◆ EvrNetHTTPs_ViewFileStatus()

__STATIC_INLINE void EvrNetHTTPs_ViewFileStatus	(	uint32_t	size,
		uint32_t	lm_time
	)

Event on HTTP server display open file status (Op)

Parameters

size	size of the open file
lm_time	last-modified time of the file

The event ViewFileStatus is created when the HTTP server obtains the size and time of the last change in the resource file that is requested. This happens when the resource file is stored on external drive. The server then uses this information to check the caching of files in the web browser.

Value in the Event Recorder shows:

size: size of the file in bytes.
lm_time: last modified time of the file in UTC format.

◆ EvrNetHTTPs_ViewRedirectionUrl()

__STATIC_INLINE void EvrNetHTTPs_ViewRedirectionUrl	(	const char *	url,
		uint32_t	length
	)

Event on HTTP server display resource file redirection URL (Op)

Parameters

url	redirection url in text format
length	length of the url string

The event ViewRedirectionUrl is created when the HTTP server can not find the requested resource on the server and the user application provides the redirected location with the netCGI_Redirect function. The server then sends the error 301 to the browser.

Value in the Event Recorder shows:

url: location of the redirected resource.

◆ EvrNetHTTPs_ViewRootFolder()

__STATIC_INLINE void EvrNetHTTPs_ViewRootFolder	(	const char *	root_folder,
		uint32_t	length
	)

Event on HTTP server display root folder (Op)

Parameters

root_folder	path to server root folder
length	length of the root_folder string

The event ViewRootFolder is created when the network library wants to display the path to the root folder that contains the resources of the HTTP server. This event is generated only if the root folder is enabled in the HTTP server configuration.

Value in the Event Recorder shows:

root: path of the root directory.

◆ EvrNetHTTPs_ViewUserCredentials()

__STATIC_INLINE void EvrNetHTTPs_ViewUserCredentials	(	const char *	credentials,
		uint32_t	length
	)

Event on HTTP server display user credentials (Op)

Parameters

credentials	user credentials in the form of: "username:password"
length	length of the credentials string

The event ViewUserCredentials is created when the HTTP server wants to display the username and password for authentication received from the web browser.

Value in the Event Recorder shows:

user: user credentials in format username:password.

◆ EvrNetHTTPs_ViewXmlType()

__STATIC_INLINE void EvrNetHTTPs_ViewXmlType	(	const char *	xml_type,
		uint32_t	length
	)

Event on HTTP server display xml content type header (Op)

Parameters

xml_type	xml content type in text format
length	length of the xml_type string

The event ViewXmlType is created when the HTTP server wants to display the content type of the XML content received in the POST request.

Value in the Event Recorder shows:

xml_type: XML content type.

Functions

Description

Function Documentation

◆ EvrNetHTTPs_CgiIncludeFile()

◆ EvrNetHTTPs_CgiScriptError()

◆ EvrNetHTTPs_CgiSendFile()

◆ EvrNetHTTPs_CgiStartEngine()

◆ EvrNetHTTPs_CgiStopEngine()

◆ EvrNetHTTPs_CloseSession()

◆ EvrNetHTTPs_FileAccessForbidden()

◆ EvrNetHTTPs_FileCached()

◆ EvrNetHTTPs_FileNotFound()

◆ EvrNetHTTPs_FileOpenDrive()

◆ EvrNetHTTPs_FileUploadComplete()

◆ EvrNetHTTPs_FileUploadDataReceived()

◆ EvrNetHTTPs_FileUploadRemaining()

◆ EvrNetHTTPs_FileUploadRequested()

◆ EvrNetHTTPs_FrameTooShort()

◆ EvrNetHTTPs_GetSocketFailed()

◆ EvrNetHTTPs_InitServer()

◆ EvrNetHTTPs_MethodNotImplemented()

◆ EvrNetHTTPs_PostCompleteMultipacket()

◆ EvrNetHTTPs_PostDataTruncated()

◆ EvrNetHTTPs_PostFormUrlEncoded()

◆ EvrNetHTTPs_PostXmlEncoded()

◆ EvrNetHTTPs_ReceiveFrame()

◆ EvrNetHTTPs_RequestedFile()

◆ EvrNetHTTPs_RequestMethod()

◆ EvrNetHTTPs_SendFile()

◆ EvrNetHTTPs_SessionOpen()

◆ EvrNetHTTPs_SetCookie()

◆ EvrNetHTTPs_SetPassword()

◆ EvrNetHTTPs_SetRootPath()

◆ EvrNetHTTPs_SetUsername()

◆ EvrNetHTTPs_SocketAborted()

◆ EvrNetHTTPs_SocketClosed()

◆ EvrNetHTTPs_StartService()

◆ EvrNetHTTPs_StopService()

◆ EvrNetHTTPs_TlsGetContextFailed()

◆ EvrNetHTTPs_UnauthorizedAccess()

◆ EvrNetHTTPs_UninitServer()

◆ EvrNetHTTPs_UserAccessDenied()

◆ EvrNetHTTPs_ViewAcceptLanguage()

◆ EvrNetHTTPs_ViewCookie()

◆ EvrNetHTTPs_ViewFileStatus()

◆ EvrNetHTTPs_ViewRedirectionUrl()

◆ EvrNetHTTPs_ViewRootFolder()

◆ EvrNetHTTPs_ViewUserCredentials()

◆ EvrNetHTTPs_ViewXmlType()