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.

Method List

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

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.

Config Settings

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

HopLimit Property (TraceRoute Class)

The maximum number of hops to allow for a trace.

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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:

• HopErrorCode
• HopErrorDescription
• HopHostAddress
• HopHostName
• HopTime

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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.

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.

Hop Event (TraceRoute Class)

Fired for each hop in the trace to the RemoteHost .

Syntax

• C++
• C
• Qt

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

• C++
• C
• Qt

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)

TraceRoute Config Settings

ICMP Config Settings

Socket Config Settings

Base Config Settings

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

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

ICMP Errors

SSL Errors

TCP/IP Errors