TraceRoute Class

Properties   Methods   Events   Config Settings   Errors  

The TraceRoute class allows you to trace the path 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 towards 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.

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.

hop_limit Property

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

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

0

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

The error code for particular hop in the trace.

Syntax

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

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

The error description for particular hop in the trace.

Syntax

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

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

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

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

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

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

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

Syntax

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

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

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

10

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

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.

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

The local_host 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 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 multi-homed 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

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

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

timeout Property

A timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

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

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.

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

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

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

resolve_remote_host 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 necessary. If DelayHostResolution is True this method may be called to manually resolve remote_host if desired.

trace_to Method

Trace 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

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

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

ICMP Config Settings

Socket Config Settings

Base Config Settings

TraceRoute Errors

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