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

class ipworks.TFTPClient

Remarks

To use the class, first specify the tftp_server, then a local_file and a remote_file, and then call get_file or put_file. The on_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 max_retransmits 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

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

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.

local_file Property

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

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

If get_file is called, and local_file already exists, it is overwritten. If put_file is called, local_file must point to a valid file or an error will be returned.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

max_retransmits Property

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

Syntax

def get_max_retransmits() -> int: ...
def set_max_retransmits(value: int) -> None: ...

max_retransmits = property(get_max_retransmits, set_max_retransmits)

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 retransmit_timeout determines the wait time (in seconds) between successive retransmissions.

The default value for the max_retransmits property is 3.

remote_file Property

This property includes the file on the remote host.

Syntax

def get_remote_file() -> str: ...
def set_remote_file(value: str) -> None: ...

remote_file = property(get_remote_file, set_remote_file)

Default Value

""

Remarks

When the get_file is called, this must be a valid file on the tftp_server.

retransmit_timeout Property

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

Syntax

def get_retransmit_timeout() -> int: ...
def set_retransmit_timeout(value: int) -> None: ...

retransmit_timeout = property(get_retransmit_timeout, set_retransmit_timeout)

Default Value

5

Remarks

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

The default value for the retransmit_timeout is 5 seconds.

tftp_port Property

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

Syntax

def get_tftp_port() -> int: ...
def set_tftp_port(value: int) -> None: ...

tftp_port = property(get_tftp_port, set_tftp_port)

Default Value

69

Remarks

The tftp_port is the UDP port on the tftp_server to send TFTP requests to.

tftp_server Property

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

Syntax

def get_tftp_server() -> str: ...
def set_tftp_server(value: str) -> None: ...

tftp_server = property(get_tftp_server, set_tftp_server)

Default Value

""

Remarks

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

Example. Get a File:

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

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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 do_events 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.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

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

get_file Method

This method downloads a RemoteFile from the TFTP server.

Syntax

def get_file() -> None: ...

Remarks

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

Example. Get a File:

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

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

put_file Method

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

Syntax

def put_file() -> None: ...

Remarks

The local file specified by local_file is uploaded to the remote file specified by remote_file.

Example. Put a File:

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

reset Method

This method resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_end_transfer Event

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

Syntax

class TFTPClientEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class TFTPClient:
@property
def on_end_transfer() -> Callable[[TFTPClientEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[TFTPClientEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer 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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class TFTPClientErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class TFTPClient:
@property
def on_error() -> Callable[[TFTPClientErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TFTPClientErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_start_transfer Event

This event fires when a file starts downloading or uploading.

Syntax

class TFTPClientStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class TFTPClient:
@property
def on_start_transfer() -> Callable[[TFTPClientStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[TFTPClientStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.

on_transfer Event

This event is fired during the file download or upload.

Syntax

class TFTPClientTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class TFTPClient:
@property
def on_transfer() -> Callable[[TFTPClientTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[TFTPClientTransferEventParams], None]) -> None: ...

Remarks

One or more on_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.

TFTPClient Config Settings

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

TFTPClient Errors

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