TFTPServer Class

Properties   Methods   Events   Configuration Settings   Errors  

TBD.

Class Name

IPWorks_TFTPServer

Procedural Interface

 ipworks_tftpserver_open();
 ipworks_tftpserver_close($res);
 ipworks_tftpserver_register_callback($res, $id, $function);
 ipworks_tftpserver_get_last_error($res);
 ipworks_tftpserver_get_last_error_code($res);
 ipworks_tftpserver_set($res, $id, $index, $value);
 ipworks_tftpserver_get($res, $id, $index);
 ipworks_tftpserver_do_config($res, $configurationstring);

 ipworks_tftpserver_do_doevents($res);

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.

AcceptData	Enables or disables data reception (the DataIn event).
Active	Enables or disables sending and receiving of data.
ConnCount	The number of records in the Conn arrays.
ConnConnId	TBD.
ConnLocalFile	TBD.
ConnRemoteFile	TBD.
ConnRemoteHost	TBD.
ConnRemotePort	TBD.
ConnTransferMode	TBD.
DefaultFileDir	The default local file directory for connecting clients.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	TBD.
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 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	Processes 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.

Connected	TBD.
ConnectionRequest	TBD.
Disconnected	TBD.
EndTransfer	TBD.
Error	Information about errors during data delivery.
Log	Fires once for each log message.
StartTransfer	TBD.
Transfer	TBD.

Configuration Settings

---

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

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.
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	Tells the class whether or not to use the system security libraries or an internal implementation.

AcceptData Property (IPWorks_TFTPServer Class)

Enables or disables data reception (the DataIn event).

Object Oriented Interface

public function getAcceptData();


public function setAcceptData($value);

Procedural Interface

ipworks_tftpserver_get($res, 1 );


ipworks_tftpserver_set($res, 1, $value );

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.

Data Type

Boolean

Active Property (IPWorks_TFTPServer Class)

Enables or disables sending and receiving of data.

Object Oriented Interface

public function getActive();


public function setActive($value);

Procedural Interface

ipworks_tftpserver_get($res, 2 );


ipworks_tftpserver_set($res, 2, $value );

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.

Data Type

Boolean

ConnCount Property (IPWorks_TFTPServer Class)

The number of records in the Conn arrays.

Object Oriented Interface

public function getConnCount();

Procedural Interface

ipworks_tftpserver_get($res, 3 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ConnConnId
• ConnLocalFile
• ConnRemoteFile
• ConnRemoteHost
• ConnRemotePort
• ConnTransferMode

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

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

Data Type

Integer

ConnConnId Property (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function getConnConnId($connid);

Procedural Interface

ipworks_tftpserver_get($res, 4 , $connid);

Default Value

''

Remarks

TBD

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

TBD.

Object Oriented Interface

public function getConnLocalFile($connid);


public function setConnLocalFile($connid, $value);

Procedural Interface

ipworks_tftpserver_get($res, 6 , $connid);


ipworks_tftpserver_set($res, 6, $value , $connid);

Default Value

''

Remarks

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

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

ConnRemoteFile Property (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function getConnRemoteFile($connid);

Procedural Interface

ipworks_tftpserver_get($res, 7 , $connid);

Default Value

''

Remarks

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

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

ConnRemoteHost Property (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function getConnRemoteHost($connid);

Procedural Interface

ipworks_tftpserver_get($res, 8 , $connid);

Default Value

''

Remarks

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

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

TBD.

Object Oriented Interface

public function getConnRemotePort($connid);

Procedural Interface

ipworks_tftpserver_get($res, 9 , $connid);

Default Value

0

Remarks

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

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

TBD.

Object Oriented Interface

public function getConnTransferMode($connid);

Procedural Interface

ipworks_tftpserver_get($res, 10 , $connid);

Default Value

''

Remarks

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

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

DefaultFileDir Property (IPWorks_TFTPServer Class)

The default local file directory for connecting clients.

Object Oriented Interface

public function getDefaultFileDir();


public function setDefaultFileDir($value);

Procedural Interface

ipworks_tftpserver_get($res, 12 );


ipworks_tftpserver_set($res, 12, $value );

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.

Data Type

String

LocalHost Property (IPWorks_TFTPServer Class)

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_tftpserver_get($res, 13 );


ipworks_tftpserver_set($res, 13, $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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworks_tftpserver_get($res, 14 );


ipworks_tftpserver_set($res, 14, $value );

Default Value

69

Remarks

TBD.

Data Type

Integer

MaxRetransmits Property (IPWorks_TFTPServer Class)

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_tftpserver_get($res, 15 );


ipworks_tftpserver_set($res, 15, $value );

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

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_tftpserver_get($res, 16 );


ipworks_tftpserver_set($res, 16, $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

Timeout Property (IPWorks_TFTPServer Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworks_tftpserver_get($res, 17 );


ipworks_tftpserver_set($res, 17, $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.

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Connected Event (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

TBD.

ConnectionRequest Event (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'remotehost'
 'remoteport'
 'filename'
 'transfermode'
 'isread'
 'accept'

Remarks

TBD.

Disconnected Event (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

TBD.

EndTransfer Event (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'connectionid'
 'direction'

Remarks

TBD.

Error Event (IPWorks_TFTPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 5, 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.

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

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 '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 (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 7, array($this, 'fireStartTransfer'));

Parameter List

 'connectionid'
 'direction'

Remarks

TBD.

Transfer Event (IPWorks_TFTPServer Class)

TBD.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_tftpserver_register_callback($res, 8, array($this, 'fireTransfer'));

Parameter List

 'connectionid'
 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

TBD.

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.

SourceIPAddress:   Used to set the source IP address used when sending a packet. This configuration setting can be used to override the source IP address when sending a packet. Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

SourceMacAddress:   Used to set the source MAC address used when sending a packet. This configuration setting can be used to override the source MAC address when sending a packet. Note: This setting is only available in Windows and requires that the winpcap library be installed (or npcap with winpcap compatibility).

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.

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

LicenseInfo:   Information about the current license. When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: Product: The product the license is for. Product Key: The key the license was generated from. License Source: Where the license was found (e.g., RuntimeLicense, License File). License Type: The type of license installed (e.g., Royalty Free, Single Server).

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

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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.

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

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