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
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_ConnectIp4 (const void *net_addr)
 Event on FTP client netFTPc_Connect to IPv4 server (API) More...
 
__STATIC_INLINE void EvrNetFTPc_ConnectIp6 (const void *net_addr)
 Event on FTP client netFTPc_Connect to IPv6 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.

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
__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
__STATIC_INLINE void EvrNetFTPc_BinaryModeEnabled ( void  )

Event on FTP client binary transfer mode enabled (Op)

__STATIC_INLINE void EvrNetFTPc_ClientCloseSocket ( int32_t  socket)

Event on FTP client close control socket (Op)

Parameters
socketassigned TCP control 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
__STATIC_INLINE void EvrNetFTPc_ClientStopTimeoutExpired ( void  )

Event on FTP client stop operation timeout expired (Error)

__STATIC_INLINE void EvrNetFTPc_CloseLocalFile ( void  )

Event on FTP client close local file (Op)

__STATIC_INLINE void EvrNetFTPc_CommandErrorResponse ( void  )

Event on FTP client command error response received (Error)

__STATIC_INLINE void EvrNetFTPc_ConnectClientBusy ( void  )

Event on netFTPc_Connect failed, client busy (Error)

__STATIC_INLINE void EvrNetFTPc_ConnectInvalidParameter ( void  )

Event on netFTPc_Connect invalid parameter (Error)

__STATIC_INLINE void EvrNetFTPc_ConnectIp4 ( const void *  net_addr)

Event on FTP client netFTPc_Connect to IPv4 server (API)

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

Event on FTP client netFTPc_Connect to IPv6 server (API)

Parameters
net_addrpointer to NET_ADDR server address structure (20 bytes)
Remarks
Sends full size of net address structure with IPv6 address only.
__STATIC_INLINE void EvrNetFTPc_DataConnAlreadyOpen ( int32_t  socket)

Event on FTP client data connection already opened (Op)

Parameters
socketassigned TCP data socket
__STATIC_INLINE void EvrNetFTPc_DataSocketClosed ( int32_t  socket)

Event on FTP client data socket closed (Op)

Parameters
socketassigned TCP data socket
__STATIC_INLINE void EvrNetFTPc_DataSocketOpened ( int32_t  socket)

Event on FTP client data socket opened (Op)

Parameters
socketassigned TCP data socket
__STATIC_INLINE void EvrNetFTPc_DirectoryCreated ( void  )

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

__STATIC_INLINE void EvrNetFTPc_DirectoryRemoved ( void  )

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

__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)
__STATIC_INLINE void EvrNetFTPc_FileDeleted ( void  )

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

__STATIC_INLINE void EvrNetFTPc_FileNotFoundOnServer ( void  )

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

__STATIC_INLINE void EvrNetFTPc_FileOrDirectoryRenamed ( void  )

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

__STATIC_INLINE void EvrNetFTPc_FileOrPathNotFound ( void  )

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

__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
__STATIC_INLINE void EvrNetFTPc_GetSocketFailed ( void  )

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

__STATIC_INLINE void EvrNetFTPc_InboundConnRejected ( int32_t  socket)

Event on FTP client inbound connection rejected (Error)

Parameters
socketassigned TCP 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)
__STATIC_INLINE void EvrNetFTPc_LocalDiskWriteError ( void  )

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

__STATIC_INLINE void EvrNetFTPc_LocalFileCreateFailed ( void  )

Event on FTP client local file create failed (Error)

__STATIC_INLINE void EvrNetFTPc_LocalFileNotFound ( void  )

Event on FTP client local file not found (Error)

__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
__STATIC_INLINE void EvrNetFTPc_NewNameRequired ( void  )

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

__STATIC_INLINE void EvrNetFTPc_OpenDataConnFailed ( int32_t  socket)

Event on FTP client open data connection failed (Error)

Parameters
socketassigned TCP 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
__STATIC_INLINE void EvrNetFTPc_OperationNotAllowed ( void  )

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

__STATIC_INLINE void EvrNetFTPc_PassiveModeStart ( uint16_t  port)

Event on FTP client start passive server mode (Op)

Parameters
portserver port number to connect to
__STATIC_INLINE void EvrNetFTPc_PasvCommandFailed ( void  )

Event on FTP client PASV command failed (Error)

__STATIC_INLINE void EvrNetFTPc_PortCommandFailed ( void  )

Event on FTP client PORT command failed (Error)

__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
__STATIC_INLINE void EvrNetFTPc_ResponseFragmented ( void  )

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

__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
__STATIC_INLINE void EvrNetFTPc_ServerReady ( void  )

Event on FTP client server ready response (Op)

__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)
__STATIC_INLINE void EvrNetFTPc_SocketAborted ( int32_t  socket)

Event on FTP client socket aborted (Error)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetFTPc_SocketClosed ( int32_t  socket)

Event on FTP client socket closed (Op)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetFTPc_SocketConnected ( int32_t  socket)

Event on FTP client socket connected (Op)

Parameters
socketassigned TCP socket
__STATIC_INLINE void EvrNetFTPc_TransferAborted ( void  )

Event on FTP client data transfer aborted (Op)

__STATIC_INLINE void EvrNetFTPc_TransferCompleted ( void  )

Event on FTP client data transfer completed successfully (Op)

__STATIC_INLINE void EvrNetFTPc_UninitClient ( void  )

Event on FTP client de-initialize (Op)

__STATIC_INLINE void EvrNetFTPc_UserLoginFailed ( void  )

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

__STATIC_INLINE void EvrNetFTPc_UserLoginSuccess ( void  )

Event on FTP client user login successful (Op)

__STATIC_INLINE void EvrNetFTPc_UserOkNeedPassword ( void  )

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

__STATIC_INLINE void EvrNetFTPc_WorkingDirectoryInvalid ( void  )

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

__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