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) | |
__STATIC_INLINE void | EvrNetFTPs_ShowRootFolder (const char *root_folder, uint32_t length) |
Event on FTP server display root folder (Op) | |
__STATIC_INLINE void | EvrNetFTPs_GetSocketFailed (uint8_t session) |
Event on FTP server failed to allocate TCP socket (Error) | |
__STATIC_INLINE void | EvrNetFTPs_SetRootPath (const char *path, uint32_t length) |
Event on FTP server netFTPs_SetRootPath (API) | |
__STATIC_INLINE void | EvrNetFTPs_SetUsername (const char *username, uint32_t length) |
Event on FTP server netFTPs_SetUsername (API) | |
__STATIC_INLINE void | EvrNetFTPs_SetPassword (const char *password, uint32_t length) |
Event on FTP server netFTPs_SetPassword (API) | |
__STATIC_INLINE void | EvrNetFTPs_UserAccessDenied (const void *net_addr) |
Event on FTP server user denied access (Error) | |
__STATIC_INLINE void | EvrNetFTPs_SessionOpen (uint8_t session) |
Event on FTP server session open (Op) | |
__STATIC_INLINE void | EvrNetFTPs_SocketAborted (uint8_t session) |
Event on FTP server socket aborted (Op) | |
__STATIC_INLINE void | EvrNetFTPs_SocketClosed (uint8_t session) |
Event on FTP server socket closed (Op) | |
__STATIC_INLINE void | EvrNetFTPs_UnackedDataError (uint8_t session) |
Event on FTP server unacked data error (Error) | |
__STATIC_INLINE void | EvrNetFTPs_ReceiveFrame (uint8_t session, uint32_t length) |
Event on FTP server receive frame (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FrameTooShort (uint8_t session, uint32_t length, uint32_t min_length) |
Event on FTP server receive frame too short (Error) | |
__STATIC_INLINE void | EvrNetFTPs_ShowCommand (const uint8_t *cmd_client, uint32_t length) |
Event on FTP server display command string (Op) | |
__STATIC_INLINE void | EvrNetFTPs_VerifyUsername (uint8_t session) |
Event on FTP server verify the client username (Op) | |
__STATIC_INLINE void | EvrNetFTPs_VerifyPassword (uint8_t session) |
Event on FTP server verify the client password (Op) | |
__STATIC_INLINE void | EvrNetFTPs_AuthenticationFailed (uint8_t session) |
Event on FTP server authentication failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_UserLoginSuccess (uint8_t session) |
Event on FTP server user login successful (Op) | |
__STATIC_INLINE void | EvrNetFTPs_NotAuthenticated (uint8_t session) |
Event on FTP server command ignored, user not authenticated (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowSystemType (uint8_t session) |
Event on FTP server show system identification type command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_NoOperation (uint8_t session) |
Event on FTP server execute no operation command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_CurrentDirectory (const char *path, uint32_t length) |
Event on FTP server display current working directory (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ChangeDirectory (const char *path, uint32_t length) |
Event on FTP server change working directory command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ChangeDirectoryFailed (uint8_t session) |
Event on FTP server change working directory failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_ChangeDirectoryLevelUp (uint8_t session) |
Event on FTP server change working directory one level up command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_MakeDirectory (const char *path, uint32_t length) |
Event on FTP server make directory command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_OperationDenied (uint8_t session) |
Event on FTP server access or operation denied (Op) | |
__STATIC_INLINE void | EvrNetFTPs_RemoveDirectory (const char *path, uint32_t length) |
Event on FTP server remove directory command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_RemoveDirectoryFailed (uint8_t session) |
Event on FTP server remove directory command failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_DirectoryRemoved (uint8_t session) |
Event on FTP server requested directory successfuly removed (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowDataMode (uint8_t session, uint32_t data_mode) |
Event on FTP server display transfer data mode (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ActiveModeStart (uint8_t session, uint16_t port) |
Event on FTP server start active mode (Op) | |
__STATIC_INLINE void | EvrNetFTPs_PassiveModeStart (uint8_t session, uint16_t local_port) |
Event on FTP server start passive mode (Op) | |
__STATIC_INLINE void | EvrNetFTPs_GetFileSize (const char *fname, uint32_t length) |
Event on FTP server get file size command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_GetFileLastModifiedTime (const char *fname, uint32_t length) |
Event on FTP server get file last-modified time command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ListDirectoryBasic (uint8_t session) |
Event on FTP server list directory names command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ListDirectoryExtended (uint8_t session) |
Event on FTP server list directory in extended format (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ReadFile (const char *fname, uint32_t length) |
Event on FTP server read file command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FileNotFound (uint8_t session) |
Event on FTP server requested file not found (Error) | |
__STATIC_INLINE void | EvrNetFTPs_WriteFile (const char *fname, uint32_t length) |
Event on FTP server write file command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_AppendFile (const char *fname, uint32_t length) |
Event on FTP server append file command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FileCreateFailed (uint8_t session) |
Event on FTP server requested file create failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_DeleteFile (const char *fname, uint32_t length) |
Event on FTP server delete file command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FileDeleteFailed (uint8_t session) |
Event on FTP server requested file delete failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_FileDeleted (uint8_t session) |
Event on FTP server requested file deleted successfuly (Op) | |
__STATIC_INLINE void | EvrNetFTPs_RenameFileFrom (const char *fname, uint32_t length) |
Event on FTP server rename file from name command (Op) | |
__STATIC_INLINE void | EvrNetFTPs_RenameFileTo (const char *new_name, uint32_t length) |
Event on FTP server rename file to new name (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FileRenamed (uint8_t session) |
Event on FTP server requested file renamed successfuly (Op) | |
__STATIC_INLINE void | EvrNetFTPs_FileRenameFailed (uint8_t session) |
Event on FTP server requested file rename failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_UnknownCommand (uint8_t session) |
Event on FTP server unknown command received (Error) | |
__STATIC_INLINE void | EvrNetFTPs_InvalidState (uint8_t session) |
Event on FTP server session in invalid state, command ignored (Error) | |
__STATIC_INLINE void | EvrNetFTPs_InboundConnRejected (uint8_t session) |
Event on FTP server inbound connection rejected for data socket (Error) | |
__STATIC_INLINE void | EvrNetFTPs_DataSocketClosed (uint8_t session) |
Event on FTP server data socket closed when transfer completed (Op) | |
__STATIC_INLINE void | EvrNetFTPs_DataSocketOpen (uint8_t session) |
Event on FTP server data socket open for data transfer (Op) | |
__STATIC_INLINE void | EvrNetFTPs_LocalDiskWriteError (uint8_t session) |
Event on FTP server write to local disk failed, disk full (Error) | |
__STATIC_INLINE void | EvrNetFTPs_StartService (uint16_t port) |
Event on FTP server start service (Op) | |
__STATIC_INLINE void | EvrNetFTPs_StopService (void) |
Event on FTP server stop service (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowFileFindMask (const char *path, uint32_t length) |
Event on FTP server display find file(s) mask filter (Op) | |
__STATIC_INLINE void | EvrNetFTPs_MakeDirectoryFailed (uint8_t session) |
Event on FTP server requested directory create failed (Error) | |
__STATIC_INLINE void | EvrNetFTPs_DirectoryCreated (uint8_t session) |
Event on FTP server requested directory created successfuly (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowFileSize (uint8_t session, uint32_t file_size) |
Event on FTP server display requested file size (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowFileLastModifiedTime (uint8_t session, const char *file_time, uint32_t length) |
Event on FTP server display requested file last-modified time (Op) | |
__STATIC_INLINE void | EvrNetFTPs_CloseDataConnection (uint8_t session) |
Event on FTP server closing data connection (Op) | |
__STATIC_INLINE void | EvrNetFTPs_CloseSession (uint8_t session) |
Event on FTP server closing session (Op) | |
__STATIC_INLINE void | EvrNetFTPs_SessionIdle (uint8_t session) |
Event on FTP server session in idle state (Op) | |
__STATIC_INLINE void | EvrNetFTPs_ShowPath (const char *path, uint32_t length) |
Event on FTP server display an absolute path for file access (Op) | |
__STATIC_INLINE void | EvrNetFTPs_UninitServer (void) |
Event on FTP server de-initialize (Op) | |
Events generated by the Network - FTP Server functions.
The FTP server functions generate events that make it easier to troubleshoot errors, and allow the user to understand how the FTP server works.
__STATIC_INLINE void EvrNetFTPs_ActiveModeStart | ( | uint8_t | session, |
uint16_t | port | ||
) |
Event on FTP server start active mode (Op)
session | session number |
port | port number to connect to |
The event ActiveModeStart is created when the FTP server starts active FTP mode.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_AppendFile | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server append file command (Op)
fname | name of the file to append |
length | length of the fname string |
The event AppendFile is created when the FTP server executes the APPE command to append the data to the existing file on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_AuthenticationFailed | ( | uint8_t | session | ) |
Event on FTP server authentication failed (Error)
session | session number |
The event AuthenticationFailed is created when the FTP server executes the PASS command to authenticate the user.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ChangeDirectory | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server change working directory command (Op)
path | path to the new working directory |
length | length of the path string |
The event ChangeDirectory is created when the FTP server wants to change the working directory to a specified directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ChangeDirectoryFailed | ( | uint8_t | session | ) |
Event on FTP server change working directory failed (Error)
session | session number |
The event ChangeDirectoryFailed is created when the FTP server wants to change the working directory to a specified directory, but the specified directory does not exist. The same event occurs if the file system on the storage device does not support directories, such as the Embedded File System in the MDK Middleware.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ChangeDirectoryLevelUp | ( | uint8_t | session | ) |
Event on FTP server change working directory one level up command (Op)
session | session number |
The event ChangeDirectoryLevelUp is created when the FTP server wants to change the working directory to the parent directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_CloseDataConnection | ( | uint8_t | session | ) |
Event on FTP server closing data connection (Op)
session | session number |
The event CloseDataConnection is created when the FTP server closes the data connection. This happens when the requested command, such as a list directory or a read file, is completed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_CloseSession | ( | uint8_t | session | ) |
Event on FTP server closing session (Op)
session | session number |
The event CloseSession is created when the FTP server closes the active user session, that is, when the QUIT command is executed. When the session ends, the user is disconnected from the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_CurrentDirectory | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server display current working directory (Op)
path | path to the working directory |
length | length of the path string |
The event CurrentDirectory is created when the FTP server wants to display the current working directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_DataSocketClosed | ( | uint8_t | session | ) |
Event on FTP server data socket closed when transfer completed (Op)
session | session number |
The event DataSocketClosed is created when the FTP client has closed the data connection to the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_DataSocketOpen | ( | uint8_t | session | ) |
Event on FTP server data socket open for data transfer (Op)
session | session number |
The event DataSocketOpen is created when a data connection to the FTP server is established.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_DeleteFile | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server delete file command (Op)
fname | name of the file to delete |
length | length of the fname string |
The event DeleteFile is created when the FTP server executes the DELE command to delete the file on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_DirectoryCreated | ( | uint8_t | session | ) |
Event on FTP server requested directory created successfuly (Op)
session | session number |
The event DirectoryCreated is created when the requested directory is successfully created on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_DirectoryRemoved | ( | uint8_t | session | ) |
Event on FTP server requested directory successfuly removed (Op)
session | session number |
The event DirectoryRemoved is created when the FTP server successfully removes the specified directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileCreateFailed | ( | uint8_t | session | ) |
Event on FTP server requested file create failed (Error)
session | session number |
The event FileCreateFailed is created when the requested file cannot be created on the FTP server. A possible reason for this may be the write-protected SD card.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileDeleted | ( | uint8_t | session | ) |
Event on FTP server requested file deleted successfuly (Op)
session | session number |
The event FileDeleted is created when the requested file is successfully deleted on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileDeleteFailed | ( | uint8_t | session | ) |
Event on FTP server requested file delete failed (Error)
session | session number |
The event FileDeleteFailed is created when the requested file cannot be deleted on the FTP server. A possible reason for this may be the write-protected SD card.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileNotFound | ( | uint8_t | session | ) |
Event on FTP server requested file not found (Error)
session | session number |
The event FileNotFound is created when the requested file cannot be found on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileRenamed | ( | uint8_t | session | ) |
Event on FTP server requested file renamed successfuly (Op)
session | session number |
The event FileRenamed is created when the requested file is successfully renamed on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FileRenameFailed | ( | uint8_t | session | ) |
Event on FTP server requested file rename failed (Error)
session | session number |
The event FileRenameFailed is created when the requested file cannot be renamed on the FTP server. A possible reason for this may be the write-protected SD card.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_FrameTooShort | ( | uint8_t | session, |
uint32_t | length, | ||
uint32_t | min_length | ||
) |
Event on FTP server receive frame too short (Error)
session | session number |
length | frame length in bytes |
min_length | minimum length of the frame |
The event FrameTooShort is created when the FTP server receives the frame that is too short. The frame is then discarded.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_GetFileLastModifiedTime | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server get file last-modified time command (Op)
fname | name of the file |
length | length of the fname string |
The event GetFileLastModifiedTime is created when the FTP server executes the MDTM command to obtain the last time the file was modified on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_GetFileSize | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server get file size command (Op)
fname | name of the file |
length | length of the fname string |
The event GetFileSize is created when the FTP server executes the SIZE command to retrieve the size of the file that is stored on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_GetSocketFailed | ( | uint8_t | session | ) |
Event on FTP server failed to allocate TCP socket (Error)
session | session number |
The event GetSocketFailed is created when the FTP 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:
__STATIC_INLINE void EvrNetFTPs_InboundConnRejected | ( | uint8_t | session | ) |
Event on FTP server inbound connection rejected for data socket (Error)
session | session number |
The event InboundConnRejected is created when the FTP client initiated a data connection to an FTP server in FTP active mode. The connection request was therefore rejected. In FTP active mode, the FTP server should establish a data connection.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_InitServer | ( | uint32_t | num_sessions, |
uint16_t | port, | ||
uint16_t | idle_tout | ||
) |
Event on FTP server initialize (Op)
num_sessions | number of available FTP sessions |
port | listening port number |
idle_tout | idle timeout in seconds (0= permanent connection) |
The event InitServer is created when the FTP server is initialized, that is, when the function netInitialize is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_InvalidState | ( | uint8_t | session | ) |
Event on FTP server session in invalid state, command ignored (Error)
session | session number |
The event InvalidState is created when the command is received in an FTP server state that cannot process the command. The command is therefore discarded. A possible reason may be that the FTP client issued the command before the client was authenticated.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ListDirectoryBasic | ( | uint8_t | session | ) |
Event on FTP server list directory names command (Op)
session | session number |
The event ListDirectoryBasic is created when the FTP server executes the NLST command for a list of files in basic format, these are file names only.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ListDirectoryExtended | ( | uint8_t | session | ) |
Event on FTP server list directory in extended format (Op)
session | session number |
The event ListDirectoryExtended is created when the FTP server executes the LIST command for a list of files in extended format, such as file names, file sizes, last modified time, etc.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_LocalDiskWriteError | ( | uint8_t | session | ) |
Event on FTP server write to local disk failed, disk full (Error)
session | session number |
The event LocalDiskWriteError is created when the FTP server fails to write data to a file on the FTP server. This usually happens when the storage quota is exceeded or the storage medium is full.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_MakeDirectory | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server make directory command (Op)
path | path to the new directory to make |
length | length of the path string |
The event MakeDirectory is created when the FTP server wants to create a new directory in the working directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_MakeDirectoryFailed | ( | uint8_t | session | ) |
Event on FTP server requested directory create failed (Error)
session | session number |
The event MakeDirectoryFailed is created when the requested directory cannot be created on the FTP server. A possible reason for this may be the write-protected SD card.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_NoOperation | ( | uint8_t | session | ) |
Event on FTP server execute no operation command (Op)
session | session number |
The event NoOperation is created when the FTP server executes the NOOP command - no operation.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_NotAuthenticated | ( | uint8_t | session | ) |
Event on FTP server command ignored, user not authenticated (Op)
session | session number |
The event NotAuthenticated is created when the FTP server fails to authenticate the user. Each command of an unverified user is ignored.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_OperationDenied | ( | uint8_t | session | ) |
Event on FTP server access or operation denied (Op)
session | session number |
The event OperationDenied is created when the FTP server denies access to the file or directory for the user. This happens when the user application returns false in the netFTPs_FileAccess function.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_PassiveModeStart | ( | uint8_t | session, |
uint16_t | local_port | ||
) |
Event on FTP server start passive mode (Op)
session | session number |
local_port | local port number to accept data connection |
The event PassiveModeStart is created when the FTP server starts passive FTP mode.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ReadFile | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server read file command (Op)
fname | name of the file to read |
length | length of the fname string |
The event ReadFile is created when the FTP server executes the RETR command to retrieve the file stored on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ReceiveFrame | ( | uint8_t | session, |
uint32_t | length | ||
) |
Event on FTP server receive frame (Op)
session | session number |
length | frame length in bytes |
The event ReceiveFrame is created when the FTP server receives the frame.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_RemoveDirectory | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server remove directory command (Op)
path | path to the directory to remove |
length | length of the path string |
The event RemoveDirectory is created when the FTP server wants to remove the specified directory from the working directory.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_RemoveDirectoryFailed | ( | uint8_t | session | ) |
Event on FTP server remove directory command failed (Error)
session | session number |
The event RemoveDirectoryFailed is created when the FTP server wants to remove the specified directory from the working directory, but the specified directory is not empty, and therefore the removal fails.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_RenameFileFrom | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server rename file from name command (Op)
fname | name of the file to rename |
length | length of the fname string |
The event RenameFileFrom is created when the FTP server executes the RNFR command to rename the file on the FTP server. The command specifies the name of the file to be renamed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_RenameFileTo | ( | const char * | new_name, |
uint32_t | length | ||
) |
Event on FTP server rename file to new name (Op)
new_name | new name of the file to rename to |
length | length of the fname string |
The event RenameFileTo is created when the FTP server executes the RNTO command to rename the file on the FTP server. The command specifies the new name of the file to be renamed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SessionIdle | ( | uint8_t | session | ) |
Event on FTP server session in idle state (Op)
session | session number |
The event SessionIdle is created when the FTP server session ends, that is when both socket connections are broken and the user session idle. The session is then ready to accept a new user.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SessionOpen | ( | uint8_t | session | ) |
Event on FTP server session open (Op)
session | session number |
The event SessionOpen is created when the FTP server accepts a request to connect from the client and opens a server session to handle this connection. This happens when the FTP client attempts to connect to the server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SetPassword | ( | const char * | password, |
uint32_t | length | ||
) |
Event on FTP server netFTPs_SetPassword (API)
password | new password |
length | length of the password string |
The event SetPassword is created when the FTP server changes the password for the administrator account. This happens when the netFTPs_SetPassword function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SetRootPath | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server netFTPs_SetRootPath (API)
path | path to server root folder |
length | length of the path string |
The event SetRootPath is created when the FTP server changes the path to server files. This happens when the netFTPs_SetRootPath function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SetUsername | ( | const char * | username, |
uint32_t | length | ||
) |
Event on FTP server netFTPs_SetUsername (API)
username | new username |
length | length of the username string |
The event SetUsername is created when the FTP server changes the username for the administrator account. This happens when the netFTPs_SetUsername function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowCommand | ( | const uint8_t * | cmd_client, |
uint32_t | length | ||
) |
Event on FTP server display command string (Op)
cmd_client | command received from the client in text format |
length | length of the cmd_client string |
The event ShowCommand is created when the FTP server wants to display a FTP command it receives from the client.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowDataMode | ( | uint8_t | session, |
uint32_t | data_mode | ||
) |
Event on FTP server display transfer data mode (Op)
session | session number |
data_mode | transfer data mode
|
The event ShowDataMode is created when the network library wants to display the data transfer method that will start.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowFileFindMask | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server display find file(s) mask filter (Op)
path | path to list directory |
length | length of the path string |
The event ShowFileFindMask is created when the FTP server wants to display the search file mask and search file path. This concatenated string is then passed to the netFTPs_ffind function.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowFileLastModifiedTime | ( | uint8_t | session, |
const char * | file_time, | ||
uint32_t | length | ||
) |
Event on FTP server display requested file last-modified time (Op)
session | session number |
file_time | last-modified time of a file in text format |
length | length of the file_time string |
The event ShowFileLastModifiedTime is created when the FTP server wants to display the time the file was last modified on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowFileSize | ( | uint8_t | session, |
uint32_t | file_size | ||
) |
Event on FTP server display requested file size (Op)
session | session number |
file_size | size of a file in bytes |
The event ShowFileSize is created when the FTP server wants to display the size of the requested file.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowPath | ( | const char * | path, |
uint32_t | length | ||
) |
Event on FTP server display an absolute path for file access (Op)
path | absolute path for file access |
length | length of the path string |
The event ShowPath is created when the FTP server wants to display the absolute path to the file on the FTP server. This path is then used to access the requested file.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowRootFolder | ( | const char * | root_folder, |
uint32_t | length | ||
) |
Event on FTP server display root folder (Op)
root_folder | path to server root folder |
length | length of the root_folder string |
The event ShowRootFolder is created when the network library wants to display the path to the root folder that contains the FTP server files. This event is generated only if the root folder is enabled in the FTP server configuration.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_ShowSystemType | ( | uint8_t | session | ) |
Event on FTP server show system identification type command (Op)
session | session number |
The event ShowSystemType is created when the FTP server executes the SYST command to identify the operating system at the server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SocketAborted | ( | uint8_t | session | ) |
Event on FTP server socket aborted (Op)
session | session number |
The event SocketAborted is created when the FTP server connection is unexpectedly terminated from the client. The corresponding server session is then closed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_SocketClosed | ( | uint8_t | session | ) |
Event on FTP server socket closed (Op)
session | session number |
The event SocketClosed is created when the FTP server connection is unexpectedly closed from the client. The corresponding server session is then closed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_StartService | ( | uint16_t | port | ) |
Event on FTP server start service (Op)
port | listening port number |
The event StartService is created when the network library starts the FTP server service. This happens automatically if the auto-start services are enabled, or when the netFTPs_Start function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_StopService | ( | void | ) |
Event on FTP server stop service (Op)
The event StopService is created when the network library stops the FTP server service. This happens when the netFTPs_Stop function is executed.
__STATIC_INLINE void EvrNetFTPs_UnackedDataError | ( | uint8_t | session | ) |
Event on FTP server unacked data error (Error)
session | session number |
The event UnackedDataError is created when the FTP server receives a new command from the client, but the client has not yet acknowledged the response to the previous command. The new FTP command is then discarded.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_UninitServer | ( | void | ) |
Event on FTP server de-initialize (Op)
The event UninitServer is created when the function netUninitialize is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_UnknownCommand | ( | uint8_t | session | ) |
Event on FTP server unknown command received (Error)
session | session number |
The event UnknownCommand is created when the requested command is not recognized on the FTP server. A possible reason for this may be that the FTP client issued a command that is not supported on the FTP server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_UserAccessDenied | ( | const void * | net_addr | ) |
Event on FTP server user denied access (Error)
net_addr | pointer to NET_ADDR address structure |
The event UserAccessDenied is created when the FTP server rejects the pending connection request for the client, because the user application has denied connection for this client. This happens when the netFTPs_AcceptClient function returns false.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_UserLoginSuccess | ( | uint8_t | session | ) |
Event on FTP server user login successful (Op)
session | session number |
The event UserLoginSuccess is created when the FTP server successfully authenticates the user.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_VerifyPassword | ( | uint8_t | session | ) |
Event on FTP server verify the client password (Op)
session | session number |
The event VerifyPassword is created when the FTP server executes the PASS command to authenticate the user.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_VerifyUsername | ( | uint8_t | session | ) |
Event on FTP server verify the client username (Op)
session | session number |
The event VerifyUsername is created when the FTP server executes the USER command to authenticate the user.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetFTPs_WriteFile | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on FTP server write file command (Op)
fname | name of the file to write |
length | length of the fname string |
The event WriteFile is created when the FTP server executes the STOR command to save the file to the FTP server.
Value in the Event Recorder shows: