TFTP Client API

Jump to: navigation, search

Table of Contents >> Application Reference


The TFTP Client Application Program Interface allows the user to retrieve files from and store files to a remote TFTP server.

User Interface

The user interface allows the user to get and put files from a remote TFTP server.

Five calls are provided in the TFTP Client User Interface.

tfTftpGet() Called by the user to get a file from a TFTP server.
tfTftpInit() This function must be called before any other TFTP API calls are made. It initializes various data associated with the TFTP client.
tfTftpPut() Called by the user to store a file to a TFTP server.
tfTftpSetTimeout() Called by the user to set timeout and retry values.
tfTftpUserExecute() If the stack is running in non-blocking mode, this function must be called periodically in order to get the client to execute. In blocking mode, this function should not be called.


Blocking Mode
In blocking mode, tfTftpGet() and tfTftpPut() will both block until the transfer is completed or an error is returned. The TFTP client code is executed in the context of the calling task. Choose blocking mode if you are using an RTOS/Kernel.
Non-Blocking Mode
In non-blocking mode, calls to tfTftpGet() and tfTftpPut() will return immediately. tfTftpUserExecute() must be called periodically to cause them to execute. Choose non-blocking mode if you are not using an RTOS/Kernel.


Function Calls


Table of Contents >> Application Reference