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

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

Functions

__STATIC_INLINE void EvrNetFTPc_InitClient (uint32_t mode)
 Event on FTP client initialize (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_GetSocketFailed (void)
 Event on FTP client failed to allocate TCP socket (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_Connect (const void *net_addr)
 Event on FTP client netFTPc_Connect to the server (API) More...
 
__STATIC_INLINE void EvrNetFTPc_ConnectInvalidParameter (void)
 Event on netFTPc_Connect invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_ConnectClientBusy (void)
 Event on netFTPc_Connect failed, client busy (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_InboundConnRejected (int32_t socket)
 Event on FTP client inbound connection rejected (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_SocketAborted (int32_t socket)
 Event on FTP client socket aborted (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_SocketConnected (int32_t socket)
 Event on FTP client socket connected (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_SocketClosed (int32_t socket)
 Event on FTP client socket closed (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_ReceiveFrame (int32_t socket, uint32_t length)
 Event on FTP client received frame (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on FTP receive frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_ShowReplyCode (const uint8_t *reply_code)
 Event on FTP client display numeric reply code received from server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_ResponseFragmented (void)
 Event on FTP client response divided into multiple frames (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_ServerReady (void)
 Event on FTP client server ready response (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_UserOkNeedPassword (void)
 Event on FTP client username ok, password needed (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_UserLoginFailed (void)
 Event on FTP client user login to server failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_UserLoginSuccess (void)
 Event on FTP client user login successful (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_WorkingDirectoryInvalid (void)
 Event on FTP client change working directory failed, invalid path (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_ExecuteUserCommand (uint8_t command)
 Event on FTP client server ready response (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_BinaryModeEnabled (void)
 Event on FTP client binary transfer mode enabled (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_PasvCommandFailed (void)
 Event on FTP client PASV command failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_PassiveModeStart (uint16_t port)
 Event on FTP client start passive server mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_PortCommandFailed (void)
 Event on FTP client PORT command failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_ActiveModeStart (uint16_t local_port)
 Event on FTP client start active server mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_FileNotFoundOnServer (void)
 Event on FTP client error, requested file not found on server (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_OperationNotAllowed (void)
 Event on FTP client error, operation not allowed on server (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_AboutToOpenDataConn (int32_t socket)
 Event on FTP client about to open data connection (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_DataConnAlreadyOpen (int32_t socket)
 Event on FTP client data connection already opened (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_TransferAborted (void)
 Event on FTP client data transfer aborted (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_TransferCompleted (void)
 Event on FTP client data transfer completed successfully (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_FileDeleted (void)
 Event on FTP client file deleted on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_NewNameRequired (void)
 Event on FTP client new name required to rename a file on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_FileOrDirectoryRenamed (void)
 Event on FTP client file or directory renamed successfully on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_DirectoryCreated (void)
 Event on FTP client directory successfully created on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_FileOrPathNotFound (void)
 Event on FTP client requested file or path not found on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_DirectoryRemoved (void)
 Event on FTP client directory removed on the server (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_CommandErrorResponse (void)
 Event on FTP client command error response received (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_WrongResponse (const uint8_t *response, uint32_t length)
 Event on FTP client wrong response received (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_DataSocketClosed (int32_t socket)
 Event on FTP client data socket closed (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_DataSocketOpened (int32_t socket)
 Event on FTP client data socket opened (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_LocalDiskWriteError (void)
 Event on FTP client write to local disk failed, disk full (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_ClientStopTimeoutExpired (void)
 Event on FTP client stop operation timeout expired (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_LocalPortAssigned (uint16_t local_port)
 Event on FTP client local port assigned for server active mode (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_OpenLocalFile (const char *local_fname, uint32_t length)
 Event on FTP client open local file (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_LocalFileCreateFailed (void)
 Event on FTP client local file create failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_LocalFileNotFound (void)
 Event on FTP client local file not found (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_OpenDataConnFailed (int32_t socket)
 Event on FTP client open data connection failed (Error) More...
 
__STATIC_INLINE void EvrNetFTPc_SendCommand (const uint8_t *command, uint32_t length)
 Event on FTP client send command to server (Detail) More...
 
__STATIC_INLINE void EvrNetFTPc_ClientCloseSocket (int32_t socket)
 Event on FTP client close control socket (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_ClientDone (uint8_t cb_event)
 Event on FTP client completed operation (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_CloseLocalFile (void)
 Event on FTP client close local file (Op) More...
 
__STATIC_INLINE void EvrNetFTPc_UninitClient (void)
 Event on FTP client de-initialize (Op) More...
 

Description

Events generated by the Network - FTP Client functions.

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

Function Documentation

__STATIC_INLINE void EvrNetFTPc_AboutToOpenDataConn ( int32_t  socket)

Event on FTP client about to open data connection (Op)

Parameters
socketassigned TCP data socket

The event AboutToOpenDataConn is created when the requested command needs a data connection, and the FTP client is about to open it.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_ActiveModeStart ( uint16_t  local_port)

Event on FTP client start active server mode (Op)

Parameters
local_portlocal port number to accept connection

The event ActiveModeStart is created when the FTP client successfully activates the active FTP mode on the server. The client then opens the data port on which the FTP server connects to establish a data connection.

Value in the Event Recorder shows:

  • local_port: port on FTP client for data connection.
__STATIC_INLINE void EvrNetFTPc_BinaryModeEnabled ( void  )

Event on FTP client binary transfer mode enabled (Op)

The event BinaryModeEnabled is created when the FTP client changes the transfer mode to binary, which is then used to transfer the files.

__STATIC_INLINE void EvrNetFTPc_ClientCloseSocket ( int32_t  socket)

Event on FTP client close control socket (Op)

Parameters
socketassigned TCP control socket

The event ClientCloseSocket is created when the FTP client session ends and the control socket must disconnect from the server.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_ClientDone ( uint8_t  cb_event)

Event on FTP client completed operation (Op)

Parameters
cb_eventuser callback nofication event
  • 0: File operation successful
  • 1: Timeout on file operation
  • 2: Login error, username/password invalid
  • 3: File access not allowed
  • 4: File not found
  • 5: Working directory path not found
  • 6: Local file read/write error
  • 7: Generic FTP client error

The event ClientDone is created when the FTP client operation is complete and the client session ends. The user is then notified of the completion event.

Value in the Event Recorder shows:

  • cb_event: completion event to notify.
__STATIC_INLINE void EvrNetFTPc_ClientStopTimeoutExpired ( void  )

Event on FTP client stop operation timeout expired (Error)

The event ClientStopTimeoutExpired is created when the FTP operation has expired but is not completed. The FTP client session is then terminated.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetFTPc_CloseLocalFile ( void  )

Event on FTP client close local file (Op)

The event CloseLocalFile is created when the FTP client closes a local file that was previously opened for reading or writing.

__STATIC_INLINE void EvrNetFTPc_CommandErrorResponse ( void  )

Event on FTP client command error response received (Error)

The event CommandErrorResponse is created when the FTP server does not recognize the requested command or the command is not supported on the server.

__STATIC_INLINE void EvrNetFTPc_Connect ( const void *  net_addr)

Event on FTP client netFTPc_Connect to the server (API)

Parameters
net_addrpointer to NET_ADDR server address structure

The event Connect is created when the FTP client wants to connect to a server. This happens when the function netFTPc_Connect is executed.

Value in the Event Recorder shows:

  • ip: IPv4 or IPv6 address of the server.
  • port: server port number.
__STATIC_INLINE void EvrNetFTPc_ConnectClientBusy ( void  )

Event on netFTPc_Connect failed, client busy (Error)

The event ConnectClientBusy is created when the FTP client can not connect to the server, because the FTP client is already running.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetFTPc_ConnectInvalidParameter ( void  )

Event on netFTPc_Connect invalid parameter (Error)

The event ConnectInvalidParameter is created when the FTP client can not connect to the server, because the netFTPc_Connect function is called with an invalid input parameter.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetFTPc_DataConnAlreadyOpen ( int32_t  socket)

Event on FTP client data connection already opened (Op)

Parameters
socketassigned TCP data socket

The event DataConnAlreadyOpen is created when the requested command needs a data connection, and the data connection is already open.

Value in the Event Recorder shows:

  • sock: FTP client data socket.
__STATIC_INLINE void EvrNetFTPc_DataSocketClosed ( int32_t  socket)

Event on FTP client data socket closed (Op)

Parameters
socketassigned TCP data socket

The event DataSocketClosed is created when the data socket is closed and the data connection to the server is terminated.

Value in the Event Recorder shows:

  • sock: FTP client data socket.
__STATIC_INLINE void EvrNetFTPc_DataSocketOpened ( int32_t  socket)

Event on FTP client data socket opened (Op)

Parameters
socketassigned TCP data socket

The event DataSocketOpened is created when the data socket is opened and the data connection to the server is established.

Value in the Event Recorder shows:

  • sock: FTP client data socket.
__STATIC_INLINE void EvrNetFTPc_DirectoryCreated ( void  )

Event on FTP client directory successfully created on the server (Op)

The event DirectoryCreated is created when the requested directory is successfully created on the FTP server.

__STATIC_INLINE void EvrNetFTPc_DirectoryRemoved ( void  )

Event on FTP client directory removed on the server (Op)

The event DirectoryRemoved is created when the requested directory is successfully removed on the FTP server.

__STATIC_INLINE void EvrNetFTPc_ExecuteUserCommand ( uint8_t  command)

Event on FTP client server ready response (Op)

Parameters
commanduser command to execute
  • 0: Puts a file on FTP server
  • 1: Retrieves a file from FTP server
  • 2: Append file on FTP server (with create)
  • 3: Deletes a file on FTP server
  • 4: Lists files stored on FTP server
  • 5: Renames a file on FTP server
  • 6: Makes a directory on FTP server
  • 7: Removes an empty directory on FTP serve
  • 8: Lists file names only (short format)

The event ExecuteUserCommand is created when the FTP client sends an FTP command to the server for execution.

Value in the Event Recorder shows:

  • cmd: FTP command to execute (PUT, GET, APPEND, DELETE, LIST, RENAME, MKDIR, RMDIR, NLIST).
__STATIC_INLINE void EvrNetFTPc_FileDeleted ( void  )

Event on FTP client file deleted on the server (Op)

The event FileDeleted is created when the requested file is successfully deleted on the FTP server.

__STATIC_INLINE void EvrNetFTPc_FileNotFoundOnServer ( void  )

Event on FTP client error, requested file not found on server (Error)

The event FileNotFoundOnServer is created when the requested file cannot be found on the FTP server.

__STATIC_INLINE void EvrNetFTPc_FileOrDirectoryRenamed ( void  )

Event on FTP client file or directory renamed successfully on the server (Op)

The event FileOrDirectoryRenamed is created when the requested file or directory is successfully renamed on the FTP server.

__STATIC_INLINE void EvrNetFTPc_FileOrPathNotFound ( void  )

Event on FTP client requested file or path not found on the server (Op)

The event FileOrPathNotFound is created when the requested file or path cannot be found on the FTP server.

__STATIC_INLINE void EvrNetFTPc_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on FTP receive frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame

The event FrameTooShort is created when the FTP client receives the frame that is too short. The frame is then discarded.

Value in the Event Recorder shows:

  • len: length of the received frame in bytes.
  • min: minimum valid frame length in bytes.
__STATIC_INLINE void EvrNetFTPc_GetSocketFailed ( void  )

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

The event GetSocketFailed is created when the FTP client 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:

  • error
__STATIC_INLINE void EvrNetFTPc_InboundConnRejected ( int32_t  socket)

Event on FTP client inbound connection rejected (Error)

Parameters
socketassigned TCP socket

The event InboundConnRejected is created when the FTP server initiated a control connection to FTP client, or a data connection in passive mode. The connection request was therefore rejected. In FTP passive mode, the FTP client should establish a data connection.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_InitClient ( uint32_t  mode)

Event on FTP client initialize (Op)

Parameters
modeclient mode of operation
  • 0: active mode (accepts inbound data connections)
  • 1: passive mode (starts outbound data connections)

The event InitClient is created when the FTP client is initialized, that is, when the function netInitialize is executed.

Value in the Event Recorder shows:

  • mode: client mode of operation (Active, Passive).
__STATIC_INLINE void EvrNetFTPc_LocalDiskWriteError ( void  )

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

The event LocalDiskWriteError is created when the FTP client failed to write data to a local file. This usually happens when the storage medium is full or when a write error occurs in netFTPc_fwrite. The FTP client session is then terminated.

Value in the Event Recorder shows:

  • error
__STATIC_INLINE void EvrNetFTPc_LocalFileCreateFailed ( void  )

Event on FTP client local file create failed (Error)

The event LocalFileCreateFailed is created when the requested local file cannot be created. A possible reason for this may be the write-protected SD card.

__STATIC_INLINE void EvrNetFTPc_LocalFileNotFound ( void  )

Event on FTP client local file not found (Error)

The event LocalFileNotFound is created when the requested local file cannot be found on the storage medium.

__STATIC_INLINE void EvrNetFTPc_LocalPortAssigned ( uint16_t  local_port)

Event on FTP client local port assigned for server active mode (Op)

Parameters
local_portlocal port number to accept connection

The event LocalPortAssigned is created when the FTP client successfully assigns a local port in the active FTP mode. The client then opens the data port on which the FTP server connects to establish a data connection.

Value in the Event Recorder shows:

  • local_port: port on FTP client for data connection.
__STATIC_INLINE void EvrNetFTPc_NewNameRequired ( void  )

Event on FTP client new name required to rename a file on the server (Op)

The event NewNameRequired is created when the FTP server requests a new name for the requested file to which it will rename the file.

__STATIC_INLINE void EvrNetFTPc_OpenDataConnFailed ( int32_t  socket)

Event on FTP client open data connection failed (Error)

Parameters
socketassigned TCP data socket

The event OpenDataConnFailed is created when the FTP client fails to open a data connection. The FTP client session is then terminated.

Value in the Event Recorder shows:

  • sock: FTP client data socket.
__STATIC_INLINE void EvrNetFTPc_OpenLocalFile ( const char *  local_fname,
uint32_t  length 
)

Event on FTP client open local file (Op)

Parameters
local_fnamename of the local file
lengthlength of the local_fname string

The event OpenLocalFile is created when the FTP client has to open a local file to read or write.

Value in the Event Recorder shows:

  • name: name of the file to open.
__STATIC_INLINE void EvrNetFTPc_OperationNotAllowed ( void  )

Event on FTP client error, operation not allowed on server (Error)

The event OperationNotAllowed is created when the requested file or directory operation on the FTP server is not allowed.

__STATIC_INLINE void EvrNetFTPc_PassiveModeStart ( uint16_t  port)

Event on FTP client start passive server mode (Op)

Parameters
portserver port number to connect to

The event PassiveModeStart is created when the FTP client successfully activates the FTP passive mode on the server. The server then opens the data port where the FTP client connects to the data connection.

Value in the Event Recorder shows:

  • port: port on FTP server for data connection.
__STATIC_INLINE void EvrNetFTPc_PasvCommandFailed ( void  )

Event on FTP client PASV command failed (Error)

The event PasvCommandFailed is created when the FTP client fails to activate the FTP passive mode on the server. The FTP client session is then terminated and the client disconnects from the server.

__STATIC_INLINE void EvrNetFTPc_PortCommandFailed ( void  )

Event on FTP client PORT command failed (Error)

The event PortCommandFailed is created when the FTP client fails to activate the active FTP mode on the server. The client then tries the FTP passive mode. If this fails, the FTP session is terminated and the client disconnects from the server.

__STATIC_INLINE void EvrNetFTPc_ReceiveFrame ( int32_t  socket,
uint32_t  length 
)

Event on FTP client received frame (Op)

Parameters
socketassigned TCP socket
lengthframe length in bytes

The event ReceiveFrame is created when the FTP client receives the frame.

Value in the Event Recorder shows:

  • sock: FTP client socket.
  • len: length of the received frame in bytes.
__STATIC_INLINE void EvrNetFTPc_ResponseFragmented ( void  )

Event on FTP client response divided into multiple frames (Op)

The event ResponseFragmented is created when the FTP client receives a milti-line response from the server, but the last line of the response has not yet been received. The FTP client is thus waiting for more data.

__STATIC_INLINE void EvrNetFTPc_SendCommand ( const uint8_t *  command,
uint32_t  length 
)

Event on FTP client send command to server (Detail)

Parameters
commandserver command in text form
lengthlength of the command string

The event SendCommand is created when the FTP client sends a FTP command to the server.

Value in the Event Recorder shows:

  • cmd: FTP command to send.
__STATIC_INLINE void EvrNetFTPc_ServerReady ( void  )

Event on FTP client server ready response (Op)

The event ServerReady is created when the FTP client receives a response from the server that the server is ready to receive FTP client commands. This means that user authentication can begin.

__STATIC_INLINE void EvrNetFTPc_ShowReplyCode ( const uint8_t *  reply_code)

Event on FTP client display numeric reply code received from server (Op)

Parameters
reply_codenumeric reply code in text format (3 characters)

The event ShowReplyCode is created when the FTP client wants to display a numeric threee-digit response code received from the server.

Value in the Event Recorder shows:

  • reply: numeric FTP response code.
__STATIC_INLINE void EvrNetFTPc_SocketAborted ( int32_t  socket)

Event on FTP client socket aborted (Error)

Parameters
socketassigned TCP socket

The event SocketAborted is created when the FTP client connection is unexpectedly terminated from the server. The client session is then closed.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_SocketClosed ( int32_t  socket)

Event on FTP client socket closed (Op)

Parameters
socketassigned TCP socket

The event SocketClosed is created when the FTP client connection is unexpectedly closed from the server. The client session is then closed.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_SocketConnected ( int32_t  socket)

Event on FTP client socket connected (Op)

Parameters
socketassigned TCP socket

The event SocketConnected is created when the FTP client is connected to the server. The connection is established and the client session is then active.

Value in the Event Recorder shows:

  • sock: FTP client socket.
__STATIC_INLINE void EvrNetFTPc_TransferAborted ( void  )

Event on FTP client data transfer aborted (Op)

The event TransferAborted is created when the data connection is unexpectedly closed before the data transfer completes while retrieving a file.

__STATIC_INLINE void EvrNetFTPc_TransferCompleted ( void  )

Event on FTP client data transfer completed successfully (Op)

The event TransferCompleted is created when the data transfer is completed successfully when saving or retrieving a file or a directory list.

__STATIC_INLINE void EvrNetFTPc_UninitClient ( void  )

Event on FTP client de-initialize (Op)

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

Value in the Event Recorder shows:

  • ftp
__STATIC_INLINE void EvrNetFTPc_UserLoginFailed ( void  )

Event on FTP client user login to server failed (Error)

The event UserLoginFailed is created when the FTP client failed to log into the server because the authentication failed. The connection to the server is then terminated.

__STATIC_INLINE void EvrNetFTPc_UserLoginSuccess ( void  )

Event on FTP client user login successful (Op)

The event UserLoginSuccess is created when the FTP client successfully logs into the server. The server is now ready to execute file management commands from the user.

__STATIC_INLINE void EvrNetFTPc_UserOkNeedPassword ( void  )

Event on FTP client username ok, password needed (Op)

The event UserOkNeedPassword is created when the FTP client receives a response from the server that the specified username has been accepted and that a password is still required to complete the authentication.

__STATIC_INLINE void EvrNetFTPc_WorkingDirectoryInvalid ( void  )

Event on FTP client change working directory failed, invalid path (Error)

The event WorkingDirectoryInvalid is created when the FTP client wants to change the working directory on the server, and the server replies that the specified directory is invalid.

__STATIC_INLINE void EvrNetFTPc_WrongResponse ( const uint8_t *  response,
uint32_t  length 
)

Event on FTP client wrong response received (Error)

Parameters
responseresponse from the server in text format
lengthlength of the response string

The event WrongResponse is created when the FTP server responds to the requested command, but the FTP client does not expect that response.

Value in the Event Recorder shows:

  • reply: server response in text format.