Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
PingProcess Class Reference

PingProcess handles and manipulates ping processes. More...

Inheritance diagram for PingProcess:
Process

Public Member Functions

void start ()
 Starts the ping process. More...
 
void cancel ()
 Cancels the ping process. More...
 
short getId ()
 Returns the ping process ID. More...
 
ip getDestinationIP ()
 Returns the destination IP address. More...
 
ip getSourceIP ()
 Returns the source IP address. More...
 
ip getLastIP ()
 Returns the last IP address in the ping process. More...
 
bool isBroadcast ()
 Returns true if the ping process is broadcasted, otherwise false. More...
 
int getTotalCount ()
 Returns the total number of pings. More...
 
int getSentCount ()
 Returns the number of echo requests sent. More...
 
int getReceivedCount ()
 Returns the number of echo replies received. More...
 
int getTimeout ()
 Returns the timeout value. More...
 
int getMinDelay ()
 Returns the minimum delay value. More...
 
int getMaxDelay ()
 Returns the maximum delay value. More...
 
int getLastDelay ()
 Returns the last delay value. More...
 
int getTotalDelay ()
 Returns the total delay value. More...
 
int getLastTtl ()
 Returns the last TTL value. More...
 
void donePing (int, int)
 This event is emitted when the ping is done. More...
 
- Public Member Functions inherited from Process
Device getOwnerDevice ()
 Returns the device for this process. More...
 

Detailed Description

PingProcess handles and manipulates ping processes.

Member Function Documentation

◆ cancel()

void PingProcess::cancel ( )

Cancels the ping process.

◆ donePing()

void PingProcess::donePing ( int  ,
int   
)

This event is emitted when the ping is done.

  • receiveCount, the number of echo replies received.
  • totalDelay, the total delay value.

IPC event.

◆ getDestinationIP()

ip PingProcess::getDestinationIP ( )

Returns the destination IP address.

Returns
ip, the destination IP address.

◆ getId()

short PingProcess::getId ( )

Returns the ping process ID.

Returns
short, the ping process ID.

◆ getLastDelay()

int PingProcess::getLastDelay ( )

Returns the last delay value.

Returns
int, the last delay value.

◆ getLastIP()

ip PingProcess::getLastIP ( )

Returns the last IP address in the ping process.

Returns
ip, the last IP address in the ping process.

◆ getLastTtl()

int PingProcess::getLastTtl ( )

Returns the last TTL value.

Returns
int, the last TTL value.

◆ getMaxDelay()

int PingProcess::getMaxDelay ( )

Returns the maximum delay value.

Returns
int, the maximum delay value.

◆ getMinDelay()

int PingProcess::getMinDelay ( )

Returns the minimum delay value.

Returns
int, the minimum delay value.

◆ getReceivedCount()

int PingProcess::getReceivedCount ( )

Returns the number of echo replies received.

Returns
int, the number of echo replies received.

◆ getSentCount()

int PingProcess::getSentCount ( )

Returns the number of echo requests sent.

Returns
int, the number of echo requests sent.

◆ getSourceIP()

ip PingProcess::getSourceIP ( )

Returns the source IP address.

Returns
ip, the source IP address.

◆ getTimeout()

int PingProcess::getTimeout ( )

Returns the timeout value.

Returns
int, the timeout value.

◆ getTotalCount()

int PingProcess::getTotalCount ( )

Returns the total number of pings.

Returns
int, the total number of pings.

◆ getTotalDelay()

int PingProcess::getTotalDelay ( )

Returns the total delay value.

Returns
int, the total delay value.

◆ isBroadcast()

bool PingProcess::isBroadcast ( )

Returns true if the ping process is broadcasted, otherwise false.

Returns
bool, true if the ping process is broadcasted, otherwise false.

◆ start()

void PingProcess::start ( )

Starts the ping process.


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