TFTPClient Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IPWorks.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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Idle Property (TFTPClient Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

LocalFile Property (TFTPClient Module)

The file on the local host to transfer the data to/from.

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

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.

LocalHost Property (TFTPClient Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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.

MaxRetransmits Property (TFTPClient Module)

The number of times to retry sending a failed packet before disconnecting.

Syntax

• Swift
• Objective-C

public var maxRetransmits: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=maxRetransmits,setter=setMaxRetransmits:) int maxRetransmits;

- (int)maxRetransmits;
- (void)setMaxRetransmits :(int)newMaxRetransmits;

Default Value

3

Remarks

This property allows you to specify the number of times that you would like to try re-sending 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.

RemoteFile Property (TFTPClient Module)

The file on the remote host.

Syntax

• Swift
• Objective-C

public var remoteFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remoteFile,setter=setRemoteFile:) NSString* remoteFile;

- (NSString*)remoteFile;
- (void)setRemoteFile :(NSString*)newRemoteFile;

Default Value

""

Remarks

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

RetransmitTimeout Property (TFTPClient Module)

Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.

Syntax

• Swift
• Objective-C

public var retransmitTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=retransmitTimeout,setter=setRetransmitTimeout:) int retransmitTimeout;

- (int)retransmitTimeout;
- (void)setRetransmitTimeout :(int)newRetransmitTimeout;

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.

TFTPPort Property (TFTPClient Module)

The UDP port where the remote TFTP server is listening.

Syntax

• Swift
• Objective-C

public var tftpPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=TFTPPort,setter=setTFTPPort:) int TFTPPort;

- (int)TFTPPort;
- (void)setTFTPPort :(int)newTFTPPort;

Default Value

69

Remarks

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

TFTPServer Property (TFTPClient Module)

The address of the TFTP server to exchange files with.

Syntax

• Swift
• Objective-C

public var tftpServer: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=TFTPServer,setter=setTFTPServer:) NSString* TFTPServer;

- (NSString*)TFTPServer;
- (void)setTFTPServer :(NSString*)newTFTPServer;

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

Timeout Property (TFTPClient Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 (TFTPClient Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 (TFTPClient Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

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

GetFile Method (TFTPClient Module)

Download a RemoteFile from the TFTP server.

Syntax

• Swift
• Objective-C

public func getFile() throws -> Void

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

Interrupt Method (TFTPClient Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

PutFile Method (TFTPClient Module)

Upload a file specified by LocalFile to the TFTP server.

Syntax

• Swift
• Objective-C

public func putFile() throws -> Void

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

Reset Method (TFTPClient Module)

Reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

EndTransfer Event (TFTPClient Module)

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

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)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 (TFTPClient Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

This event fires when a file starts downloading or uploading.

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)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 (TFTPClient Module)

This event is fired during the file download or upload.

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)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 Module)

TFTPClient Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TFTPClient Module)

TFTPClient Errors

UDP Errors

SSL Errors

TCP/IP Errors