Struct ipworks::TFTPClient

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworks::TFTPClient

Remarks

To use the struct, 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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorks. Due to this, the TFTPClient struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of TFTPClient when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

idle property (TFTPClient Struct)

The current status of the struct.

Syntax

fn idle(&self ) -> Result<bool, IPWorksError> 

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

bool

local_file property (TFTPClient Struct)

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

Syntax

fn local_file(&self ) -> Result<String, IPWorksError> 
fn set_local_file(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_file_ref(&self, value : &String) ->  Option<IPWorksError> 

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.

Data Type

String

local_host property (TFTPClient Struct)

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

Syntax

fn local_host(&self ) -> Result<String, IPWorksError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksError> 

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 struct initiate connections (or accept in the case of server structs) 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 struct 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.

Data Type

String

max_retransmits property (TFTPClient Struct)

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

Syntax

fn max_retransmits(&self ) -> Result<i32, IPWorksError> 
fn set_max_retransmits(&self, value : i32) ->  Option<IPWorksError> 

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.

Data Type

i32

remote_file property (TFTPClient Struct)

This property includes the file on the remote host.

Syntax

fn remote_file(&self ) -> Result<String, IPWorksError> 
fn set_remote_file(&self, value : &str) ->  Option<IPWorksError> 
fn set_remote_file_ref(&self, value : &String) ->  Option<IPWorksError> 

Default Value

""

Remarks

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

Data Type

String

retransmit_timeout property (TFTPClient Struct)

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

Syntax

fn retransmit_timeout(&self ) -> Result<i32, IPWorksError> 
fn set_retransmit_timeout(&self, value : i32) ->  Option<IPWorksError> 

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.

Data Type

i32

tftp_port property (TFTPClient Struct)

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

Syntax

fn tftp_port(&self ) -> Result<i32, IPWorksError> 
fn set_tftp_port(&self, value : i32) ->  Option<IPWorksError> 

Default Value

69

Remarks

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

Data Type

i32

tftp_server property (TFTPClient Struct)

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

Syntax

fn tftp_server(&self ) -> Result<String, IPWorksError> 
fn set_tftp_server(&self, value : &str) ->  Option<IPWorksError> 
fn set_tftp_server_ref(&self, value : &String) ->  Option<IPWorksError> 

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

Data Type

String

timeout property (TFTPClient Struct)

The timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksError> 

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 struct will wait for the operation to complete before returning control.

The struct 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 struct 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

i32

config method (TFTPClient Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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 (TFTPClient Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksError>

Remarks

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

get_file method (TFTPClient Struct)

This method downloads a RemoteFile from the TFTP server.

Syntax

fn get_file(&self) -> Result<(), IPWorksError>

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

This method interrupts the current method.

Syntax

fn interrupt(&self) -> Result<(), IPWorksError>

Remarks

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

put_file method (TFTPClient Struct)

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

Syntax

fn put_file(&self) -> Result<(), IPWorksError>

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

This method resets the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksError>

Remarks

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

on_end_transfer event (TFTPClient Struct)

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

Syntax

// TFTPClientEndTransferEventArgs carries the TFTPClient EndTransfer event's parameters.
pub struct TFTPClientEndTransferEventArgs {
  fn direction(&self) -> i32
}

// TFTPClientEndTransferEvent defines the signature of the TFTPClient EndTransfer event's handler function.
pub trait TFTPClientEndTransferEvent {
  fn on_end_transfer(&self, sender : TFTPClient, e : &mut TFTPClientEndTransferEventArgs);
}

impl <'a> TFTPClient<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn TFTPClientEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn TFTPClientEndTransferEvent);
  ...
}

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

Fired when information is available about errors during data delivery.

Syntax

// TFTPClientErrorEventArgs carries the TFTPClient Error event's parameters.
pub struct TFTPClientErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// TFTPClientErrorEvent defines the signature of the TFTPClient Error event's handler function.
pub trait TFTPClientErrorEvent {
  fn on_error(&self, sender : TFTPClient, e : &mut TFTPClientErrorEventArgs);
}

impl <'a> TFTPClient<'a> {
  pub fn on_error(&self) -> &'a dyn TFTPClientErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn TFTPClientErrorEvent);
  ...
}

Remarks

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

The error_code 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 (TFTPClient Struct)

This event fires when a file starts downloading or uploading.

Syntax

// TFTPClientStartTransferEventArgs carries the TFTPClient StartTransfer event's parameters.
pub struct TFTPClientStartTransferEventArgs {
  fn direction(&self) -> i32
}

// TFTPClientStartTransferEvent defines the signature of the TFTPClient StartTransfer event's handler function.
pub trait TFTPClientStartTransferEvent {
  fn on_start_transfer(&self, sender : TFTPClient, e : &mut TFTPClientStartTransferEventArgs);
}

impl <'a> TFTPClient<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn TFTPClientStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn TFTPClientStartTransferEvent);
  ...
}

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

This event is fired during the file download or upload.

Syntax

// TFTPClientTransferEventArgs carries the TFTPClient Transfer event's parameters.
pub struct TFTPClientTransferEventArgs {
  fn direction(&self) -> i32
  fn bytes_transferred(&self) -> i64
  fn percent_done(&self) -> i32
  fn text(&self) -> &[u8]
}

// TFTPClientTransferEvent defines the signature of the TFTPClient Transfer event's handler function.
pub trait TFTPClientTransferEvent {
  fn on_transfer(&self, sender : TFTPClient, e : &mut TFTPClientTransferEventArgs);
}

impl <'a> TFTPClient<'a> {
  pub fn on_transfer(&self) -> &'a dyn TFTPClientTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn TFTPClientTransferEvent);
  ...
}

Remarks

One or more on_transfer events are fired during file transfer. The bytes_transferred 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 Struct)

The struct 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 struct, 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 Struct)

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