TFTPClient Class
Properties Methods Events Config Settings Errors
The TFTPClient class is used to exchange files with TFTP servers via the TFTP protocol defined in RFC 783.
Class Name
IPWorks_TFTPClient
Procedural Interface
ipworks_tftpclient_open(); ipworks_tftpclient_close($res); ipworks_tftpclient_register_callback($res, $id, $function); ipworks_tftpclient_get_last_error($res); ipworks_tftpclient_get_last_error_code($res); ipworks_tftpclient_set($res, $id, $index, $value); ipworks_tftpclient_get($res, $id, $index); ipworks_tftpclient_do_config($res, $configurationstring); ipworks_tftpclient_do_doevents($res); ipworks_tftpclient_do_getfile($res); ipworks_tftpclient_do_interrupt($res); ipworks_tftpclient_do_putfile($res); ipworks_tftpclient_do_reset($res);
Remarks
To use the class, first specify the TFTPServer, then a LocalFile and a RemoteFile, and then call GetFile or PutFile. The Transfer event shows the progress of the transfer.
Potential transmission errors and packet loss are managed by the Timeout property, which controls the maximum time to wait for a response from the server, and the MaxRetransmits property, which specifies how many times to resend a failed packet before giving up.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Idle | This property specifies the current status of the class. |
LocalFile | This property includes a file on the local host to transfer the data to or from. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxRetransmits | This property specifies the number of times to retry sending a failed packet before disconnecting. |
RemoteFile | This property includes the file on the remote host. |
RetransmitTimeout | This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet. |
TFTPPort | This property specifies the User Datagram Protocol (UDP) port where the remote TFTP server is listening. |
TFTPServer | This property includes the address of the TFTP server to exchange files with. |
Timeout | This property includes the 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.
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
GetFile | This method downloads a RemoteFile from the TFTP server. |
Interrupt | This method interrupts the current method. |
PutFile | This method uploads a file specified by LocalFile to the TFTP server. |
Reset | This method resets the class. |
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.
EndTransfer | This event is fired when a file finishes downloading or uploading. |
Error | Fired when information is available about errors during data delivery. |
StartTransfer | This event fires when a file starts downloading or uploading. |
Transfer | This event is fired during the file download or upload. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
BlockSize | Determines the block size that will be used when transferring a file. |
TransferMode | Determines the transfer mode that will be used when transferring a file. |
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 class 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 class to be active on the same local port. |
SourceIPAddress | Used to set the source IP address used when sending a packet. |
SourceMacAddress | Used to set the source MAC address used when sending a packet. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Idle Property (IPWorks_TFTPClient Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
ipworks_tftpclient_get($res, 1 );
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalFile Property (IPWorks_TFTPClient Class)
This property includes a file on the local host to transfer the data to or from.
Object Oriented Interface
public function getLocalFile(); public function setLocalFile($value);
Procedural Interface
ipworks_tftpclient_get($res, 2 ); ipworks_tftpclient_set($res, 2, $value );
Default Value
''
Remarks
If GetFile is called, and LocalFile already exists, it is overwritten. If PutFile is called, LocalFile must point to a valid file or an error will be returned.
Data Type
String
LocalHost Property (IPWorks_TFTPClient Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworks_tftpclient_get($res, 3 ); ipworks_tftpclient_set($res, 3, $value );
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MaxRetransmits Property (IPWorks_TFTPClient Class)
This property specifies the number of times to retry sending a failed packet before disconnecting.
Object Oriented Interface
public function getMaxRetransmits(); public function setMaxRetransmits($value);
Procedural Interface
ipworks_tftpclient_get($res, 4 ); ipworks_tftpclient_set($res, 4, $value );
Default Value
3
Remarks
This property allows you to specify the number of times that you would like to try resending the last data packet if the original packet fails.
The RetransmitTimeout determines the wait time (in seconds) between successive retransmissions.
The default value for the MaxRetransmits property is 3.
Data Type
Integer
RemoteFile Property (IPWorks_TFTPClient Class)
This property includes the file on the remote host.
Object Oriented Interface
public function getRemoteFile(); public function setRemoteFile($value);
Procedural Interface
ipworks_tftpclient_get($res, 5 ); ipworks_tftpclient_set($res, 5, $value );
Default Value
''
Remarks
When the GetFile is called, this must be a valid file on the TFTPServer.
Data Type
String
RetransmitTimeout Property (IPWorks_TFTPClient Class)
This property includes the maximum time in seconds to wait for a reply packet from the server before retransmitting the last packet.
Object Oriented Interface
public function getRetransmitTimeout(); public function setRetransmitTimeout($value);
Procedural Interface
ipworks_tftpclient_get($res, 6 ); ipworks_tftpclient_set($res, 6, $value );
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
TFTPPort Property (IPWorks_TFTPClient Class)
This property specifies the User Datagram Protocol (UDP) port where the remote TFTP server is listening.
Object Oriented Interface
public function getTFTPPort(); public function setTFTPPort($value);
Procedural Interface
ipworks_tftpclient_get($res, 7 ); ipworks_tftpclient_set($res, 7, $value );
Default Value
69
Remarks
The TFTPPort is the UDP port on the TFTPServer to send TFTP requests to.
This property is not available at design time.
Data Type
Integer
TFTPServer Property (IPWorks_TFTPClient Class)
This property includes the address of the TFTP server to exchange files with.
Object Oriented Interface
public function getTFTPServer(); public function setTFTPServer($value);
Procedural Interface
ipworks_tftpclient_get($res, 8 ); ipworks_tftpclient_set($res, 8, $value );
Default Value
''
Remarks
To be able to transfer file via TFTP, the remote host must be running TFTP services on port TFTPPort (default 69).
Example. Get a File:
TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.GetFile()
Data Type
String
Timeout Property (IPWorks_TFTPClient Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworks_tftpclient_get($res, 9 ); ipworks_tftpclient_set($res, 9, $value );
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.
Note: By default, all timeouts are inactivity timeouts, that is, 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 (IPWorks_TFTPClient Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworks_tftpclient_do_config($res, $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 (IPWorks_TFTPClient Class)
This method processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
ipworks_tftpclient_do_doevents($res);
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.
GetFile Method (IPWorks_TFTPClient Class)
This method downloads a RemoteFile from the TFTP server.
Object Oriented Interface
public function doGetFile();
Procedural Interface
ipworks_tftpclient_do_getfile($res);
Remarks
The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string).
Example. Get a File:
TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.GetFile()
Interrupt Method (IPWorks_TFTPClient Class)
This method interrupts the current method.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
ipworks_tftpclient_do_interrupt($res);
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
PutFile Method (IPWorks_TFTPClient Class)
This method uploads a file specified by LocalFile to the TFTP server.
Object Oriented Interface
public function doPutFile();
Procedural Interface
ipworks_tftpclient_do_putfile($res);
Remarks
The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile.
Example. Put a File:
TFTPControl.TFTPServer = "MyServer"
TFTPControl.LocalFile = "C:\filename.txt"
TFTPControl.RemoteFile = "/remotefile.txt"
TFTPControl.PutFile()
Reset Method (IPWorks_TFTPClient Class)
This method resets the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworks_tftpclient_do_reset($res);
Remarks
This method will reset the class's properties to their default values.
EndTransfer Event (IPWorks_TFTPClient Class)
This event is fired when a file finishes downloading or uploading.
Object Oriented Interface
public function fireEndTransfer($param);
Procedural Interface
ipworks_tftpclient_register_callback($res, 1, array($this, 'fireEndTransfer'));
Parameter List
'direction'
Remarks
The EndTransfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (IPWorks_TFTPClient Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworks_tftpclient_register_callback($res, 2, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
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.
StartTransfer Event (IPWorks_TFTPClient Class)
This event fires when a file starts downloading or uploading.
Object Oriented Interface
public function fireStartTransfer($param);
Procedural Interface
ipworks_tftpclient_register_callback($res, 3, array($this, 'fireStartTransfer'));
Parameter List
'direction'
Remarks
The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (IPWorks_TFTPClient Class)
This event is fired during the file download or upload.
Object Oriented Interface
public function fireTransfer($param);
Procedural Interface
ipworks_tftpclient_register_callback($res, 4, array($this, 'fireTransfer'));
Parameter List
'direction'
'bytestransferred'
'percentdone'
'text'
Remarks
One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.
Text contains the portion of the file data being delivered.
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 (TFTPClient 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.TFTPClient Config Settings
Value | Description |
0 (default) | Binary (Octet) |
1 | Ascii (Netascii) |
UDP Config Settings
The default value for this setting is False.
Note: This configuration setting is available only in Windows.
The default value is false.
Note: This configuration setting is available only in Windows.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server 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 multihomed hosts (machines with more than one IP interface).
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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
Note: This configuration setting uses the qWAVE API and is available only on Windows 7, Windows Server 2008 R2, and later.
Note: This configuration setting uses the qWAVE API and is available only on Windows Vista and Windows Server 2008 or above.
Note: QOSTrafficType must be set before setting Active to True.
The default value for this setting is False.
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
Note: This configuration setting is available only in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).
The default value for this setting is False.
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (TFTPClient Class)
TFTPClient Errors
122 | Packet too large. |
123 | Wrong response type from server. |
124 | Server error. Description contains detailed information. |
125 | Invalid server response. |
126 | A valid LocalFile must be provided for PUT operations. |
127 | Cannot open local file. |
128 | Cannot write to local file. |
129 | Cannot read local file. |
130 | Busy performing the current transfer. |
301 | Timeout while waiting for server. |
305 | Server error. |
306 | Wrong or invalid response type received from server. |
307 | Invalid response from server. |
The class may also return one of the following error codes, which are inherited from other classes.
UDP Errors
104 | UDP is already Active. |
106 | You cannot change the LocalPort 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 | You cannot change MaxPacketSize while the class is Active. |
113 | You cannot change ShareLocalPort option while the class is Active. |
114 | You cannot change RemoteHost when UseConnection is set and the class Active. |
115 | You cannot change RemotePort when UseConnection is set and the class is Active. |
116 | RemotePort cannot be zero when UseConnection is set. Please specify a valid service port number. |
117 | You cannot change UseConnection while the class is Active. |
118 | Message cannot 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |