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.

Class Name

IPWorks_TFTPClient

Procedural Interface

 ipworks_tftpclient_open();
 ipworks_tftpclient_close($res);
 ipworks_tftpclient_register_callback($res, $id, $function);
 ipworks_tftpclient_get_last_error($res);
 ipworks_tftpclient_get_last_error_code($res);
 ipworks_tftpclient_set($res, $id, $index, $value);
 ipworks_tftpclient_get($res, $id, $index);
 ipworks_tftpclient_do_config($res, $configurationstring);
 ipworks_tftpclient_do_doevents($res);
 ipworks_tftpclient_do_getfile($res);
 ipworks_tftpclient_do_interrupt($res);
 ipworks_tftpclient_do_putfile($res);
 ipworks_tftpclient_do_reset($res);

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 (IPWorks_TFTPClient Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_tftpclient_get($res, 1 );

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 (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworks_tftpclient_get($res, 2 );
ipworks_tftpclient_set($res, 2, $value );

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 (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_tftpclient_get($res, 3 );
ipworks_tftpclient_set($res, 3, $value );

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 (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getMaxRetransmits();
public function setMaxRetransmits($value);

Procedural Interface

ipworks_tftpclient_get($res, 4 );
ipworks_tftpclient_set($res, 4, $value );

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 (IPWorks_TFTPClient Class)

This property includes the file on the remote host.

Object Oriented Interface

public function getRemoteFile();
public function setRemoteFile($value);

Procedural Interface

ipworks_tftpclient_get($res, 5 );
ipworks_tftpclient_set($res, 5, $value );

Default Value

''

Remarks

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

Data Type

String

RetransmitTimeout Property (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getRetransmitTimeout();
public function setRetransmitTimeout($value);

Procedural Interface

ipworks_tftpclient_get($res, 6 );
ipworks_tftpclient_set($res, 6, $value );

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 (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getTFTPPort();
public function setTFTPPort($value);

Procedural Interface

ipworks_tftpclient_get($res, 7 );
ipworks_tftpclient_set($res, 7, $value );

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 (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function getTFTPServer();
public function setTFTPServer($value);

Procedural Interface

ipworks_tftpclient_get($res, 8 );
ipworks_tftpclient_set($res, 8, $value );

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 (IPWorks_TFTPClient Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_tftpclient_get($res, 9 );
ipworks_tftpclient_set($res, 9, $value );

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 (IPWorks_TFTPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_tftpclient_do_config($res, $configurationstring);

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.

DoEvents Method (IPWorks_TFTPClient Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_tftpclient_do_doevents($res);

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.

GetFile Method (IPWorks_TFTPClient Class)

This method downloads a RemoteFile from the TFTP server.

Object Oriented Interface

public function doGetFile();

Procedural Interface

ipworks_tftpclient_do_getfile($res);

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()

Interrupt Method (IPWorks_TFTPClient Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_tftpclient_do_interrupt($res);

Remarks

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

PutFile Method (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function doPutFile();

Procedural Interface

ipworks_tftpclient_do_putfile($res);

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()

Reset Method (IPWorks_TFTPClient Class)

This method resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_tftpclient_do_reset($res);

Remarks

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

EndTransfer Event (IPWorks_TFTPClient Class)

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

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_tftpclient_register_callback($res, 1, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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 (IPWorks_TFTPClient Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_tftpclient_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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 (IPWorks_TFTPClient Class)

This event fires when a file starts downloading or uploading.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_tftpclient_register_callback($res, 3, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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 (IPWorks_TFTPClient Class)

This event is fired during the file download or upload.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_tftpclient_register_callback($res, 4, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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)

The class accepts one or more of the following configuration settings. Configuration 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.

TFTPClient Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TFTPClient Class)

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