TFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The TFTPServer Class is used to create a TFTP Server.

Syntax

TFTPServer

Remarks

The TFTPServer 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 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, open a file, etc, the corresponding TFTPServer 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ConnCount Property (TFTPServer Class)

The number of records in the Conn arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnCount();

Unicode (Windows)
INT GetConnCount();

int ipworks_tftpserver_getconncount(void* lpObj);

int GetConnCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ConnConnectionId
• ConnFileData
• ConnFilename
• ConnLocalFile
• ConnRemoteHost
• ConnRemotePort
• ConnTransferMode

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

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

Data Type

Integer

ConnConnectionId Property (TFTPServer Class)

This property contains a unique indentifier for this connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnConnectionId(int iConnId);

Unicode (Windows)
LPWSTR GetConnConnectionId(INT iConnId);

char* ipworks_tftpserver_getconnconnectionid(void* lpObj, int connid);

QString GetConnConnectionId(int iConnId);

Default Value

""

Remarks

This field contains a unique indentifier for this connection.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

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

Data Type

String

ConnFileData Property (TFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnFileData(int iConnId, char* &lpConnFileData, int &lenConnFileData);
int SetConnFileData(int iConnId, const char* lpConnFileData, int lenConnFileData);

Unicode (Windows)
INT GetConnFileData(INT iConnId, LPSTR &lpConnFileData, INT &lenConnFileData);
INT SetConnFileData(INT iConnId, LPCSTR lpConnFileData, INT lenConnFileData);

int ipworks_tftpserver_getconnfiledata(void* lpObj, int connid, char** lpConnFileData, int* lenConnFileData);
int ipworks_tftpserver_setconnfiledata(void* lpObj, int connid, const char* lpConnFileData, int lenConnFileData);

QByteArray GetConnFileData(int iConnId);
int SetConnFileData(int iConnId, QByteArray qbaConnFileData);

Default Value

""

Remarks

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

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

This property is not available at design time.

Data Type

Binary String

ConnFilename Property (TFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnFilename(int iConnId);

Unicode (Windows)
LPWSTR GetConnFilename(INT iConnId);

char* ipworks_tftpserver_getconnfilename(void* lpObj, int connid);

QString GetConnFilename(int iConnId);

Default Value

""

Remarks

This property represents the Filename of the file the client wants to upload or download. Note: FileData must be empty in order to use this property.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

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

Data Type

String

ConnLocalFile Property (TFTPServer Class)

This is the local file on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnLocalFile(int iConnId);
int SetConnLocalFile(int iConnId, const char* lpszConnLocalFile);

Unicode (Windows)
LPWSTR GetConnLocalFile(INT iConnId);
INT SetConnLocalFile(INT iConnId, LPCWSTR lpszConnLocalFile);

char* ipworks_tftpserver_getconnlocalfile(void* lpObj, int connid);
int ipworks_tftpserver_setconnlocalfile(void* lpObj, int connid, const char* lpszConnLocalFile);

QString GetConnLocalFile(int iConnId);
int SetConnLocalFile(int iConnId, QString qsConnLocalFile);

Default Value

""

Remarks

This is the local file on the server. This file is written to when a client puts a file, and data is pulled from this file when a client requests a file.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

This property is not available at design time.

Data Type

String

ConnRemoteHost Property (TFTPServer Class)

This property represents the IP address of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnRemoteHost(int iConnId);

Unicode (Windows)
LPWSTR GetConnRemoteHost(INT iConnId);

char* ipworks_tftpserver_getconnremotehost(void* lpObj, int connid);

QString GetConnRemoteHost(int iConnId);

Default Value

""

Remarks

This property represents the IP address of the connected client.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

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

Data Type

String

ConnRemotePort Property (TFTPServer Class)

This property represents the port of the connected client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnRemotePort(int iConnId);

Unicode (Windows)
INT GetConnRemotePort(INT iConnId);

int ipworks_tftpserver_getconnremoteport(void* lpObj, int connid);

int GetConnRemotePort(int iConnId);

Default Value

0

Remarks

This property represents the port of the connected client.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

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

Data Type

Integer

ConnTransferMode Property (TFTPServer Class)

Transfers are done in octet mode 0 or netascii mode 1 .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetConnTransferMode(int iConnId);

Unicode (Windows)
LPWSTR GetConnTransferMode(INT iConnId);

char* ipworks_tftpserver_getconntransfermode(void* lpObj, int connid);

QString GetConnTransferMode(int iConnId);

Default Value

""

Remarks

Transfers are done in octet mode 0 or netascii mode 1.

The ConnId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnCount property.

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

Data Type

String

Listening Property (TFTPServer Class)

If set to True, the class accepts incoming connections on LocalPort.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();
int SetListening(int bListening);

Unicode (Windows)
BOOL GetListening();
INT SetListening(BOOL bListening);

int ipworks_tftpserver_getlistening(void* lpObj);
int ipworks_tftpserver_setlistening(void* lpObj, int bListening);

bool GetListening();
int SetListening(bool bListening);

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

This property is not available at design time.

Data Type

Boolean

LocalDir Property (TFTPServer Class)

The local file directory for the server.

Syntax

• C++
• C
• Qt

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

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

char* ipworks_tftpserver_getlocaldir(void* lpObj);
int ipworks_tftpserver_setlocaldir(void* lpObj, const char* lpszLocalDir);

QString GetLocalDir();
int SetLocalDir(QString qsLocalDir);

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

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

Syntax

• C++
• C
• Qt

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

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

char* ipworks_tftpserver_getlocalhost(void* lpObj);
int ipworks_tftpserver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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.

Data Type

String

LocalPort Property (TFTPServer Class)

This is the port that the server will listen on.

Syntax

• C++
• C
• Qt

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

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

int ipworks_tftpserver_getlocalport(void* lpObj);
int ipworks_tftpserver_setlocalport(void* lpObj, int iLocalPort);

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

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

Syntax

• C++
• C
• Qt

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

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

int ipworks_tftpserver_getmaxretransmits(void* lpObj);
int ipworks_tftpserver_setmaxretransmits(void* lpObj, int iMaxRetransmits);

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

Data Type

Integer

RetransmitTimeout Property (TFTPServer Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworks_tftpserver_getretransmittimeout(void* lpObj);
int ipworks_tftpserver_setretransmittimeout(void* lpObj, int iRetransmitTimeout);

int GetRetransmitTimeout();
int SetRetransmitTimeout(int iRetransmitTimeout);

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.

Data Type

Integer

Timeout Property (TFTPServer Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_tftpserver_gettimeout(void* lpObj);
int ipworks_tftpserver_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 fails with an error.

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.

Data Type

Integer

Config Method (TFTPServer Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_tftpserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

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

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_tftpserver_doevents(void* lpObj);

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

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworks_tftpserver_startlistening(void* lpObj);

int 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. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

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

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworks_tftpserver_stoplistening(void* lpObj);

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.

To stop listening and to disconnect all existing clients, call Shutdown instead.

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

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

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class TFTPServerConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(TFTPServerConnectedEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireConnected(TFTPServerConnectedEventParams *e) {...}

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 the 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 Class)

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

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_CONNECTIONREQUEST 2

virtual INT IPWORKS_CALL FireConnectionRequest(LPSTR &lpszRemoteHost, INT &iRemotePort, LPSTR &lpszFilename, LPSTR &lpszTransferMode, INT &iOperation, BOOL &bAccept);

class TFTPServerConnectionRequestEventParams {
public:
  const QString &RemoteHost();

  int RemotePort();

  const QString &Filename();

  const QString &TransferMode();

  int Operation();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionRequest(TFTPServerConnectionRequestEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireConnectionRequest(TFTPServerConnectionRequestEventParams *e) {...}

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

This event fires after a transfer is completed.

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_DISCONNECTED 3

virtual INT IPWORKS_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class TFTPServerDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(TFTPServerDisconnectedEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireDisconnected(TFTPServerDisconnectedEventParams *e) {...}

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 the error code. The Description will be a textual description of the error.

EndTransfer Event (TFTPServer Class)

This event fires once a transfer is completed.

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_ENDTRANSFER 4

virtual INT IPWORKS_CALL FireEndTransfer(INT &iConnectionId, INT &iDirection);

class TFTPServerEndTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(TFTPServerEndTransferEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireEndTransfer(TFTPServerEndTransferEventParams *e) {...}

Remarks

The ConnectionId will be the 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 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_ERROR 5

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class TFTPServerErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(TFTPServerErrorEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireError(TFTPServerErrorEventParams *e) {...}

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

Log Event (TFTPServer Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_LOG 6

virtual INT IPWORKS_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class TFTPServerLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(TFTPServerLogEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireLog(TFTPServerLogEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_STARTTRANSFER 7

virtual INT IPWORKS_CALL FireStartTransfer(INT &iConnectionId, INT &iDirection);

class TFTPServerStartTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(TFTPServerStartTransferEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireStartTransfer(TFTPServerStartTransferEventParams *e) {...}

Remarks

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

Transfer Event (TFTPServer Class)

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

Syntax

• C++
• C
• Qt

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;

#define EID_TFTPSERVER_TRANSFER 8

virtual INT IPWORKS_CALL FireTransfer(INT &iConnectionId, INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class TFTPServerTransferEventParams {
public:
  int ConnectionId();

  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(TFTPServerTransferEventParams *e);

// Or, subclass TFTPServer and override this emitter function.
virtual int FireTransfer(TFTPServerTransferEventParams *e) {...}

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.

Config Settings (TFTPServer Class)

TFTPServer Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (TFTPServer 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

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

UDP Errors

SSL Errors

TCP/IP Errors