TFTPServer Control
Properties Methods Events Config Settings Errors
The TFTPServer Control is used to create a TFTP Server.
Syntax
TFTPServer
Remarks
The TFTPServer control 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 control will serve files from this location. When clients connect, they can request files from this location. If this property is not set then the control 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 control'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:
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
ConnCount | The number of records in the Conn arrays. |
ConnConnectionId | This property contains a unique indentifier for this connection. |
ConnFileData | This property is only available for sending data to a connected client. |
ConnFilename | This property represents the Filename of the file the client wants to upload or download. |
ConnLocalFile | This is the local file on the server. |
ConnRemoteHost | This property represents the IP address of the connected client. |
ConnRemotePort | This property represents the port of the connected client. |
ConnTransferMode | Transfers are done in octet mode 0 or netascii mode 1 . |
Listening | If set to True, the control accepts incoming connections on LocalPort. |
LocalDir | The local file directory for the server. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | This is the port that the server will listen on. |
MaxRetransmits | The number of times to retry sending a failed packet before disconnecting. |
RetransmitTimeout | Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet. |
Timeout | A timeout for the control. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
StartListening | This method starts listening for incoming connections. |
StopListening | This method stops listening for new connections. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
Connected | This event fires immediately after a connection completes (or fails). |
ConnectionRequest | This event fires anytime a connected client attempts a connection to the server. |
Disconnected | This event fires after a transfer is completed. |
EndTransfer | This event fires once a transfer is completed. |
Error | Information about errors during data delivery. |
Log | This event fires once for each log message. |
StartTransfer | This event fires immediately after a client initiates a file transfer. |
Transfer | 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. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
DefaultRollOverNumber | Whether to enable block roll over. |
CaptureIPPacketInfo | Used to capture the packet information. |
DelayHostResolution | Whether the hostname is resolved when RemoteHost is set. |
DestinationAddress | Used to get the destination address from the packet information. |
DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the control binds. |
MaxPacketSize | The maximum length of the packets that can be received. |
QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
ShareLocalPort | If set to True, allows more than one instance of the control to be active on the same local port. |
UseConnection | Determines whether to use a connected socket. |
UseIPv6 | Whether or not to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |
ConnCount Property (TFTPServer Control)
The number of records in the Conn arrays.
Syntax
tftpservercontrol.ConnCount
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Control)
This property contains a unique indentifier for this connection.
Syntax
tftpservercontrol.ConnConnectionId(ConnId)
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 Control)
This property is only available for sending data to a connected client.
Syntax
tftpservercontrol.ConnFileData(ConnId)[=string]
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.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .ConnFileDataB.
This property is not available at design time.
Data Type
Binary String
ConnFilename Property (TFTPServer Control)
This property represents the Filename of the file the client wants to upload or download.
Syntax
tftpservercontrol.ConnFilename(ConnId)
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 Control)
This is the local file on the server.
Syntax
tftpservercontrol.ConnLocalFile(ConnId)[=string]
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 Control)
This property represents the IP address of the connected client.
Syntax
tftpservercontrol.ConnRemoteHost(ConnId)
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 Control)
This property represents the port of the connected client.
Syntax
tftpservercontrol.ConnRemotePort(ConnId)
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 Control)
Transfers are done in octet mode 0 or netascii mode 1 .
Syntax
tftpservercontrol.ConnTransferMode(ConnId)
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 Control)
If set to True, the control accepts incoming connections on LocalPort.
Syntax
tftpservercontrol.Listening[=boolean]
Default Value
False
Remarks
This property indicates whether the control is listening for connections on the port specified by the LocalPort property.
Note: Use the StartListening and StopListening methods to control whether the control is listening.
This property is not available at design time.
Data Type
Boolean
LocalDir Property (TFTPServer Control)
The local file directory for the server.
Syntax
tftpservercontrol.LocalDir[=string]
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 Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
tftpservercontrol.LocalHost[=string]
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 control initiate connections (or accept in the case of server controls) only through that interface.
If the control 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 Control)
This is the port that the server will listen on.
Syntax
tftpservercontrol.LocalPort[=integer]
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 Control)
The number of times to retry sending a failed packet before disconnecting.
Syntax
tftpservercontrol.MaxRetransmits[=integer]
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 Control)
Maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
Syntax
tftpservercontrol.RetransmitTimeout[=integer]
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 Control)
A timeout for the control.
Syntax
tftpservercontrol.Timeout[=integer]
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 control will wait for the operation to complete before returning control.
The control 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 control 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 Control)
Sets or retrieves a configuration setting.
Syntax
tftpservercontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)
Processes events from the internal message queue.
Syntax
tftpservercontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
StartListening Method (TFTPServer Control)
This method starts listening for incoming connections.
Syntax
tftpservercontrol.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.
StopListening Method (TFTPServer Control)
This method stops listening for new connections.
Syntax
tftpservercontrol.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.
Connected Event (TFTPServer Control)
This event fires immediately after a connection completes (or fails).
Syntax
Sub tftpservercontrol_Connected(ConnectionId As Integer, StatusCode As Integer, Description As String)
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 Control)
This event fires anytime a connected client attempts a connection to the server.
Syntax
Sub tftpservercontrol_ConnectionRequest(RemoteHost As String, RemotePort As Integer, Filename As String, TransferMode As String, Operation As Integer, Accept As Boolean)
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 Control)
This event fires after a transfer is completed.
Syntax
Sub tftpservercontrol_Disconnected(ConnectionId As Integer, StatusCode As Integer, Description As String)
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 Control)
This event fires once a transfer is completed.
Syntax
Sub tftpservercontrol_EndTransfer(ConnectionId As Integer, Direction As Integer)
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 Control)
Information about errors during data delivery.
Syntax
Sub tftpservercontrol_Error(ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
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 Control)
This event fires once for each log message.
Syntax
Sub tftpservercontrol_Log(ConnectionId As Integer, LogLevel As Integer, Message As String, LogType As String)
Remarks
This event fires once for each log message generated by the control. The verbosity is controlled by the 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 Control)
This event fires immediately after a client initiates a file transfer.
Syntax
Sub tftpservercontrol_StartTransfer(ConnectionId As Integer, Direction As Integer)
Remarks
ConnectionId is the ConnectionId of the connected client. Direction represents the direction in which the transfer is going.
Transfer Event (TFTPServer Control)
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
Sub tftpservercontrol_Transfer(ConnectionId As Integer, Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)
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 Control)
The control 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 control, access to these internal properties is provided through the Config method.TFTPServer Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DefaultRollOverNumber: Whether to enable block roll over.This configuration 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 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 the control will resolve the hostname and the IP address will be present in the RemoteHost property.
If , 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 . |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 control 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 control initiate connections (or accept in the case of server controls) only through that interface. If the control 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 control binds.
This must be set before a connection is
attempted. It instructs the control 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 control 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 control to be active on the same local port.This option must be set before the control 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 control
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 control 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 Config 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 control 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 control 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
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 to mask sensitive data. The default is .
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the control whether or not to use the system security libraries or an internal implementation.
When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to tells the control to use the internal implementation instead of using the system security libraries. This setting is set to by default on all platforms. |
Trappable Errors (TFTPServer Control)
TFTPServer Errors
20123 Packet too large. | |
20124 Wrong response type from server. | |
20125 Server error. Description contains detailed information. | |
20126 Invalid server response. | |
20127 A valid LocalFile must be provided for PUT operations. | |
20128 Can't open local file. | |
20129 Can't write to local file. | |
20130 Can't read local file. | |
20131 Busy performing the current transfer. | |
20302 Timeout while waiting for server. | |
20306 Server error. | |
20307 Wrong or invalid response type received from server. | |
20308 Invalid response from server. |
The control may also return one of the following error codes, which are inherited from other controls.
UDP Errors
20105 UDP is already Active. | |
20107 You cannot change the LocalPort while the control is Active. | |
20108 You cannot change the LocalHost at this time. A connection is in progress. | |
20110 The control must be Active for this operation. | |
20113 Cannot change MaxPacketSize while the control is Active. | |
20114 Cannot change ShareLocalPort option while the control is Active. | |
20115 Cannot change RemoteHost when UseConnection is set and the control Active. | |
20116 Cannot change RemotePort when UseConnection is set and the control is Active. | |
20117 RemotePort can't be zero when UseConnection is set. Please specify a valid service port number. | |
20118 Cannot change UseConnection while the control is Active. | |
20119 Message can't be longer than MaxPacketSize. | |
20120 Message too short. | |
20435 Unable to convert string to selected CodePage |
SSL Errors
20271 Cannot load specified security library. | |
20272 Cannot open certificate store. | |
20273 Cannot find specified certificate. | |
20274 Cannot acquire security credentials. | |
20275 Cannot find certificate chain. | |
20276 Cannot verify certificate chain. | |
20277 Error during handshake. | |
20281 Error verifying certificate. | |
20282 Could not find client certificate. | |
20283 Could not find server certificate. | |
20284 Error encrypting data. | |
20285 Error decrypting data. |
TCP/IP Errors
25005 [10004] Interrupted system call. | |
25010 [10009] Bad file number. | |
25014 [10013] Access denied. | |
25015 [10014] Bad address. | |
25023 [10022] Invalid argument. | |
25025 [10024] Too many open files. | |
25036 [10035] Operation would block. | |
25037 [10036] Operation now in progress. | |
25038 [10037] Operation already in progress. | |
25039 [10038] Socket operation on non-socket. | |
25040 [10039] Destination address required. | |
25041 [10040] Message too long. | |
25042 [10041] Protocol wrong type for socket. | |
25043 [10042] Bad protocol option. | |
25044 [10043] Protocol not supported. | |
25045 [10044] Socket type not supported. | |
25046 [10045] Operation not supported on socket. | |
25047 [10046] Protocol family not supported. | |
25048 [10047] Address family not supported by protocol family. | |
25049 [10048] Address already in use. | |
25050 [10049] Can't assign requested address. | |
25051 [10050] Network is down. | |
25052 [10051] Network is unreachable. | |
25053 [10052] Net dropped connection or reset. | |
25054 [10053] Software caused connection abort. | |
25055 [10054] Connection reset by peer. | |
25056 [10055] No buffer space available. | |
25057 [10056] Socket is already connected. | |
25058 [10057] Socket is not connected. | |
25059 [10058] Can't send after socket shutdown. | |
25060 [10059] Too many references, can't splice. | |
25061 [10060] Connection timed out. | |
25062 [10061] Connection refused. | |
25063 [10062] Too many levels of symbolic links. | |
25064 [10063] File name too long. | |
25065 [10064] Host is down. | |
25066 [10065] No route to host. | |
25067 [10066] Directory not empty | |
25068 [10067] Too many processes. | |
25069 [10068] Too many users. | |
25070 [10069] Disc Quota Exceeded. | |
25071 [10070] Stale NFS file handle. | |
25072 [10071] Too many levels of remote in path. | |
25092 [10091] Network subsystem is unavailable. | |
25093 [10092] WINSOCK DLL Version out of range. | |
25094 [10093] Winsock not loaded yet. | |
26002 [11001] Host not found. | |
26003 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
26004 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
26005 [11004] Valid name, no data record (check DNS setup). |