TraceRoute Class

Properties Methods Events Config Settings Errors

The TraceRoute class allows you to trace the path that the IP packets take on the Internet.

Syntax

class ipworks.TraceRoute

Remarks

The component implements a standard IP TraceRoute as defined in RFC 1393.

To use the class, simply call the trace_to method and set the Host parameter to the domain name or IP address of the host you want to trace the path to. This is identical to setting the remote_host property to the domain name or IP address. The class will start sending probe packets toward the host, and as it receives replies, it will fire on_hop events giving information about the route. The same information is also provided in the hops properties.

The resolve_names property enables or disables DNS resolution of IP addresses received during the trace. If set to False, only IP addresses are provided. If set to True, the class will attempt to resolve the names of the hosts in the route. This may considerably increase the time it takes to complete the trace.

The hop_timeout property determines the maximum waiting time for a response in each hop of the trace, while the timeout property defines the maximum waiting time for the whole trace. The hop_limit property specifies the maximum number of hops allowed for a trace.

Property List

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


hop_limit	This property includes the maximum number of hops to allow for a trace.
hop_count	The number of records in the Hop arrays.
hop_error_code	This property contains the error code for a particular hop in the trace.
hop_error_description	This property contains the error description for a particular hop in the trace.
hop_host_address	This property contains the IP address of the host for a particular hop in the trace.
hop_host_name	This property contains the name of the host for a particular hop in the trace.
hop_time	This property contains the amount of time taken by a particular hop in the trace.
hop_timeout	This property includes the maximum amount of time to wait for an individual hop to complete.
idle	The current status of the class.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
remote_host	This property includes the address of a host to trace to.
resolve_names	This property determines whether the class resolves the host name for each host during the trace.
timeout	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.
do_events	This method processes events from the internal message queue.
interrupt	This method interrupts the current method.
reset	This method will reset the class.
resolve_remote_host	This method resolves the hostname in RemoteHost to an IP address.
trace_to	This method traces the route to a host.

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.


on_error	Fired when information is available about errors during data delivery.
on_hop	This event is fired for each hop in the trace to the RemoteHost .
on_hop_resolved	This event is fired when the name of a hop address is found.

Config Settings

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


DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
HopTimeoutInMilliseconds	The hop timeout is treated as milliseconds.
TimeoutInMilliseconds	The timeout is treated as milliseconds.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DontFragment	Whether the DontFragment control flag is set.
IcmpDllTimeout	The timeout for the class when using the icmp.dll.
MaxMessageSize	The maximum length of the messages that can be received.
MulticastTTL	The time to live (TTL) value for multicast ICMP packets sent by the class.
ReceiveAllMode	Enables a socket to receive all IPv4 or IPv6 packets on the network.
TimeoutInMilliseconds	The timeout is treated as milliseconds.
UseConnection	Determines whether to use a connected socket.
UseICMPDLL	Use the icmp.dll included on Windows Systems.
UseIPHLPDLL	Use the iphlpapi.dll included on Windows Systems.
UseIPv6	Whether 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.

hop_limit Property

This property includes the maximum number of hops to allow for a trace.

Syntax

def get_hop_limit() -> int: ...
def set_hop_limit(value: int) -> None: ...

hop_limit = property(get_hop_limit, set_hop_limit)

Default Value

Remarks

This property is used to limit lengthy traces. A value of 0 indicates an unbounded trace.

Note: If the value of timeout is 0, an unbounded trace may cause a call to trace_to to block indefinitely. To cancel such a route trace, call interrupt.

hop_count Property

The number of records in the Hop arrays.

Syntax

def get_hop_count() -> int: ...

hop_count = property(get_hop_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

hop_error_code
hop_error_description
hop_host_address
hop_host_name
hop_time

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

This property is read-only.

hop_error_code Property

This property contains the error code for a particular hop in the trace.

Syntax

def get_hop_error_code(hop_index: int) -> int: ...

Default Value

Remarks

This property contains the error code for a particular hop in the trace.

For a list of valid error codes and their descriptions, please refer to the Error Messages section.

The hop_index parameter specifies the index of the item in the array. The size of the array is controlled by the hop_count property.

This property is read-only.

hop_error_description Property

This property contains the error description for a particular hop in the trace.

Syntax

def get_hop_error_description(hop_index: int) -> str: ...

Default Value

Remarks

This property contains the error description for a particular hop in the trace.

For a list of valid error codes and their descriptions, please refer to the Error Messages section.

The hop_index parameter specifies the index of the item in the array. The size of the array is controlled by the hop_count property.

This property is read-only.

hop_host_address Property

This property contains the IP address of the host for a particular hop in the trace.

Syntax

def get_hop_host_address(hop_index: int) -> str: ...

Default Value

Remarks

This property contains the IP address of the host for a particular hop in the trace.

The hop_index parameter specifies the index of the item in the array. The size of the array is controlled by the hop_count property.

This property is read-only.

hop_host_name Property

This property contains the name of the host for a particular hop in the trace.

Syntax

def get_hop_host_name(hop_index: int) -> str: ...

Default Value

Remarks

This property contains the name of the host for a particular hop in the trace.

If resolve_names is False, this property contains the IP address of the host instead.

The hop_index parameter specifies the index of the item in the array. The size of the array is controlled by the hop_count property.

This property is read-only.

hop_time Property

This property contains the amount of time taken by a particular hop in the trace.

Syntax

def get_hop_time(hop_index: int) -> int: ...

Default Value

Remarks

This property contains the amount of time taken by a particular hop in the trace.

If a given hop times out, this value will be set to -1.

The hop_index parameter specifies the index of the item in the array. The size of the array is controlled by the hop_count property.

This property is read-only.

hop_timeout Property

This property includes the maximum amount of time to wait for an individual hop to complete.

Syntax

def get_hop_timeout() -> int: ...
def set_hop_timeout(value: int) -> None: ...

hop_timeout = property(get_hop_timeout, set_hop_timeout)

Default Value

Remarks

The time value is in seconds. If 0, hop_timeout will be ignored, and only the timeout for the whole trace will be taken into account.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

Remarks

This 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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

remote_host Property

This property includes the address of a host to trace to.

Syntax

def get_remote_host() -> str: ...
def set_remote_host(value: str) -> None: ...

remote_host = property(get_remote_host, set_remote_host)

Default Value

Remarks

Traces are initiated by setting remote_host to the name or address of the host to trace to.

This property must contain a valid Internet domain name or address or an error will be returned.

To interrupt a trace in progress, set remote_host to empty string.

Example. Perform a TraceRoute:

TraceRouteControl.TraceTo("myHost") is equivalent to TraceRouteControl.RemoteHost = "myHost"

resolve_names Property

This property determines whether the class resolves the host name for each host during the trace.

Syntax

def get_resolve_names() -> bool: ...
def set_resolve_names(value: bool) -> None: ...

resolve_names = property(get_resolve_names, set_resolve_names)

Default Value

FALSE

Remarks

This property determines whether the class resolves the name of host at each "hop" during the trace. The default value is False.

Note: If this property is set to True, the trace takes longer because of name resolution.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

resolve_remote_host Method

This method resolves the hostname in RemoteHost to an IP address.

Syntax

def resolve_remote_host() -> None: ...

Remarks

This method resolves the hostname specified by remote_host to an IP address. The resolved value is available in the remote_host property after this method returns.

In most cases, calling this method is not necessary; the class will resolve the hostname automatically when needed. If DelayHostResolution is True, this method may be called to manually resolve remote_host, if desired.

trace_to Method

This method traces the route to a host.

Syntax

def trace_to(host: str) -> None: ...

Remarks

Traces are initiated by calling TraceTo, with the Host argument set to the name or address of the destination host to trace to. Host must contain a valid Internet domain name or address, or the class fails with an error. To interrupt a trace in progress, set RemoteHost to empty string. Calling this method is equivalent to setting the remote_host property to Host.

Example. Perform a TraceRoute:

TraceRouteControl.TraceTo("myHost") is equivalent to TraceRouteControl.RemoteHost = "myHost"

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class TraceRouteErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class TraceRoute:
@property
def on_error() -> Callable[[TraceRouteErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[TraceRouteErrorEventParams], None]) -> None: ...

Remarks

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

on_hop Event

This event is fired for each hop in the trace to the RemoteHost .

Syntax

class TraceRouteHopEventParams(object):
  @property
  def hop_number() -> int: ...

  @property
  def host_address() -> str: ...

  @property
  def duration() -> int: ...

# In class TraceRoute:
@property
def on_hop() -> Callable[[TraceRouteHopEventParams], None]: ...
@on_hop.setter
def on_hop(event_hook: Callable[[TraceRouteHopEventParams], None]) -> None: ...

Remarks

This event provides access to the information for each hop in the trace. The HopNumber parameter denotes which hop the trace is at. The HostAddress parameter is the IP address of the host for the hop identified by HopNumber. The Duration parameter shows the amount of time taken by the hop.

on_hop_resolved Event

This event is fired when the name of a hop address is found.

Syntax

class TraceRouteHopResolvedEventParams(object):
  @property
  def hop_number() -> int: ...

  @property
  def status_code() -> int: ...

  @property
  def hop_host_name() -> str: ...

# In class TraceRoute:
@property
def on_hop_resolved() -> Callable[[TraceRouteHopResolvedEventParams], None]: ...
@on_hop_resolved.setter
def on_hop_resolved(event_hook: Callable[[TraceRouteHopResolvedEventParams], None]) -> None: ...

Remarks

The StatusCode contains 0 if the address is resolved successfully, or an error code, in which case, HopHostName contains a textual description of the error.

Host name resolution is disabled by default. Set resolve_names to True to enable it.

TraceRoute Config Settings

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.

TraceRoute Config Settings

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

This configuration setting specifies whether a hostname is resolved immediately when remote_host is set. If True the class will resolve the hostname and the IP address will be present in the remote_host 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, resolve_remote_host may be called to manually resolve the value in remote_host at any time.

The default value is False.

HopTimeoutInMilliseconds: The hop timeout is treated as milliseconds.

Setting HopTimeoutInMilliseconds to True causes the class to use the value in the hop_timeout property as milliseconds instead of seconds, which is the default.

TimeoutInMilliseconds: The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to True causes the class to use the value in the timeout property as milliseconds instead of seconds, which is the default.

ICMP Config Settings

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

The default value is False.

DontFragment: Whether the DontFragment control flag is set.

When set to True, the DontFragment control flag in the IP header will be set.

The default value is False.

IcmpDllTimeout: The timeout for the class when using the icmp.dll.

The class will wait for the operation to complete before returning control. If IcmpDllTimeout expires, and the operation is not yet complete, the class fails with an error. IcmpDllTimeout must be set to a positive value.

The default value for IcmpDllTimeout is 60 seconds.

Note: This configuration setting is valid only when UseICMPDLL is set to True.

MaxMessageSize: The maximum length of the messages that can be received.

This setting specifies the maximum size of the datagrams that the class will accept without truncation.

MulticastTTL: The time to live (TTL) value for multicast ICMP packets sent by the component.

When sending multicast packets, the setting specifies the time-to-live (TTL) field. The TTL field of the ICMP packet is a counter limiting the lifetime of a packet.

Each router (or other module) that handles a packet decrements the TTL field by one or more if it holds the packet for more than one second. Thus, the TTL is effectively a hop count limit on how far a datagram can propagate through the internet. When the TTL is reduced to zero (or less), the packet is discarded.

By default, the default TTL value of the underlying Transmission Control Protocol (TCP)/IP subsystem will be used.

ReceiveAllMode: Enables a socket to receive all IPv4 or IPv6 packets on the network.

This setting specifies the ReceiveAll mode for the socket. The following modes are available:


Value	Description
-1 (default)	The socket option is left unspecified.
0	Do not receive all network traffic.
1	Receive all network traffic. This enables the promiscuous mode on the network interface card (NIC). On a LAN segment with a network hub, a NIC that supports the promiscuous mode will capture all IPv4 or IPv6 traffic on the LAN, including traffic between other computers on the same LAN segment.
2	Receive only socket-level network traffic (this feature may not be implemented by your Windows installation).
3	Receive only IP-level network traffic. This option does not enable the promiscuous mode on the NIC. This option affects packet processing only at the IP level. The NIC still receives only those packets directed to its configured unicast and multicast addresses. A socket with this option enabled, however, not only will receive packets directed to specific IP addresses, but also will receive all the IPv4 or IPv6 packets the NIC receives.

TimeoutInMilliseconds: The timeout is treated as milliseconds.

Setting TimeoutInMilliseconds to True causes the class to use the value in the IcmpDllTimeout configuration setting as milliseconds instead of seconds, which is the default.

Note: This setting is valid only when UseICMPDLL is set to True.

UseConnection: Determines whether to use a connected socket.

UseConnection specifies whether or not the class should use a connected socket. 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 Transmission Control Protocol (TCP) sense. It means only that the class will send and receive data to and from the specified destination.

The default value for this setting is False.

UseICMPDLL: Use the icmp.dll included on Windows Systems.

Setting UseICMPDLL to True causes the class to use the icmp.dll on Windows 9x or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

UseIPHLPDLL: Use the iphlpapi.dll included on Windows Systems.

Setting UseIPHLPDLL to True causes the class to use the iphlpapi.dll on Windows XP or on later machines. This sometimes enables access to raw sockets when permissions for standard operations are prohibited.

Note: If both this and UseICMPDLL are enabled, the iphlpapi.dll will take precedence.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

Socket Config Settings

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

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

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

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

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).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: 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 True to mask sensitive data. The default is True.

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.

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 do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

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.

TraceRoute Errors

131	Request queue is full.
132	Message for unknown request.
134	Invalid address string.
159	Invalid hop index (out of range).
301	Timeout.
17302	Hop timed out.
17312	Busy performing current trace.

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

ICMP Errors

104	The class is already active.
107	Cannot change the LocalHost at this time. A connection is in progress.
109	The class must be active for this operation.
112	Cannot change MaxMessageSize while ICMP is active.
114	Cannot change remote_host when UseConnection is set and the class is active.
117	Cannot change UseConnection while the class is active.
118	The message cannot be longer than MaxMessageSize.
119	The message is too short.
120	Cannot create ICMP handle.

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