IcmpProcess Class Reference

IcmpProcess is the process that handles and manipulates ICMP. More...

Inheritance diagram for IcmpProcess:

Public Member Functions
short	startPing (ip, int, int, int, string)
	Starts a ping to the specified destination and returns the ping process ID. More...
short	createPingProcess (ip, int, int, int, string)
	Creates a ping process and returns the ping process ID. More...
PingProcess	getPingProcess (short)
	Returns the PingProcess object associated with specified ping process ID. More...
short	startTraceRoute (ip, int, int, int, int, int, string)
	Starts a traceroute to the specified destination and returns the traceroute process ID. More...
short	createTraceRouteProcess (ip, int, int, int, int, int, string)
	Creates a trace route process and returns the traceroute process ID. More...
TraceRouteProcess	getTraceRouteProcess (short)
	Returns the TraceRouteProcess object associated with specified traceroute process ID. More...
Public Member Functions inherited from Process
Device	getOwnerDevice ()
	Returns the device for this process. More...

Detailed Description

IcmpProcess is the process that handles and manipulates ICMP.

Member Function Documentation

createPingProcess()

short IcmpProcess::createPingProcess	(	ip	,
		int	,
		int	,
		int	,
		string
	)

Creates a ping process and returns the ping process ID.

Parameters

dstIpAddress,the	destination IP address.
repeatTime,the	repeat time value.
timeout,the	timeout value.
waitTime,the	wait time value.
portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

short, the ping process ID.

createTraceRouteProcess()

short IcmpProcess::createTraceRouteProcess	(	ip	,
		int	,
		int	,
		int	,
		int	,
		int	,
		string
	)

Creates a trace route process and returns the traceroute process ID.

Parameters

dstIpAddress,the	destination IP address.
probeCount,the	number of probes to send.
minTTL,the	minimum TTL value.
maxTTL,the	maximum TTL value.
timeout,the	timeout value.
waitTime,the	wait time value.
portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

short, the traceroute process ID.

getPingProcess()

PingProcess IcmpProcess::getPingProcess

(

short

)

Returns the PingProcess object associated with specified ping process ID.

Parameters

id,the

ID of the ping process of interest.

Returns

PingProcess, the PingProcess object associated with specified ping process ID.

getTraceRouteProcess()

TraceRouteProcess IcmpProcess::getTraceRouteProcess

(

short

)

Returns the TraceRouteProcess object associated with specified traceroute process ID.

Parameters

id,the

ID of the traceroute process of interest.

Returns

TraceRouteProcess, the TraceRouteProcess object associated with specified traceroute process ID.

startPing()

short IcmpProcess::startPing	(	ip	,
		int	,
		int	,
		int	,
		string
	)

Starts a ping to the specified destination and returns the ping process ID.

Parameters

dstIpAddress,the	destination IP address.
repeatTime,the	repeat time value.
timeout,the	timeout value.
waitTime,the	wait time value.
portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

short, the ping process ID.

startTraceRoute()

short IcmpProcess::startTraceRoute	(	ip	,
		int	,
		int	,
		int	,
		int	,
		int	,
		string
	)

Starts a traceroute to the specified destination and returns the traceroute process ID.

Parameters

dstIpAddress,the	destination IP address.
probeCount,the	number of probes to send.
minTTL,the	minimum TTL value.
maxTTL,the	maximum TTL value.
timeout,the	timeout value.
waitTime,the	wait time value.
portName,portName	can be one of the following plus a port number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0

Returns

short, the traceroute process ID.

---

The documentation for this class was generated from the following file:

• CIcmpProcess.pki