TFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The TFTP Server Class is used to create a TFTP Server.

Syntax

class ipworks.TFTPServer

Remarks

The TFTP Server class provides a simple way to create a TFTP Server. Any TFTP client will be able to connect and transfer files to and from the server.

Getting Started

By default, the server will listen on port 69. You can specify the listening port by setting the local_port property.

Optionally, you can set the local_dir property to a valid local path. If this property is set, the class will serve files from this location. When clients connect, they can request files from this location. If this property is not set, then the class will fire events allowing customized responses for each operation.

To start the server, call the start_listening method.

Handling Events

Event handlers are the primary method of customizing the class's functionality. When a client attempts to connect or open a file, the corresponding TFTP Server event will fire to allow for custom handling of the client's request.

The following events are fired once the requested operation is executed:

• on_error
• on_log
• on_connected
• on_connection_request
• on_disconnected
• on_end_transfer
• on_start_transfer
• on_transfer

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.

conn_count Property

The number of records in the Conn arrays.

Syntax

def get_conn_count() -> int: ...

conn_count = property(get_conn_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• conn_connection_id
• conn_file_data
• conn_file_name
• conn_local_file
• conn_remote_host
• conn_remote_port
• conn_transfer_mode

The array indices start at 0 and end at conn_count - 1.

This property is read-only.

conn_connection_id Property

This property contains a unique identifier for this connection.

Syntax

def get_conn_connection_id(conn_id: int) -> int: ...

Default Value

0

Remarks

This property contains a unique identifier for this connection.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

This property is read-only.

conn_file_data Property

This property is available only for sending data to a connected client.

Syntax

def get_conn_file_data(conn_id: int) -> bytes: ...
def set_conn_file_data(conn_id: int, value: bytes) -> None: ...

Default Value

""

Remarks

This property is available only for sending data to a connected client. If this property is set, then this will be the data sent when a connected client attempts to download a file from the server.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

conn_file_name Property

This property represents the filename of the file the client wants to upload or download.

Syntax

def get_conn_file_name(conn_id: int) -> str: ...

Default Value

""

Remarks

This property represents the filename of the file the client wants to upload or download.

Note: FileData must be empty to use this property.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

This property is read-only.

conn_local_file Property

This property is the local file on the server.

Syntax

def get_conn_local_file(conn_id: int) -> str: ...
def set_conn_local_file(conn_id: int, value: str) -> None: ...

Default Value

""

Remarks

This property is the local file on the server. This file is written to when a client puts a file. Data are pulled from this file when a client requests a file.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

conn_remote_host Property

This property represents the IP address of the connected client.

Syntax

def get_conn_remote_host(conn_id: int) -> str: ...

Default Value

""

Remarks

This property represents the IP address of the connected client.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

This property is read-only.

conn_remote_port Property

This property represents the port of the connected client.

Syntax

def get_conn_remote_port(conn_id: int) -> int: ...

Default Value

0

Remarks

This property represents the port of the connected client.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

This property is read-only.

conn_transfer_mode Property

This property specifies whether transfers are done in octet mode 0 or netascii mode 1 .

Syntax

def get_conn_transfer_mode(conn_id: int) -> str: ...

Default Value

""

Remarks

This property specifies whether transfers are done in octet mode 0 or netascii mode 1.

The conn_id parameter specifies the index of the item in the array. The size of the array is controlled by the conn_count property.

This property is read-only.

listening Property

This property indicates whether the class is listening for incoming connections on LocalPort.

Syntax

def get_listening() -> bool: ...

listening = property(get_listening, None)

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the class is listening.

This property is read-only.

local_dir Property

This property defines the local file directory for the server.

Syntax

def get_local_dir() -> str: ...
def set_local_dir(value: str) -> None: ...

local_dir = property(get_local_dir, set_local_dir)

Default Value

""

Remarks

This property defines the local file directory on the server. Files can be downloaded to or uploaded from this directory.

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.

local_port Property

This property includes the port that the server will listen on.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

69

Remarks

This property contains the port that the TFTP Server listens on. The default value is 69.

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.

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.

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.

start_listening Method

This method starts listening for incoming connections.

Syntax

def start_listening() -> None: ...

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening.

stop_listening Method

This method stops listening for new connections.

Syntax

def stop_listening() -> None: ...

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

on_connected Event

This event fires immediately after a connection completes (or fails).

Syntax

class TFTPServerConnectedEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

# In class TFTPServer:
@property
def on_connected() -> Callable[[TFTPServerConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[TFTPServerConnectedEventParams], None]) -> None: ...

Remarks

The ConnectionId is the Id of the connected client that caused the event to fire.

Upon a successful connection, the SatusCode is 0, and the Description is OK. If the connection is not successful, the StatusCode will contain an error code. The Description will contain a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_connection_request Event

This event fires anytime a connected client attempts a connection to the server.

Syntax

class TFTPServerConnectionRequestEventParams(object):
  @property
  def remote_host() -> str: ...

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

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

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

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

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class TFTPServer:
@property
def on_connection_request() -> Callable[[TFTPServerConnectionRequestEventParams], None]: ...
@on_connection_request.setter
def on_connection_request(event_hook: Callable[[TFTPServerConnectionRequestEventParams], None]) -> None: ...

Remarks

The RemoteHost parameter specifies the IP address (IP number in dotted internet format) of the client attempting to connect.

The RemotePort is the port of the client attempting a connection.

The FileName parameter is the path of the file to upload or download.

The TransferMode parameter specifies which transfer mode to use.

The Operation indicates whether the requested operation is read or write.

The Accept parameter indicates whether to accept or deny the connection. All connections are accepted by default. If you want to refuse a connection, set the Accept parameter to false.

on_disconnected Event

This event fires after a transfer is completed.

Syntax

class TFTPServerDisconnectedEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

# In class TFTPServer:
@property
def on_disconnected() -> Callable[[TFTPServerDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[TFTPServerDisconnectedEventParams], None]) -> None: ...

Remarks

ConnectionID will be the ConnectionID of the client that has disconnected.

Upon successful transfer and disconnection, the StatusCode will be 0 and the Description will be OK. If a transfer is unsuccessful or a client disconnects due to an error, the StatusCode will contain an error code. The Description will be a textual description of the error.

on_end_transfer Event

This event fires once a transfer is completed.

Syntax

class TFTPServerEndTransferEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

Remarks

The ConnectionId will be the ConnectionId of the connected client.

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 TFTPServerErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class TFTPServer:
@property
def on_error() -> Callable[[TFTPServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TFTPServerErrorEventParams], 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_log Event

This event fires once for each log message.

Syntax

class TFTPServerLogEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

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

# In class TFTPServer:
@property
def on_log() -> Callable[[TFTPServerLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[TFTPServerLogEventParams], None]) -> None: ...

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including users logging in and out, files transferred, and directories listed.

The value 2 (Verbose) includes logs from the on_pi_trail event as well as basic information about data transfer channels.

The value 3 (Debug) logs additional debug information, such as extended socket connection and data transfer information.

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "Error"
• "Verbose"
• "Debug"
• "PITrail"

on_start_transfer Event

This event fires immediately after a client initiates a file transfer.

Syntax

class TFTPServerStartTransferEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

Remarks

ConnectionId is the ConnectionId of the connected client. Direction represents the direction in which the transfer is going.

on_transfer Event

This event fires repeatedly while data are being transferred. A transfer is marked as complete once a packet that is less than 512 bytes is received.

Syntax

class TFTPServerTransferEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

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

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

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

Remarks

The ConnectionId parameter is the ConnectionId of the client who initiated the transfer.

BytesTransferred specifies the number of bytes transferred.

The Text parameter contains the data being transferred.

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.

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

TFTPServer Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

TFTPServer Errors

TFTPServer 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