TFTPServer Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 LocalPort property.

Optionally, you can set the LocalDir 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 StartListening 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:

• Error
• Log
• Connected
• ConnectionRequest
• Disconnected
• EndTransfer
• StartTransfer
• Transfer

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.

Connections Property (TFTPServer Module)

This property is a collection of currently connected clients.

Syntax

• Swift
• Objective-C

public var connections: [Int32: TFTPConnection] {
  get {...}
}

@property (nonatomic,readonly,assign,getter=connCount) int connCount;

- (int)connCount;

- (int)connConnectionId:(int)connId;

- (NSString*)connFileData:(int)connId;
- (void)setConnFileData:(int)connId :(NSString*)newConnFileData;

- (NSData*)connFileDataB:(int)connId;
- (void)setConnFileDataB:(int)connId :(NSData*)newConnFileData;
- (NSString*)connFileName:(int)connId;

- (NSString*)connLocalFile:(int)connId;
- (void)setConnLocalFile:(int)connId :(NSString*)newConnLocalFile;

- (NSString*)connRemoteHost:(int)connId;

- (int)connRemotePort:(int)connId;

- (NSString*)connTransferMode:(int)connId;

Default Value

5

Remarks

This property is a collection of TFTPConnection elements that contain information about each connected client.

Listening Property (TFTPServer Module)

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

Syntax

• Swift
• Objective-C

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

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

- (BOOL)listening;

Default Value

False

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setListening(listening: Bool) throws

LocalDir Property (TFTPServer Module)

This property defines the local file directory for the server.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localDir,setter=setLocalDir:) NSString* localDir;

- (NSString*)localDir;
- (void)setLocalDir :(NSString*)newLocalDir;

Default Value

""

Remarks

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

LocalHost Property (TFTPServer 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

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.

LocalPort Property (TFTPServer Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

69

Remarks

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

MaxRetransmits Property (TFTPServer Module)

This property specifies 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 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.

RetransmitTimeout Property (TFTPServer Module)

This property includes the 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.

Config Method (TFTPServer 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 (TFTPServer Module)

This method 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.

StartListening Method (TFTPServer Module)

This method starts listening for incoming connections.

Syntax

• Swift
• Objective-C

public func startListening() throws -> Void

- (void)startListening;

Remarks

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

To stop listening for new connections, call StopListening.

StopListening Method (TFTPServer Module)

This method stops listening for new connections.

Syntax

• Swift
• Objective-C

public func stopListening() throws -> Void

- (void)stopListening;

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.

Connected Event (TFTPServer Module)

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

Syntax

• Swift
• Objective-C

func onConnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onConnected:(int)connectionId :(int)statusCode :(NSString*)description;

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.

ConnectionRequest Event (TFTPServer Module)

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

Syntax

• Swift
• Objective-C

func onConnectionRequest(remoteHost: String, remotePort: Int32, fileName: String, transferMode: String, operation: Int32, accept: inout Bool)

- (void)onConnectionRequest:(NSString*)remoteHost :(int)remotePort :(NSString*)fileName :(NSString*)transferMode :(int)operation :(int*)accept;

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.

Disconnected Event (TFTPServer Module)

This event fires after a transfer is completed.

Syntax

• Swift
• Objective-C

func onDisconnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onDisconnected:(int)connectionId :(int)statusCode :(NSString*)description;

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.

EndTransfer Event (TFTPServer Module)

This event fires once a transfer is completed.

Syntax

• Swift
• Objective-C

func onEndTransfer(connectionId: Int32, direction: Int32)

- (void)onEndTransfer:(int)connectionId :(int)direction;

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.

Error Event (TFTPServer 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.

Log Event (TFTPServer Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(connectionId: Int32, logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)connectionId :(int)logLevel :(NSString*)message :(NSString*)logType;

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 PITrail 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"

StartTransfer Event (TFTPServer Module)

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

Syntax

• Swift
• Objective-C

func onStartTransfer(connectionId: Int32, direction: Int32)

- (void)onStartTransfer:(int)connectionId :(int)direction;

Remarks

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

Transfer Event (TFTPServer Module)

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

• Swift
• Objective-C

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

- (void)onTransfer:(int)connectionId :(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;

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.

TFTPConnection Type

This type specifies a client currently connected to the server.

Remarks

This type represents a client connection to the server.

See the Connections property for more information.

Fields

Constructors

public init()

public init(connID: , remoteHost: , remotePort: , localFile: , downloadStream: , uploadStream: , remoteFile: , mode: , isRead: , blockSize: , rolloverNum: )

Config Settings (TFTPServer Module)

TFTPServer Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TFTPServer Module)

TFTPServer Errors

UDP Errors

SSL Errors

TCP/IP Errors