Docs

IPWorks 2022 Java Edition

Version 22.0 [Build 8171]

TFTPServer Class

Properties   Methods   Events   Configuration Settings   Errors  

TBD.

Syntax

ipworks.Tftpserver

Remarks

TBD.

Property List


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

AcceptDataEnables or disables data reception (the DataIn event).
ActiveEnables or disables sending and receiving of data.
ConnectionsTBD.
DefaultFileDirThe default local file directory for connecting clients.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortTBD.
MaxRetransmitsThe number of times to retry sending a failed packet before disconnecting.
RetransmitTimeoutMaximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
TimeoutA timeout for the class.

Method List


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

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.

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.

ConnectedTBD.
ConnectionRequestTBD.
DisconnectedTBD.
EndTransferTBD.
ErrorInformation about errors during data delivery.
LogFires once for each log message.
StartTransferTBD.
TransferTBD.

Configuration Settings


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

CaptureIPPacketInfoUsed to capture the packet information.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxPacketSizeThe maximum length of the packets that can be received.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
ShareLocalPortIf set to True, allows more than one instance of the class to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the class whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the class are daemon threads.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AcceptData Property (TFTPServer Class)

Enables or disables data reception (the DataIn event).

Syntax


public boolean isAcceptData();


public void setAcceptData(boolean acceptData);

Default Value

True

Remarks

This property enables or disables data reception (the DataIn event). Setting this property to False, temporarily disables data reception (and the DataIn event). Setting this property to True, re-enables data reception.

Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.

This property is not available at design time.

Active Property (TFTPServer Class)

Enables or disables sending and receiving of data.

Syntax


public boolean isActive();


public void setActive(boolean active);

Default Value

False

Remarks

Setting the Active property to True makes the class create a communication endpoint (socket) which can be used for sending and receiving UDP datagrams. Setting it to False destroys the socket and disables data communications.

If UseConnection is set to True, then a local association (connection) to the remote host and port is also created.

Note: It is recommended to use the Activate or Deactivate method instead of setting this property.

This property is not available at design time.

Connections Property (TFTPServer Class)

TBD.

Syntax


public TFTPConnectionMap getConnections();


Remarks

TBD.

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

DefaultFileDir Property (TFTPServer Class)

The default local file directory for connecting clients.

Syntax


public String getDefaultFileDir();


public void setDefaultFileDir(String defaultFileDir);

Default Value

""

Remarks

This property defines the local file directory for users with an empty local file directory value.

This property is not available at design time.

LocalHost Property (TFTPServer Class)

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

Syntax


public String getLocalHost();


public void setLocalHost(String localHost);

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.

LocalPort Property (TFTPServer Class)

TBD.

Syntax


public int getLocalPort();


public void setLocalPort(int localPort);

Default Value

69

Remarks

TBD.

MaxRetransmits Property (TFTPServer Class)

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

Syntax


public int getMaxRetransmits();


public void setMaxRetransmits(int maxRetransmits);

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.

RetransmitTimeout Property (TFTPServer Class)

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

Syntax


public int getRetransmitTimeout();


public void setRetransmitTimeout(int retransmitTimeout);

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.

Timeout Property (TFTPServer Class)

A timeout for the class.

Syntax


public int getTimeout();


public void setTimeout(int timeout);

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 throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Config Method (Tftpserver Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 Class)

Processes events from the internal message queue.

Syntax

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

Connected Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void connected(TftpserverConnectedEvent e) {}
  ...
}

public class TftpserverConnectedEvent {
  public String connectionId;

  public int statusCode;

  public String description;

}

Remarks

TBD.

ConnectionRequest Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void connectionRequest(TftpserverConnectionRequestEvent e) {}
  ...
}

public class TftpserverConnectionRequestEvent {
  public String remoteHost;

  public int remotePort;

  public String filename;

  public String transferMode;

  public boolean isRead;

  public boolean accept;

}

Remarks

TBD.

Disconnected Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void disconnected(TftpserverDisconnectedEvent e) {}
  ...
}

public class TftpserverDisconnectedEvent {
  public String connectionId;

  public int statusCode;

  public String description;

}

Remarks

TBD.

EndTransfer Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void endTransfer(TftpserverEndTransferEvent e) {}
  ...
}

public class TftpserverEndTransferEvent {
  public String connectionId;

  public int direction;

}

Remarks

TBD.

Error Event (Tftpserver Class)

Information about errors during data delivery.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void error(TftpserverErrorEvent e) {}
  ...
}

public class TftpserverErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

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

ErrorCode contains an error code and Description 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)

Fires once for each log message.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void log(TftpserverLogEvent e) {}
  ...
}

public class TftpserverLogEvent {
  public String connectionId;

  public int logLevel;

  public String message;

  public String 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:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is 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:

  • "Info"
  • "Error"
  • "Verbose"
  • "Debug"
  • "PITrail"

StartTransfer Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void startTransfer(TftpserverStartTransferEvent e) {}
  ...
}

public class TftpserverStartTransferEvent {
  public String connectionId;

  public int direction;

}

Remarks

TBD.

Transfer Event (Tftpserver Class)

TBD.

Syntax

public class DefaultTftpserverEventListener implements TftpserverEventListener {
  ...
  public void transfer(TftpserverTransferEvent e) {}
  ...
}

public class TftpserverTransferEvent {
  public String connectionId;

  public int direction;

  public long bytesTransferred;

  public int percentDone;

  public byte[] text;

}

Remarks

TBD.

TFTPConnection Type

TBD.

Remarks

TBD.

Fields

ConnId
String

TBD

DownloadStream
java.io.OutputStream

TBD.(Its default value is "". ).

LocalFile
String

TBD.(Its default value is "". ).

RemoteFile
String

TBD.(The field is read-only. Its default value is "". ).

RemoteHost
String

TBD.(The field is read-only. Its default value is "". ).

RemotePort
int

TBD.(The field is read-only. Its default value is 0. ).

TransferMode
String

TBD.(The field is read-only. Its default value is "". ).

UploadStream
java.io.InputStream

TBD.(Its default value is "". ).

Constructors

public TFTPConnection();



public TFTPConnection(String remoteHost, int remotePort, String localFile, java.io.OutputStream downloadStream, java.io.InputStream uploadStream, String remoteFile, int mode);



Configuration Settings (Tftpserver 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 method.

UDPPort Configuration 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 setting is only available in Windows.

DelayHostResolution:   Whether the hostname is resolved when RemoteHost is set.

This 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 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 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 setting is only available 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 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 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 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This 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 after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in 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 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 must be True to use this 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 setting uses the qWAVE API is only available on Windows 7, Windows Server 2008 R2, and later.

QOSTrafficType:   Used to specify QOS/DSCP settings (optional).

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 setting uses the qWAVE API which is only available 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.

UseConnection:   Determines whether to use a connected socket.

UseConnection specifies whether the class should use a connected socket or not. 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 TCP sense. What it means is only that the class will send and receive data only 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 will create an IPv4 socket. To use IPv6 instead, set this to True.

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which 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 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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 Configuration Settings

BuildInfo:   Information about the product's build.

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

GUIAvailable:   Tells the class whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.

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).
UseDaemonThreads:   Whether threads created by the class are daemon threads.

If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (Tftpserver Class)

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   Can't open local file.
128   Can't write to local file.
129   Can't 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.

UDPPort Errors

104   UDPPort is already Active.
106   You cannot change the LocalPort while the class is Active.
107   You cannot change the LocalHost at this time. A connection is in progress.
109   The class must be Active for this operation.
112   Cannot change MaxPacketSize while the class is Active.
113   Cannot change ShareLocalPort option while the class is Active.
114   Cannot change RemoteHost when UseConnection is set and the class Active.
115   Cannot change RemotePort when UseConnection is set and the class is Active.
116   RemotePort can't be zero when UseConnection is set. Please specify a valid service port number.
117   Cannot change UseConnection while the class is Active.
118   Message can't be longer than 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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 Java Edition - Version 22.0 [Build 8171]