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

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

Functions

__STATIC_INLINE void EvrNetFTPs_InitServer (uint32_t num_sessions, uint16_t port, uint16_t idle_tout)
 Event on FTP server initialize (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowRootFolder (const char *root_folder, uint32_t length)
 Event on FTP server display root folder (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_GetSocketFailed (uint8_t session)
 Event on FTP server failed to allocate TCP socket (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_SetRootPath (const char *path, uint32_t length)
 Event on FTP server netFTPs_SetRootPath (API) More...
 
__STATIC_INLINE void EvrNetFTPs_SetUsername (const char *username, uint32_t length)
 Event on FTP server netFTPs_SetUsername (API) More...
 
__STATIC_INLINE void EvrNetFTPs_SetPassword (const char *password, uint32_t length)
 Event on FTP server netFTPs_SetPassword (API) More...
 
__STATIC_INLINE void EvrNetFTPs_UserAccessDeniedIp4 (const void *net_addr)
 Event on FTP server user denied access for IPv4 client (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_UserAccessDeniedIp6 (const void *net_addr)
 Event on FTP server user denied access for IPv6 client (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_SessionOpen (uint8_t session)
 Event on FTP server session open (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_SocketAborted (uint8_t session)
 Event on FTP server socket aborted (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_SocketClosed (uint8_t session)
 Event on FTP server socket closed (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_UnackedDataError (uint8_t session)
 Event on FTP server unacked data error (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_ReceiveFrame (uint8_t session, uint32_t length)
 Event on FTP server receive frame (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FrameTooShort (uint8_t session, uint32_t length, uint32_t min_length)
 Event on FTP server receive frame too short (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowCommand (const uint8_t *cmd_client, uint32_t length)
 Event on FTP server display command string (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_VerifyUsername (uint8_t session)
 Event on FTP server verify the client username (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_VerifyPassword (uint8_t session)
 Event on FTP server verify the client password (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_AuthenticationFailed (uint8_t session)
 Event on FTP server authentication failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_UserLoginSuccess (uint8_t session)
 Event on FTP server user login successful (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_NotAuthenticated (uint8_t session)
 Event on FTP server command ignored, user not authenticated (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowSystemType (uint8_t session)
 Event on FTP server show system identification type command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_NoOperation (uint8_t session)
 Event on FTP server execute no operation command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_CurrentDirectory (const char *path, uint32_t length)
 Event on FTP server display current working directory (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ChangeDirectory (const char *path, uint32_t length)
 Event on FTP server change working directory command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ChangeDirectoryLevelUp (uint8_t session)
 Event on FTP server change working directory one level up command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_MakeDirectory (const char *path, uint32_t length)
 Event on FTP server make directory command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_OperationDenied (uint8_t session)
 Event on FTP server access or operation denied (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_RemoveDirectory (const char *path, uint32_t length)
 Event on FTP server remove directory command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_RemoveDirectoryFailed (uint8_t session)
 Event on FTP server remove directory command failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_DirectoryRemoved (uint8_t session)
 Event on FTP server requested directory successfuly removed (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowDataMode (uint8_t session, uint32_t data_mode)
 Event on FTP server display transfer data mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ActiveModeStart (uint8_t session, uint16_t port)
 Event on FTP server start active mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_PassiveModeStart (uint8_t session, uint16_t local_port)
 Event on FTP server start passive mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_GetFileSize (const char *fname, uint32_t length)
 Event on FTP server get file size command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_GetFileLastModifiedTime (const char *fname, uint32_t length)
 Event on FTP server get file last-modified time command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ListDirectoryBasic (uint8_t session)
 Event on FTP server list directory names command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ListDirectoryExtended (uint8_t session)
 Event on FTP server list directory in extended format (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ReadFile (const char *fname, uint32_t length)
 Event on FTP server read file command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FileNotFound (uint8_t session)
 Event on FTP server requested file not found (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_WriteFile (const char *fname, uint32_t length)
 Event on FTP server write file command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_AppendFile (const char *fname, uint32_t length)
 Event on FTP server append file command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FileCreateFailed (uint8_t session)
 Event on FTP server requested file create failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_DeleteFile (const char *fname, uint32_t length)
 Event on FTP server delete file command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FileDeleteFailed (uint8_t session)
 Event on FTP server requested file delete failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_FileDeleted (uint8_t session)
 Event on FTP server requested file deleted successfuly (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_RenameFileFrom (const char *fname, uint32_t length)
 Event on FTP server rename file from name command (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_RenameFileTo (const char *new_name, uint32_t length)
 Event on FTP server rename file to new name (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FileRenamed (uint8_t session)
 Event on FTP server requested file renamed successfuly (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_FileRenameFailed (uint8_t session)
 Event on FTP server requested file rename failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_UnknownCommand (uint8_t session)
 Event on FTP server unknown command received (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_InvalidState (uint8_t session)
 Event on FTP server session in invalid state, command ignored (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_InboundConnRejected (uint8_t session)
 Event on FTP server inbound connection rejected for data socket (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_DataSocketClosed (uint8_t session)
 Event on FTP server data socket closed when transfer completed (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_DataSocketOpen (uint8_t session)
 Event on FTP server data socket open for data transfer (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_LocalDiskWriteError (uint8_t session)
 Event on FTP server write to local disk failed, disk full (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_StartService (uint16_t port)
 Event on FTP server start service (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_StopService (void)
 Event on FTP server stop service (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowFileFindMask (const char *path, uint32_t length)
 Event on FTP server display find file(s) mask filter (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_MakeDirectoryFailed (uint8_t session)
 Event on FTP server requested directory create failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPs_DirectoryCreated (uint8_t session)
 Event on FTP server requested directory created successfuly (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowFileSize (const char *file_size, uint32_t length)
 Event on FTP server display requested file size (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowFileLastModifiedTime (const char *file_time, uint32_t length)
 Event on FTP server display requested file last-modified time (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_CloseDataConnection (uint8_t session)
 Event on FTP server closing data connection (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_CloseSession (uint8_t session)
 Event on FTP server closing session (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_SessionIdle (uint8_t session)
 Event on FTP server session in idle state (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_ShowPath (const char *path, uint32_t length)
 Event on FTP server display an absolute path for file access (Op) More...
 
__STATIC_INLINE void EvrNetFTPs_UninitServer (void)
 Event on FTP server de-initialize (Op) More...
 

Description

Events generated by the Network - FTP Server functions.

Function Documentation

__STATIC_INLINE void EvrNetFTPs_ActiveModeStart ( uint8_t  session,
uint16_t  port 
)

Event on FTP server start active mode (Op)

Parameters
sessionsession number
portport number to connect to
__STATIC_INLINE void EvrNetFTPs_AppendFile ( const char *  fname,
uint32_t  length 
)

Event on FTP server append file command (Op)

Parameters
fnamename of the file to append
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_AuthenticationFailed ( uint8_t  session)

Event on FTP server authentication failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_ChangeDirectory ( const char *  path,
uint32_t  length 
)

Event on FTP server change working directory command (Op)

Parameters
pathpath to the new working directory
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_ChangeDirectoryLevelUp ( uint8_t  session)

Event on FTP server change working directory one level up command (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_CloseDataConnection ( uint8_t  session)

Event on FTP server closing data connection (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_CloseSession ( uint8_t  session)

Event on FTP server closing session (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_CurrentDirectory ( const char *  path,
uint32_t  length 
)

Event on FTP server display current working directory (Op)

Parameters
pathpath to the working directory
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_DataSocketClosed ( uint8_t  session)

Event on FTP server data socket closed when transfer completed (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_DataSocketOpen ( uint8_t  session)

Event on FTP server data socket open for data transfer (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_DeleteFile ( const char *  fname,
uint32_t  length 
)

Event on FTP server delete file command (Op)

Parameters
fnamename of the file to delete
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_DirectoryCreated ( uint8_t  session)

Event on FTP server requested directory created successfuly (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_DirectoryRemoved ( uint8_t  session)

Event on FTP server requested directory successfuly removed (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileCreateFailed ( uint8_t  session)

Event on FTP server requested file create failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileDeleted ( uint8_t  session)

Event on FTP server requested file deleted successfuly (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileDeleteFailed ( uint8_t  session)

Event on FTP server requested file delete failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileNotFound ( uint8_t  session)

Event on FTP server requested file not found (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileRenamed ( uint8_t  session)

Event on FTP server requested file renamed successfuly (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FileRenameFailed ( uint8_t  session)

Event on FTP server requested file rename failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_FrameTooShort ( uint8_t  session,
uint32_t  length,
uint32_t  min_length 
)

Event on FTP server receive frame too short (Error)

Parameters
sessionsession number
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetFTPs_GetFileLastModifiedTime ( const char *  fname,
uint32_t  length 
)

Event on FTP server get file last-modified time command (Op)

Parameters
fnamename of the file
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_GetFileSize ( const char *  fname,
uint32_t  length 
)

Event on FTP server get file size command (Op)

Parameters
fnamename of the file
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_GetSocketFailed ( uint8_t  session)

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

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_InboundConnRejected ( uint8_t  session)

Event on FTP server inbound connection rejected for data socket (Error)

Parameters
sessionsession number
Remarks
Inbound data connections are accepted in passive mode, rejected in active mode.
__STATIC_INLINE void EvrNetFTPs_InitServer ( uint32_t  num_sessions,
uint16_t  port,
uint16_t  idle_tout 
)

Event on FTP server initialize (Op)

Parameters
num_sessionsnumber of available FTP sessions
portlistening port number
idle_toutidle timeout in seconds (0= permanent connection)
__STATIC_INLINE void EvrNetFTPs_InvalidState ( uint8_t  session)

Event on FTP server session in invalid state, command ignored (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_ListDirectoryBasic ( uint8_t  session)

Event on FTP server list directory names command (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_ListDirectoryExtended ( uint8_t  session)

Event on FTP server list directory in extended format (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_LocalDiskWriteError ( uint8_t  session)

Event on FTP server write to local disk failed, disk full (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_MakeDirectory ( const char *  path,
uint32_t  length 
)

Event on FTP server make directory command (Op)

Parameters
pathpath to the new directory to make
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_MakeDirectoryFailed ( uint8_t  session)

Event on FTP server requested directory create failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_NoOperation ( uint8_t  session)

Event on FTP server execute no operation command (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_NotAuthenticated ( uint8_t  session)

Event on FTP server command ignored, user not authenticated (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_OperationDenied ( uint8_t  session)

Event on FTP server access or operation denied (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_PassiveModeStart ( uint8_t  session,
uint16_t  local_port 
)

Event on FTP server start passive mode (Op)

Parameters
sessionsession number
local_portlocal port number to accept data connection
__STATIC_INLINE void EvrNetFTPs_ReadFile ( const char *  fname,
uint32_t  length 
)

Event on FTP server read file command (Op)

Parameters
fnamename of the file to read
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_ReceiveFrame ( uint8_t  session,
uint32_t  length 
)

Event on FTP server receive frame (Op)

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

Event on FTP server remove directory command (Op)

Parameters
pathpath to the directory to remove
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_RemoveDirectoryFailed ( uint8_t  session)

Event on FTP server remove directory command failed (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_RenameFileFrom ( const char *  fname,
uint32_t  length 
)

Event on FTP server rename file from name command (Op)

Parameters
fnamename of the file to rename
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_RenameFileTo ( const char *  new_name,
uint32_t  length 
)

Event on FTP server rename file to new name (Op)

Parameters
new_namenew name of the file to rename to
lengthlength of the fname string
__STATIC_INLINE void EvrNetFTPs_SessionIdle ( uint8_t  session)

Event on FTP server session in idle state (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_SessionOpen ( uint8_t  session)

Event on FTP server session open (Op)

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

Event on FTP server netFTPs_SetPassword (API)

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

Event on FTP server netFTPs_SetRootPath (API)

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

Event on FTP server netFTPs_SetUsername (API)

Parameters
usernamenew username
lengthlength of the username string
__STATIC_INLINE void EvrNetFTPs_ShowCommand ( const uint8_t *  cmd_client,
uint32_t  length 
)

Event on FTP server display command string (Op)

Parameters
cmd_clientcommand received from the client in text format
lengthlength of the cmd_client string
__STATIC_INLINE void EvrNetFTPs_ShowDataMode ( uint8_t  session,
uint32_t  data_mode 
)

Event on FTP server display transfer data mode (Op)

Parameters
sessionsession number
data_modetransfer data mode
  • 0: Binary mode
  • 1: ASCII mode
__STATIC_INLINE void EvrNetFTPs_ShowFileFindMask ( const char *  path,
uint32_t  length 
)

Event on FTP server display find file(s) mask filter (Op)

Parameters
pathpath to list directory
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_ShowFileLastModifiedTime ( const char *  file_time,
uint32_t  length 
)

Event on FTP server display requested file last-modified time (Op)

Parameters
file_timelast-modified time of a file in text format
lengthlength of the file_time string
__STATIC_INLINE void EvrNetFTPs_ShowFileSize ( const char *  file_size,
uint32_t  length 
)

Event on FTP server display requested file size (Op)

Parameters
file_sizesize of a file in text format
lengthlength of the file_size string
__STATIC_INLINE void EvrNetFTPs_ShowPath ( const char *  path,
uint32_t  length 
)

Event on FTP server display an absolute path for file access (Op)

Parameters
pathabsolute path for file access
lengthlength of the path string
__STATIC_INLINE void EvrNetFTPs_ShowRootFolder ( const char *  root_folder,
uint32_t  length 
)

Event on FTP server display root folder (Op)

Parameters
root_folderpath to server root folder
lengthlength of the root_folder string
__STATIC_INLINE void EvrNetFTPs_ShowSystemType ( uint8_t  session)

Event on FTP server show system identification type command (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_SocketAborted ( uint8_t  session)

Event on FTP server socket aborted (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_SocketClosed ( uint8_t  session)

Event on FTP server socket closed (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_StartService ( uint16_t  port)

Event on FTP server start service (Op)

Parameters
portlistening port number
__STATIC_INLINE void EvrNetFTPs_StopService ( void  )

Event on FTP server stop service (Op)

__STATIC_INLINE void EvrNetFTPs_UnackedDataError ( uint8_t  session)

Event on FTP server unacked data error (Error)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_UninitServer ( void  )

Event on FTP server de-initialize (Op)

__STATIC_INLINE void EvrNetFTPs_UnknownCommand ( uint8_t  session)

Event on FTP server unknown command received (Error)

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

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

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

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

Parameters
net_addrpointer to NET_ADDR address structure (20 bytes)
Remarks
Sends full size of net address structure with IPv6 address only.
__STATIC_INLINE void EvrNetFTPs_UserLoginSuccess ( uint8_t  session)

Event on FTP server user login successful (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_VerifyPassword ( uint8_t  session)

Event on FTP server verify the client password (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_VerifyUsername ( uint8_t  session)

Event on FTP server verify the client username (Op)

Parameters
sessionsession number
__STATIC_INLINE void EvrNetFTPs_WriteFile ( const char *  fname,
uint32_t  length 
)

Event on FTP server write file command (Op)

Parameters
fnamename of the file to write
lengthlength of the fname string