TraceRoute Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TraceRoute

Remarks

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

To use the class, simply call the TraceTo 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 RemoteHost property to the domain name or IP address. The class will start sending probe packets towards the host, and as it receives replies it will fire Hop events giving information about the route. The same information is also provided in the Hops properties.

The ResolveNames 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 HopTimeout 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 HopLimit 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.

HopLimitThe maximum number of hops to allow for a trace.
HopCountThe number of records in the Hop arrays.
HopErrorCodeThe error code for particular hop in the trace.
HopErrorDescriptionThe error description for particular hop in the trace.
HopHostAddressThe IP address of the host for a particular hop in the trace.
HopHostNameThe name of the host for a particular hop in the trace.
HopTimeThe amount of time taken by a particular hop in the trace.
HopTimeoutMaximum amount of time to wait for an individual hop to complete.
IdleThe current status of the class.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
RemoteHostThe address of a host to trace to.
ResolveNamesDetermines whether the class resolves the host name for each host during the trace.
TimeoutA timeout for the class.

Method List


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

ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
InterruptInterrupt the current method.
ResetReset the class.
ResolveRemoteHostResolves the hostname in RemoteHost to an IP address.
TraceToTrace 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.

ErrorInformation about errors during data delivery.
HopFired for each hop in the trace to the RemoteHost .
HopResolvedFired 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.

DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
HopTimeoutInMillisecondsThe hop timeout is treated as milliseconds.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
DelayHostResolutionWhether the hostname is resolved when RemoteHost is set.
DontFragmentWhether the DontFragment control flag is set.
IcmpDllTimeoutThe timeout for the class when using the icmp.dll.
MaxMessageSizeThe maximum length of the messages that can be received.
MulticastTTLThe time to live (TTL) value for multicast ICMP packets sent by the class.
ReceiveAllModeEnables a socket to receive all IPv4 or IPv6 packets on the network.
TimeoutInMillisecondsThe timeout is treated as milliseconds.
UseConnectionDetermines whether to use a connected socket.
UseICMPDLLUse the icmp.dll included on Windows Systems.
UseIPHLPDLLUse the iphlpapi.dll included on Windows Systems.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

HopLimit Property (TraceRoute Class)

The maximum number of hops to allow for a trace.

Syntax

ANSI (Cross Platform)
int GetHopLimit();
int SetHopLimit(int iHopLimit); Unicode (Windows) INT GetHopLimit();
INT SetHopLimit(INT iHopLimit);
int ipworks_traceroute_gethoplimit(void* lpObj);
int ipworks_traceroute_sethoplimit(void* lpObj, int iHopLimit);
int GetHopLimit();
int SetHopLimit(int iHopLimit);

Default Value

64

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 TraceTo to block indefinitely. To cancel such a route trace, call Interrupt.

Data Type

Integer

HopCount Property (TraceRoute Class)

The number of records in the Hop arrays.

Syntax

ANSI (Cross Platform)
int GetHopCount();

Unicode (Windows)
INT GetHopCount();
int ipworks_traceroute_gethopcount(void* lpObj);
int GetHopCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

HopErrorCode Property (TraceRoute Class)

The error code for particular hop in the trace.

Syntax

ANSI (Cross Platform)
int GetHopErrorCode(int iHopIndex);

Unicode (Windows)
INT GetHopErrorCode(INT iHopIndex);
int ipworks_traceroute_gethoperrorcode(void* lpObj, int hopindex);
int GetHopErrorCode(int iHopIndex);

Default Value

0

Remarks

The error code for particular hop in the trace.

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

The HopIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.

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

Data Type

Integer

HopErrorDescription Property (TraceRoute Class)

The error description for particular hop in the trace.

Syntax

ANSI (Cross Platform)
char* GetHopErrorDescription(int iHopIndex);

Unicode (Windows)
LPWSTR GetHopErrorDescription(INT iHopIndex);
char* ipworks_traceroute_gethoperrordescription(void* lpObj, int hopindex);
QString GetHopErrorDescription(int iHopIndex);

Default Value

""

Remarks

The error description for particular hop in the trace.

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

The HopIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.

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

Data Type

String

HopHostAddress Property (TraceRoute Class)

The IP address of the host for a particular hop in the trace.

Syntax

ANSI (Cross Platform)
char* GetHopHostAddress(int iHopIndex);

Unicode (Windows)
LPWSTR GetHopHostAddress(INT iHopIndex);
char* ipworks_traceroute_gethophostaddress(void* lpObj, int hopindex);
QString GetHopHostAddress(int iHopIndex);

Default Value

""

Remarks

The IP address of the host for a particular hop in the trace.

The HopIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.

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

Data Type

String

HopHostName Property (TraceRoute Class)

The name of the host for a particular hop in the trace.

Syntax

ANSI (Cross Platform)
char* GetHopHostName(int iHopIndex);

Unicode (Windows)
LPWSTR GetHopHostName(INT iHopIndex);
char* ipworks_traceroute_gethophostname(void* lpObj, int hopindex);
QString GetHopHostName(int iHopIndex);

Default Value

""

Remarks

The name of the host for a particular hop in the trace.

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

The HopIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.

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

Data Type

String

HopTime Property (TraceRoute Class)

The amount of time taken by a particular hop in the trace.

Syntax

ANSI (Cross Platform)
int GetHopTime(int iHopIndex);

Unicode (Windows)
INT GetHopTime(INT iHopIndex);
int ipworks_traceroute_gethoptime(void* lpObj, int hopindex);
int GetHopTime(int iHopIndex);

Default Value

0

Remarks

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 HopIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HopCount property.

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

Data Type

Integer

HopTimeout Property (TraceRoute Class)

Maximum amount of time to wait for an individual hop to complete.

Syntax

ANSI (Cross Platform)
int GetHopTimeout();
int SetHopTimeout(int iHopTimeout); Unicode (Windows) INT GetHopTimeout();
INT SetHopTimeout(INT iHopTimeout);
int ipworks_traceroute_gethoptimeout(void* lpObj);
int ipworks_traceroute_sethoptimeout(void* lpObj, int iHopTimeout);
int GetHopTimeout();
int SetHopTimeout(int iHopTimeout);

Default Value

10

Remarks

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

Data Type

Integer

Idle Property (TraceRoute Class)

The current status of the class.

Syntax

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();
int ipworks_traceroute_getidle(void* lpObj);
bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (TraceRoute Class)

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

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworks_traceroute_getlocalhost(void* lpObj);
int ipworks_traceroute_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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

RemoteHost Property (TraceRoute Class)

The address of a host to trace to.

Syntax

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost); Unicode (Windows) LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);
char* ipworks_traceroute_getremotehost(void* lpObj);
int ipworks_traceroute_setremotehost(void* lpObj, const char* lpszRemoteHost);
QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

Traces are initiated by setting RemoteHost 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 RemoteHost to empty string.

Example (Perform a TraceRoute)

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

Data Type

String

ResolveNames Property (TraceRoute Class)

Determines whether the class resolves the host name for each host during the trace.

Syntax

ANSI (Cross Platform)
int GetResolveNames();
int SetResolveNames(int bResolveNames); Unicode (Windows) BOOL GetResolveNames();
INT SetResolveNames(BOOL bResolveNames);
int ipworks_traceroute_getresolvenames(void* lpObj);
int ipworks_traceroute_setresolvenames(void* lpObj, int bResolveNames);
bool GetResolveNames();
int SetResolveNames(bool bResolveNames);

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". Please note that the trace takes longer due to name resolution if this property is set to "True".

Data Type

Boolean

Timeout Property (TraceRoute Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworks_traceroute_gettimeout(void* lpObj);
int ipworks_traceroute_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);

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

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworks_traceroute_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (TraceRoute Class)

Processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int ipworks_traceroute_doevents(void* lpObj);
int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (TraceRoute Class)

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int ipworks_traceroute_interrupt(void* lpObj);
int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (TraceRoute Class)

Reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworks_traceroute_reset(void* lpObj);
int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResolveRemoteHost Method (TraceRoute Class)

Resolves the hostname in RemoteHost to an IP address.

Syntax

ANSI (Cross Platform)
int ResolveRemoteHost();

Unicode (Windows)
INT ResolveRemoteHost();
int ipworks_traceroute_resolveremotehost(void* lpObj);
int ResolveRemoteHost();

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

TraceTo Method (TraceRoute Class)

Trace the route to a host.

Syntax

ANSI (Cross Platform)
int TraceTo(const char* lpszHost);

Unicode (Windows)
INT TraceTo(LPCWSTR lpszHost);
int ipworks_traceroute_traceto(void* lpObj, const char* lpszHost);
int TraceTo(const QString& qsHost);

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 RemoteHost property to Host.

Example (Perform a TraceRoute)

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (TraceRoute Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(TraceRouteErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } TraceRouteErrorEventParams;
Unicode (Windows) virtual INT FireError(TraceRouteErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } TraceRouteErrorEventParams;
#define EID_TRACEROUTE_ERROR 1

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class TraceRouteErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(TraceRouteErrorEventParams *e);
// Or, subclass TraceRoute and override this emitter function. virtual int FireError(TraceRouteErrorEventParams *e) {...}

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.

Hop Event (TraceRoute Class)

Fired for each hop in the trace to the RemoteHost .

Syntax

ANSI (Cross Platform)
virtual int FireHop(TraceRouteHopEventParams *e);
typedef struct {
int HopNumber;
const char *HostAddress;
int Duration; int reserved; } TraceRouteHopEventParams;
Unicode (Windows) virtual INT FireHop(TraceRouteHopEventParams *e);
typedef struct {
INT HopNumber;
LPCWSTR HostAddress;
INT Duration; INT reserved; } TraceRouteHopEventParams;
#define EID_TRACEROUTE_HOP 2

virtual INT IPWORKS_CALL FireHop(INT &iHopNumber, LPSTR &lpszHostAddress, INT &iDuration);
class TraceRouteHopEventParams {
public:
  int HopNumber();

  const QString &HostAddress();

  int Duration();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Hop(TraceRouteHopEventParams *e);
// Or, subclass TraceRoute and override this emitter function. virtual int FireHop(TraceRouteHopEventParams *e) {...}

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.

HopResolved Event (TraceRoute Class)

Fired when the name of a hop address is found.

Syntax

ANSI (Cross Platform)
virtual int FireHopResolved(TraceRouteHopResolvedEventParams *e);
typedef struct {
int HopNumber;
int StatusCode;
const char *HopHostName; int reserved; } TraceRouteHopResolvedEventParams;
Unicode (Windows) virtual INT FireHopResolved(TraceRouteHopResolvedEventParams *e);
typedef struct {
INT HopNumber;
INT StatusCode;
LPCWSTR HopHostName; INT reserved; } TraceRouteHopResolvedEventParams;
#define EID_TRACEROUTE_HOPRESOLVED 3

virtual INT IPWORKS_CALL FireHopResolved(INT &iHopNumber, INT &iStatusCode, LPSTR &lpszHopHostName);
class TraceRouteHopResolvedEventParams {
public:
  int HopNumber();

  int StatusCode();

  const QString &HopHostName();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void HopResolved(TraceRouteHopResolvedEventParams *e);
// Or, subclass TraceRoute and override this emitter function. virtual int FireHopResolved(TraceRouteHopResolvedEventParams *e) {...}

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 ResolveNames to True to enable it.

Config Settings (TraceRoute 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.

TraceRoute Config Settings

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.

HopTimeoutInMilliseconds:   The hop timeout is treated as milliseconds.

Setting HopTimeoutInMilliseconds to true causes the class to use the value in the HopTimeout 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.

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.

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:

ValueDescription
-1 (default)The socket option is left unspecified.
0Do not receive all network traffic.
1Receive 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.
2Receive only socket-level network traffic (this feature may not be implemented by your Windows installation).
3Receive 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 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.

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:

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

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

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.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to 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 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.

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

Setting this 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 (TraceRoute Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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