Network Component  Version 7.5.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetHTTPs: HTTP Server

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) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowRootFolder (const char *root_folder, uint32_t length)
 Event on HTTP server display root folder (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_GetSocketFailed (uint8_t session)
 Event on HTTP server failed to allocate TCP socket (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_SetRootPath (const char *path, uint32_t length)
 Event on HTTP server netHTTPs_SetRootPath (API) More...
 
__STATIC_INLINE void EvrNetHTTPs_SetUsername (const char *username, uint32_t length)
 Event on HTTP server netHTTPs_SetUsername (API) More...
 
__STATIC_INLINE void EvrNetHTTPs_SetPassword (const char *password, uint32_t length)
 Event on HTTP server netHTTPs_SetPassword (API) More...
 
__STATIC_INLINE void EvrNetHTTPs_StartService (uint16_t port)
 Event on HTTP server start service (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_StopService (void)
 Event on HTTP server stop service (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileNotFound (uint8_t session)
 Event on HTTP server requested resource file not found (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileAccessForbidden (uint8_t session)
 Event on HTTP server access to requested resource not allowed (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileCached (uint8_t session)
 Event on HTTP server requested resource file cached on the client (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CloseSession (uint8_t session)
 Event on HTTP server session close (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_SendFile (uint8_t session)
 Event on HTTP server send a resource file (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CgiSendFile (uint8_t session)
 Event on HTTP server CGI send dynamic resource file (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CgiIncludeFile (uint8_t session)
 Event on HTTP server CGI include a file (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CgiStopEngine (uint8_t session)
 Event on HTTP server stop CGI script interpreter engine (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CgiScriptError (uint8_t session)
 Event on HTTP server CGI script error found (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_UnauthorizedAccess (uint8_t session)
 Event on HTTP server unauthorized access (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_MethodNotImplemented (uint8_t session)
 Event on HTTP server requested method not implemented (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_UserAccessDeniedIp4 (const void *net_addr)
 Event on HTTP server user denied access for IPv4 client (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_UserAccessDeniedIp6 (const void *net_addr)
 Event on HTTP server user denied access for IPv6 client (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_SessionOpen (uint8_t session)
 Event on HTTP server session open (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_SocketAborted (uint8_t session)
 Event on HTTP server socket aborted (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_SocketClosed (uint8_t session)
 Event on HTTP server socket closed (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ReceiveFrame (uint8_t session, uint32_t length)
 Event on HTTP server receive frame (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FrameTooShort (uint8_t session, uint32_t length, uint32_t min_length)
 Event on HTTP server received frame too short (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_RequestMethod (uint8_t session, uint8_t method)
 Event on HTTP server display requested method (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_CgiStartEngine (uint8_t session)
 Event on HTTP server start CGI script interpreter engine (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_RequestedFile (const char *fname, uint32_t length)
 Event on HTTP server requested resource file (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileOpenDrive (uint32_t drive)
 Event on HTTP server resource file location (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowFileStatus (uint32_t size, uint32_t lm_time)
 Event on HTTP server display open file status (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowRedirectionUrl (const char *url, uint32_t length)
 Event on HTTP server display resource file redirection URL (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowUserCredentials (const char *credentials, uint32_t length)
 Event on HTTP server display user credentials (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowAcceptLanguage (const char *accept_lang, uint32_t length)
 Event on HTTP server display accept language http header (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_ShowXmlType (const char *xml_type, uint32_t length)
 Event on HTTP server display xml content type header (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_PostXmlEncoded (uint32_t length)
 Event on HTTP server POST type: xml-encoded (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_PostCompleteMultipacket (uint32_t length)
 Event on HTTP server POST complete for multipacket POST (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_PostFormUrlEncoded (uint32_t length)
 Event on HTTP server POST type: www-form-urlencoded (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_PostDataTruncated (uint32_t new_length)
 Event on HTTP server POST data truncated in buffer mode (Error) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileUploadRequested (const char *fname, uint32_t length)
 Event on HTTP server file upload requested (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileUploadDataReceived (uint32_t length)
 Event on HTTP server data received in file upload process (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileUploadRemaining (uint32_t length)
 Event on HTTP server file upload remaining data size to complete (Op) More...
 
__STATIC_INLINE void EvrNetHTTPs_FileUploadComplete (void)
 Event on HTTP server file upload completed (Op) More...
 

Description

Events generated by the Network - HTTP Server functions.

Function Documentation

__STATIC_INLINE void EvrNetHTTPs_CgiIncludeFile ( uint8_t  session)

Event on HTTP server CGI include a file (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_CgiScriptError ( uint8_t  session)

Event on HTTP server CGI script error found (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_CgiSendFile ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_CgiStartEngine ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_CgiStopEngine ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_CloseSession ( uint8_t  session)

Event on HTTP server session close (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_FileAccessForbidden ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_FileCached ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_FileNotFound ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_FileOpenDrive ( uint32_t  drive)

Event on HTTP server resource file location (Op)

Parameters
drivewhere the resource file is stored
  • 0: ROM Image
  • 1: External Drive
__STATIC_INLINE void EvrNetHTTPs_FileUploadComplete ( void  )

Event on HTTP server file upload completed (Op)

__STATIC_INLINE void EvrNetHTTPs_FileUploadDataReceived ( uint32_t  length)

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

Parameters
lengthlength of a file data chunk
Note
File data is received in multiple packets.
__STATIC_INLINE void EvrNetHTTPs_FileUploadRemaining ( uint32_t  length)

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

Parameters
lengthlength of the remaining data
Note
File data is received in multiple packets.
__STATIC_INLINE void EvrNetHTTPs_FileUploadRequested ( const char *  fname,
uint32_t  length 
)

Event on HTTP server file upload requested (Op)

Parameters
fnamename of the requested file
lengthlength of the fname string
__STATIC_INLINE void EvrNetHTTPs_FrameTooShort ( uint8_t  session,
uint32_t  length,
uint32_t  min_length 
)

Event on HTTP server received frame too short (Error)

Parameters
sessionsession number
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetHTTPs_GetSocketFailed ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_InitServer ( uint32_t  num_sessions,
uint16_t  port 
)

Event on HTTP server initialize (Op)

Parameters
num_sessionsnumber of available HTTP sessions
portlistening port number
__STATIC_INLINE void EvrNetHTTPs_MethodNotImplemented ( uint8_t  session)

Event on HTTP server requested method not implemented (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_PostCompleteMultipacket ( uint32_t  length)

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

Parameters
lengthdata length
__STATIC_INLINE void EvrNetHTTPs_PostDataTruncated ( uint32_t  new_length)

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

Parameters
new_lengthtruncated data length
Note
Buffer mode is used for www-form-urlencoded POST type only.
__STATIC_INLINE void EvrNetHTTPs_PostFormUrlEncoded ( uint32_t  length)

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

Parameters
lengthcontent-length
__STATIC_INLINE void EvrNetHTTPs_PostXmlEncoded ( uint32_t  length)

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

Parameters
lengthcontent-length
__STATIC_INLINE void EvrNetHTTPs_ReceiveFrame ( uint8_t  session,
uint32_t  length 
)

Event on HTTP server receive frame (Op)

Parameters
sessionsession number
lengthframe length in bytes
__STATIC_INLINE void EvrNetHTTPs_RequestedFile ( const char *  fname,
uint32_t  length 
)

Event on HTTP server requested resource file (Op)

Parameters
fnamename of the requested file
lengthlength of the fname string
__STATIC_INLINE void EvrNetHTTPs_RequestMethod ( uint8_t  session,
uint8_t  method 
)

Event on HTTP server display requested method (Op)

Parameters
sessionsession number
methodhttp request method
  • 0: HEAD
  • 1: GET
  • 2: POST
__STATIC_INLINE void EvrNetHTTPs_SendFile ( uint8_t  session)

Event on HTTP server send a resource file (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_SessionOpen ( uint8_t  session)

Event on HTTP server session open (Op)

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

Event on HTTP server netHTTPs_SetPassword (API)

Parameters
passwordnew password
lengthlength of the password string
__STATIC_INLINE void EvrNetHTTPs_SetRootPath ( const char *  path,
uint32_t  length 
)

Event on HTTP server netHTTPs_SetRootPath (API)

Parameters
pathpath to server root folder
lengthlength of the path string
__STATIC_INLINE void EvrNetHTTPs_SetUsername ( const char *  username,
uint32_t  length 
)

Event on HTTP server netHTTPs_SetUsername (API)

Parameters
usernamenew username
lengthlength of the username string
__STATIC_INLINE void EvrNetHTTPs_ShowAcceptLanguage ( const char *  accept_lang,
uint32_t  length 
)

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

Parameters
accept_langaccept language header content
lengthlength of the accept_lang string
__STATIC_INLINE void EvrNetHTTPs_ShowFileStatus ( uint32_t  size,
uint32_t  lm_time 
)

Event on HTTP server display open file status (Op)

Parameters
sizesize of the open file
lm_timelast-modified time of the file
__STATIC_INLINE void EvrNetHTTPs_ShowRedirectionUrl ( const char *  url,
uint32_t  length 
)

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

Parameters
urlredirection url in text format
lengthlength of the url string
__STATIC_INLINE void EvrNetHTTPs_ShowRootFolder ( const char *  root_folder,
uint32_t  length 
)

Event on HTTP server display root folder (Op)

Parameters
root_folderpath to server root folder
lengthlength of the root_folder string
___STATIC_INLINE void EvrNetHTTPs_ShowUserCredentials ( const char *  credentials,
uint32_t  length 
)

Event on HTTP server display user credentials (Op)

Parameters
credentialsuser credentials in the form of: "username:password"
lengthlength of the credentials string
__STATIC_INLINE void EvrNetHTTPs_ShowXmlType ( const char *  xml_type,
uint32_t  length 
)

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

Parameters
xml_typexml content type in text format
lengthlength of the xml_type string
__STATIC_INLINE void EvrNetHTTPs_SocketAborted ( uint8_t  session)

Event on HTTP server socket aborted (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_SocketClosed ( uint8_t  session)

Event on HTTP server socket closed (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_StartService ( uint16_t  port)

Event on HTTP server start service (Op)

Parameters
portlistening port number
__STATIC_INLINE void EvrNetHTTPs_StopService ( void  )

Event on HTTP server stop service (Op)

__STATIC_INLINE void EvrNetHTTPs_UnauthorizedAccess ( uint8_t  session)

Event on HTTP server unauthorized access (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetHTTPs_UserAccessDeniedIp4 ( const void *  net_addr)

Event on HTTP server user denied access for IPv4 client (Error)

Parameters
net_addrpointer to NET_ADDR4 address structure (8 bytes)
Note
Sends reduced size of net address structure with IPv4 address only.
__STATIC_INLINE void EvrNetHTTPs_UserAccessDeniedIp6 ( const void *  net_addr)

Event on HTTP server user denied access for IPv6 client (Error)

Parameters
net_addrpointer to NET_ADDR address structure (20 bytes)
Note
Sends full size of net address structure with IPv6 address only.