# TFTPServer Class

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

## Syntax

```text
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](#localport-property-tftpserver-class) property.

Optionally, you can set the [LocalDir](#localdir-property-tftpserver-class) 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](#startlistening-method-tftpserver-class) 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](#error-event-tftpserver-class)
- [Log](#log-event-tftpserver-class)
- [Connected](#connected-event-tftpserver-class)
- [ConnectionRequest](#connectionrequest-event-tftpserver-class)
- [Disconnected](#disconnected-event-tftpserver-class)
- [EndTransfer](#endtransfer-event-tftpserver-class)
- [StartTransfer](#starttransfer-event-tftpserver-class)
- [Transfer](#transfer-event-tftpserver-class)

## Property List

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

|  |  |
| --- | --- |
| [Connections](#connections-property-tftpserver-class) | This property is a collection of currently connected clients. |
| [Listening](#listening-property-tftpserver-class) | This property indicates whether the class is listening for incoming connections on LocalPort. |
| [LocalDir](#localdir-property-tftpserver-class) | This property defines the local file directory for the server. |
| [LocalHost](#localhost-property-tftpserver-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LocalPort](#localport-property-tftpserver-class) | This property includes the port that the server will listen on. |
| [MaxRetransmits](#maxretransmits-property-tftpserver-class) | This property specifies the number of times to retry sending a failed packet before disconnecting. |
| [RetransmitTimeout](#retransmittimeout-property-tftpserver-class) | This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-tftpserver-class) | Sets or retrieves a configuration setting. |
| [DoEvents](#doevents-method-tftpserver-class) | This method processes events from the internal message queue. |
| [StartListening](#startlistening-method-tftpserver-class) | This method starts listening for incoming connections. |
| [StopListening](#stoplistening-method-tftpserver-class) | This method stops listening for new connections. |

## 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.*

|  |  |
| --- | --- |
| [Connected](#connected-event-tftpserver-class) | This event fires immediately after a connection completes (or fails). |
| [ConnectionRequest](#connectionrequest-event-tftpserver-class) | This event fires anytime a connected client attempts a connection to the server. |
| [Disconnected](#disconnected-event-tftpserver-class) | This event fires after a transfer is completed. |
| [EndTransfer](#endtransfer-event-tftpserver-class) | This event fires once a transfer is completed. |
| [Error](#error-event-tftpserver-class) | Fired when information is available about errors during data delivery. |
| [Log](#log-event-tftpserver-class) | This event fires once for each log message. |
| [StartTransfer](#starttransfer-event-tftpserver-class) | This event fires immediately after a client initiates a file transfer. |
| [Transfer](#transfer-event-tftpserver-class) | 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. |

## Config Settings

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

|  |  |
| --- | --- |
| [DefaultRollOverNumber](#DefaultRollOverNumber) | Whether to enable block roll over. |
| [CaptureIPPacketInfo](#CaptureIPPacketInfo) | Used to capture the packet information. |
| [DelayHostResolution](#DelayHostResolution) | Whether the hostname is resolved when RemoteHost is set. |
| [DestinationAddress](#DestinationAddress) | Used to get the destination address from the packet information. |
| [DontFragment](#DontFragment) | Used to set the Don't Fragment flag of outgoing packets. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxPacketSize](#MaxPacketSize) | The maximum length of the packets that can be received. |
| [QOSDSCPValue](#QOSDSCPValue) | Used to specify an arbitrary QOS/DSCP setting (optional). |
| [QOSTrafficType](#QOSTrafficType) | Used to specify QOS/DSCP settings (optional). |
| [ShareLocalPort](#ShareLocalPort) | If set to True, allows more than one instance of the class to be active on the same local port. |
| [SourceIPAddress](#SourceIPAddress) | Used to set the source IP address used when sending a packet. |
| [SourceMacAddress](#SourceMacAddress) | Used to set the source MAC address used when sending a packet. |
| [UseConnection](#UseConnection) | Determines whether to use a connected socket. |
| [UseIPv6](#UseIPv6) | Whether or not to use IPv6. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Connections Property ([TFTPServer](#tftpserver-class) Class)

This property is a collection of currently connected clients.

## Syntax

```text
IPWorksList<IPWorksTFTPConnection>* GetConnections();
```

## Remarks

This property is a collection of [TFTPConnection](#tftpconnection-type) elements that contain information about each connected client.

This property is read-only and not available at design time.

## Data Type

[IPWorksTFTPConnection](#tftpconnection-type)

# Listening Property ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();
```

## Default Value

FALSE

## Remarks

This property indicates whether the class is listening for connections on the port specified by the [LocalPort](#localport-property-tftpserver-class) property. Use the [StartListening](#startlistening-method-tftpserver-class) and [StopListening](#stoplistening-method-tftpserver-class) methods to control whether the class is listening.

This property is read-only and not available at design time.

## Data Type

Boolean

# LocalDir Property ([TFTPServer](#tftpserver-class) Class)

This property defines the local file directory for the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetLocalDir();int SetLocalDir(const char* lpszLocalDir);

Unicode (Windows)
LPWSTR GetLocalDir();INT SetLocalDir(LPCWSTR lpszLocalDir);
```

## Default Value

""

## Remarks

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

This property is not available at design time.

## Data Type

String

# LocalHost Property ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetLocalHost();int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();INT SetLocalHost(LPCWSTR lpszLocalHost);
```

## 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 classes) 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.

## Data Type

String

# LocalPort Property ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetLocalPort();int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();INT SetLocalPort(INT iLocalPort);
```

## Default Value

69

## Remarks

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

## Data Type

Integer

# MaxRetransmits Property ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetMaxRetransmits();int SetMaxRetransmits(int iMaxRetransmits);

Unicode (Windows)
INT GetMaxRetransmits();INT SetMaxRetransmits(INT iMaxRetransmits);
```

## 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](#retransmittimeout-property-tftpserver-class) determines the wait time (in seconds) between successive retransmissions.

The default value for the MaxRetransmits property is 3.

## Data Type

Integer

# RetransmitTimeout Property ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetRetransmitTimeout();int SetRetransmitTimeout(int iRetransmitTimeout);

Unicode (Windows)
INT GetRetransmitTimeout();INT SetRetransmitTimeout(INT iRetransmitTimeout);
```

## Default Value

5

## Remarks

Please refer to the [MaxRetransmits](#maxretransmits-property-tftpserver-class) property for the number of retransmit efforts before an error is returned.

The default value for the RetransmitTimeout is 5 seconds.

## Data Type

Integer

# Config Method ([TFTPServer](#tftpserver-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-tftpserver-class) 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](#config-settings-tftpserver-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DoEvents Method ([TFTPServer](#tftpserver-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT 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.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StartListening Method ([TFTPServer](#tftpserver-class) Class)

This method starts listening for incoming connections.

## Syntax

```text
ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();
```

## Remarks

This method begins listening for incoming connections on the port specified by [LocalPort](#localport-property-tftpserver-class). Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call [StopListening](#stoplistening-method-tftpserver-class).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StopListening Method ([TFTPServer](#tftpserver-class) Class)

This method stops listening for new connections.

## Syntax

```text
ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT 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.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Connected Event ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnected(TFTPServerConnectedEventParams *e);
typedef struct {  int ConnectionId;  int StatusCode;  const char *Description;
  int reserved;
} TFTPServerConnectedEventParams;

Unicode (Windows)
virtual INT FireConnected(TFTPServerConnectedEventParams *e);
typedef struct {  INT ConnectionId;  INT StatusCode;  LPCWSTR Description;
  INT reserved;
} TFTPServerConnectedEventParams;
```

## Remarks

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

Upon a successful connection, the *StatusCode* 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](#trappable-errors-tftpserver-class) section.

# ConnectionRequest Event ([TFTPServer](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnectionRequest(TFTPServerConnectionRequestEventParams *e);
typedef struct {  const char *RemoteHost;  int RemotePort;  const char *FileName;  const char *TransferMode;  int Operation;  int Accept;
  int reserved;
} TFTPServerConnectionRequestEventParams;

Unicode (Windows)
virtual INT FireConnectionRequest(TFTPServerConnectionRequestEventParams *e);
typedef struct {  LPCWSTR RemoteHost;  INT RemotePort;  LPCWSTR FileName;  LPCWSTR TransferMode;  INT Operation;  BOOL Accept;
  INT reserved;
} TFTPServerConnectionRequestEventParams;
```

## 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](#tftpserver-class) Class)

This event fires after a transfer is completed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDisconnected(TFTPServerDisconnectedEventParams *e);
typedef struct {  int ConnectionId;  int StatusCode;  const char *Description;
  int reserved;
} TFTPServerDisconnectedEventParams;

Unicode (Windows)
virtual INT FireDisconnected(TFTPServerDisconnectedEventParams *e);
typedef struct {  INT ConnectionId;  INT StatusCode;  LPCWSTR Description;
  INT reserved;
} TFTPServerDisconnectedEventParams;
```

## 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](#tftpserver-class) Class)

This event fires once a transfer is completed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireEndTransfer(TFTPServerEndTransferEventParams *e);
typedef struct {  int ConnectionId;  int Direction;
  int reserved;
} TFTPServerEndTransferEventParams;

Unicode (Windows)
virtual INT FireEndTransfer(TFTPServerEndTransferEventParams *e);
typedef struct {  INT ConnectionId;  INT Direction;
  INT reserved;
} TFTPServerEndTransferEventParams;
```

## 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](#tftpserver-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(TFTPServerErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} TFTPServerErrorEventParams;

Unicode (Windows)
virtual INT FireError(TFTPServerErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} TFTPServerErrorEventParams;
```

## Remarks

The 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](#trappable-errors-tftpserver-class) section.

# Log Event ([TFTPServer](#tftpserver-class) Class)

This event fires once for each log message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLog(TFTPServerLogEventParams *e);
typedef struct {  int ConnectionId;  int LogLevel;  const char *Message;  const char *LogType;
  int reserved;
} TFTPServerLogEventParams;

Unicode (Windows)
virtual INT FireLog(TFTPServerLogEventParams *e);
typedef struct {  INT ConnectionId;  INT LogLevel;  LPCWSTR Message;  LPCWSTR LogType;
  INT reserved;
} TFTPServerLogEventParams;
```

## Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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](#tftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireStartTransfer(TFTPServerStartTransferEventParams *e);
typedef struct {  int ConnectionId;  int Direction;
  int reserved;
} TFTPServerStartTransferEventParams;

Unicode (Windows)
virtual INT FireStartTransfer(TFTPServerStartTransferEventParams *e);
typedef struct {  INT ConnectionId;  INT Direction;
  INT reserved;
} TFTPServerStartTransferEventParams;
```

## Remarks

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

# Transfer Event ([TFTPServer](#tftpserver-class) Class)

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

```text
ANSI (Cross Platform)
virtual int FireTransfer(TFTPServerTransferEventParams *e);
typedef struct {  int ConnectionId;  int Direction;  int64 BytesTransferred;  int PercentDone;  const char *Text;
  int lenText;
  int reserved;
} TFTPServerTransferEventParams;

Unicode (Windows)
virtual INT FireTransfer(TFTPServerTransferEventParams *e);
typedef struct {  INT ConnectionId;  INT Direction;  LONG64 BytesTransferred;  INT PercentDone;  LPCSTR Text;
  INT lenText;
  INT reserved;
} TFTPServerTransferEventParams;
```

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

## Syntax

 *IPWorksTFTPConnection* (declared in *ipworks.h*)

## Remarks

This type represents a client connection to the server.

See the [Connections](#connections-property-tftpserver-class) property for more information.

The following fields are available:

- [ConnectionId](#TFTPConnection_f_ConnectionId)

- [FileData](#TFTPConnection_f_FileData)

- [FileName](#TFTPConnection_f_FileName)

- [LocalFile](#TFTPConnection_f_LocalFile)

- [RemoteHost](#TFTPConnection_f_RemoteHost)

- [RemotePort](#TFTPConnection_f_RemotePort)

- [TransferMode](#TFTPConnection_f_TransferMode)

## Fields

 **ConnectionId** *int (read-only)*
*Default Value: 0*

This field contains a unique identifier for this connection.

 **FileData** *char**
*Default Value: ""*

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

 **FileName** *char* (read-only)*
*Default Value: ""*

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

NOTE: *FileData* must be empty to use this field.

 **LocalFile** *char**
*Default Value: ""*

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

 **RemoteHost** *char* (read-only)*
*Default Value: ""*

This field represents the IP address of the connected client.

 **RemotePort** *int (read-only)*
*Default Value: 0*

This field represents the port of the connected client.

 **TransferMode** *char* (read-only)*
*Default Value: ""*

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

## Constructors

```text
TFTPConnection()
```

```text
TFTPConnection(const char* lpszConnID, const char* lpszRemoteHost, int iRemotePort, const char* lpszLocalFile, IPWorksStream* sDownloadStream, IPWorksStream* sUploadStream, const char* lpszRemoteFile, const char* lpszMode, int bisRead, int iblockSize, int irolloverNum)
```

# IPWorksList Type

## Syntax

 *IPWorksList<T>* (declared in *ipworks.h*)

## Remarks

 *IPWorksList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the TFTPServer class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# Config Settings ([TFTPServer](#tftpserver-class) Class)

 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](#config-method-tftpserver-class) method.

### TFTPServer Config Settings

**DefaultRollOverNumber**: Whether to enable block roll over.This configuration setting determines what the block counter will roll over to once the block counter has reached its maximum. Acceptable values are 0 and 1.

### UDP Config Settings

**CaptureIPPacketInfo**: Used to capture the packet information.If this is set to True, the component will capture the IP packet information.

The default value for this setting is False.

NOTE: This configuration setting is available only in Windows.

**DelayHostResolution**: Whether the hostname is resolved when RemoteHost is set.This configuration setting specifies whether a hostname is resolved immediately when RemoteHost is set. If *true* the class will resolve the hostname and the IP address will be present in the RemoteHost property. If *false*, the hostname is not resolved until needed by the component when a method to connect or send data is called. If desired, ResolveRemoteHost may be called to manually resolve the value in RemoteHost at any time.

The default value is *false*.

**DestinationAddress**: Used to get the destination address from the packet information.If [CaptureIPPacketInfo](#CaptureIPPacketInfo) is set to True, then this will be populated with the packet's destination address when a packet is received. This information will be accessible in the DataIn event.

NOTE: This configuration setting is available only in Windows.

**DontFragment**: Used to set the Don't Fragment flag of outgoing packets.When set to True, packets sent by the class will have the Don't Fragment flag set. The default value is False.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-tftpserver-class) setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#localhost-property-tftpserver-class) setting 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).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-tftpserver-class) after the connection is established.

[LocalPort](#localport-property-tftpserver-class) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxPacketSize**: The maximum length of the packets that can be received.This configuration setting specifies the maximum size of the datagrams that the class will accept without truncation.

**QOSDSCPValue**: Used to specify an arbitrary QOS/DSCP setting (optional).[UseConnection](#UseConnection) must be True to use this configuration setting. This option allows you to specify an arbitrary DSCP value between 0 and 63. The default is 0. When set to the default value, the component will not set a DSCP value.

NOTE: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.

**QOSTrafficType**: Used to specify QOS/DSCP settings (optional).[UseConnection](#UseConnection) must be True to use this setting. You may specify either the text or integer values: BestEffort (0), Background (1), ExcellentEffort (2), AudioVideo (3), Voice (4), and Control (5).

NOTE: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.

NOTE: QOSTrafficType must be set before setting Active to True.

**ShareLocalPort**: If set to True, allows more than one instance of the class to be active on the same local port.This option must be set before the class is activated through the Active property or it will have no effect.

The default value for this setting is False.

**SourceIPAddress**: Used to set the source IP address used when sending a packet.This configuration setting can be used to override the source IP address when sending a packet.

NOTE: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

**SourceMacAddress**: Used to set the source MAC address used when sending a packet.This configuration setting can be used to override the source MAC address when sending a packet.

NOTE: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

**UseConnection**: Determines whether to use a connected socket.[UseConnection](#UseConnection) specifies whether or not the class should use a connected socket. The connection is defined as an association in between the local address/port and the remote address/port. As such, this is not a connection in the traditional Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

**UseIPv6**: Whether or not to use IPv6.By default, the component expects an IPv4 address for local and remote host properties, and it will create an IPv4 socket. To use IPv6 instead, set this to True.

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-tftpserver-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([TFTPServer](#tftpserver-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### TFTPServer Errors

|  |  |
| --- | --- |
| 122 | Packet too large. |
| 123 | Wrong response type from server. |
| 124 | Server error. Description contains detailed information. |
| 125 | Invalid server response. |
| 126 | A valid LocalFile must be provided for PUT operations. |
| 127 | Cannot open local file. |
| 128 | Cannot write to local file. |
| 129 | Cannot read local file. |
| 130 | Busy performing the current transfer. |
| 301 | Timeout while waiting for server. |
| 305 | Server error. |
| 306 | Wrong or invalid response type received from server. |
| 307 | Invalid response from server. |

The class may also return one of the following error codes, which are inherited from other classes.

### UDP Errors

|  |  |
| --- | --- |
| 104 | UDP is already Active. |
| 106 | You cannot change the [LocalPort](#localport-property-tftpserver-class) while the class is Active. |
| 107 | You cannot change the [LocalHost](#localhost-property-tftpserver-class) at this time. A connection is in progress. |
| 109 | The class must be Active for this operation. |
| 112 | You cannot change [MaxPacketSize](#MaxPacketSize) while the class is Active. |
| 113 | You cannot change [ShareLocalPort](#ShareLocalPort) option while the class is Active. |
| 114 | You cannot change RemoteHost when [UseConnection](#UseConnection) is set and the class Active. |
| 115 | You cannot change RemotePort when [UseConnection](#UseConnection) is set and the class is Active. |
| 116 | RemotePort cannot be zero when [UseConnection](#UseConnection) is set. Please specify a valid service port number. |
| 117 | You cannot change [UseConnection](#UseConnection) while the class is Active. |
| 118 | Message cannot be longer than [MaxPacketSize](#MaxPacketSize). |
| 119 | Message too short. |
| 434 | Unable to convert string to selected CodePage. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |