TFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The TFTPClient class is used to exchange files with TFTP servers via the TFTP protocol defined in RFC 783.

Syntax

TFTPClient

Remarks

To use the class, first specify the TFTPServer, then a LocalFile and a RemoteFile, and then call GetFile or PutFile. The Transfer event shows the progress of the transfer.

Potential transmission errors and packet loss are managed by the Timeout property, which controls the maximum time to wait for a response from the server, and the MaxRetransmits property, which specifies how many times to resend a failed packet before giving up.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Idle Property (TFTPClient Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_tftpclient_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (TFTPClient Class)

This property includes a file on the local host to transfer the data to or from.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* ipworks_tftpclient_getlocalfile(void* lpObj);
wchar_t* ipworks_tftpclient_getlocalfile_W(void* lpObj); // Windows only
int ipworks_tftpclient_setlocalfile(void* lpObj, const char* lpszLocalFile);
int ipworks_tftpclient_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

If GetFile is called, and LocalFile already exists, it is overwritten. If PutFile is called, LocalFile must point to a valid file or an error will be returned.

Data Type

String

LocalHost Property (TFTPClient Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_tftpclient_getlocalhost(void* lpObj);
int ipworks_tftpclient_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MaxRetransmits Property (TFTPClient Class)

This property specifies the number of times to retry sending a failed packet before disconnecting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMaxRetransmits();
int SetMaxRetransmits(int iMaxRetransmits);

Unicode (Windows)
INT GetMaxRetransmits();
INT SetMaxRetransmits(INT iMaxRetransmits);

int ipworks_tftpclient_getmaxretransmits(void* lpObj);
int ipworks_tftpclient_setmaxretransmits(void* lpObj, int iMaxRetransmits);

int GetMaxRetransmits();
int SetMaxRetransmits(int iMaxRetransmits);

Default Value

3

Remarks

This property allows you to specify the number of times that you would like to try resending the last data packet if the original packet fails.

The RetransmitTimeout determines the wait time (in seconds) between successive retransmissions.

The default value for the MaxRetransmits property is 3.

Data Type

Integer

RemoteFile Property (TFTPClient Class)

This property includes the file on the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteFile();
int SetRemoteFile(const char* lpszRemoteFile);

Unicode (Windows)
LPWSTR GetRemoteFile();
INT SetRemoteFile(LPCWSTR lpszRemoteFile);

char* ipworks_tftpclient_getremotefile(void* lpObj);
int ipworks_tftpclient_setremotefile(void* lpObj, const char* lpszRemoteFile);

QString GetRemoteFile();
int SetRemoteFile(QString qsRemoteFile);

Default Value

""

Remarks

When the GetFile is called, this must be a valid file on the TFTPServer.

Data Type

String

RetransmitTimeout Property (TFTPClient Class)

This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRetransmitTimeout();
int SetRetransmitTimeout(int iRetransmitTimeout);

Unicode (Windows)
INT GetRetransmitTimeout();
INT SetRetransmitTimeout(INT iRetransmitTimeout);

int ipworks_tftpclient_getretransmittimeout(void* lpObj);
int ipworks_tftpclient_setretransmittimeout(void* lpObj, int iRetransmitTimeout);

int GetRetransmitTimeout();
int SetRetransmitTimeout(int iRetransmitTimeout);

Default Value

5

Remarks

Please refer to the MaxRetransmits property for the number of retransmit efforts before an error is returned.

The default value for the RetransmitTimeout is 5 seconds.

Data Type

Integer

TFTPPort Property (TFTPClient Class)

This property specifies the User Datagram Protocol (UDP) port where the remote TFTP server is listening.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTFTPPort();
int SetTFTPPort(int iTFTPPort);

Unicode (Windows)
INT GetTFTPPort();
INT SetTFTPPort(INT iTFTPPort);

int ipworks_tftpclient_gettftpport(void* lpObj);
int ipworks_tftpclient_settftpport(void* lpObj, int iTFTPPort);

int GetTFTPPort();
int SetTFTPPort(int iTFTPPort);

Default Value

69

Remarks

The TFTPPort is the UDP port on the TFTPServer to send TFTP requests to.

This property is not available at design time.

Data Type

Integer

TFTPServer Property (TFTPClient Class)

This property includes the address of the TFTP server to exchange files with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTFTPServer();
int SetTFTPServer(const char* lpszTFTPServer);

Unicode (Windows)
LPWSTR GetTFTPServer();
INT SetTFTPServer(LPCWSTR lpszTFTPServer);

char* ipworks_tftpclient_gettftpserver(void* lpObj);
int ipworks_tftpclient_settftpserver(void* lpObj, const char* lpszTFTPServer);

QString GetTFTPServer();
int SetTFTPServer(QString qsTFTPServer);

Default Value

""

Remarks

To be able to transfer file via TFTP, the remote host must be running TFTP services on port TFTPPort (default 69).

Example. Get a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.GetFile()

Data Type

String

Timeout Property (TFTPClient Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_tftpclient_gettimeout(void* lpObj);
int ipworks_tftpclient_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Config Method (TFTPClient Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_tftpclient_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (TFTPClient Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_tftpclient_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetFile Method (TFTPClient Class)

This method downloads a RemoteFile from the TFTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFile();

Unicode (Windows)
INT GetFile();

int ipworks_tftpclient_getfile(void* lpObj);

int GetFile();

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string).

Example. Get a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.GetFile()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (TFTPClient Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_tftpclient_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PutFile Method (TFTPClient Class)

This method uploads a file specified by LocalFile to the TFTP server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PutFile();

Unicode (Windows)
INT PutFile();

int ipworks_tftpclient_putfile(void* lpObj);

int PutFile();

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile.

Example. Put a File:

TFTPControl.TFTPServer = "MyServer" TFTPControl.LocalFile = "C:\filename.txt" TFTPControl.RemoteFile = "/remotefile.txt" TFTPControl.PutFile()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TFTPClient Class)

This method resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_tftpclient_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EndTransfer Event (TFTPClient Class)

This event is fired when a file finishes downloading or uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(TFTPClientEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} TFTPClientEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(TFTPClientEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} TFTPClientEndTransferEventParams;

#define EID_TFTPCLIENT_ENDTRANSFER 1

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class TFTPClientEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(TFTPClientEndTransferEventParams *e);

// Or, subclass TFTPClient and override this emitter function.
virtual int FireEndTransfer(TFTPClientEndTransferEventParams *e) {...}

Remarks

The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (TFTPClient Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(TFTPClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} TFTPClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(TFTPClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} TFTPClientErrorEventParams;

#define EID_TFTPCLIENT_ERROR 2

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TFTPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TFTPClientErrorEventParams *e);

// Or, subclass TFTPClient and override this emitter function.
virtual int FireError(TFTPClientErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

StartTransfer Event (TFTPClient Class)

This event fires when a file starts downloading or uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(TFTPClientStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} TFTPClientStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(TFTPClientStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} TFTPClientStartTransferEventParams;

#define EID_TFTPCLIENT_STARTTRANSFER 3

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class TFTPClientStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(TFTPClientStartTransferEventParams *e);

// Or, subclass TFTPClient and override this emitter function.
virtual int FireStartTransfer(TFTPClientStartTransferEventParams *e) {...}

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (TFTPClient Class)

This event is fired during the file download or upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(TFTPClientTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} TFTPClientTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(TFTPClientTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} TFTPClientTransferEventParams;

#define EID_TFTPCLIENT_TRANSFER 4

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class TFTPClientTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(TFTPClientTransferEventParams *e);

// Or, subclass TFTPClient and override this emitter function.
virtual int FireTransfer(TFTPClientTransferEventParams *e) {...}

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (TFTPClient Class)

TFTPClient Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TFTPClient Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

TFTPClient Errors

The class may also return one of the following error codes, which are inherited from other classes.

UDP Errors

SSL Errors

TCP/IP Errors