NAME

Liz::PingSet::Ping - module for Ping objects of the PingSet


SYNOPSIS

 use Liz::PingSet;
 $pingset = new Liz::PingSet;

 $ping = $pingset->Ping;
 $ping = $pingset->Ping( $ID );

 $ping->update;


EXAMPLES


DESCRIPTION

Provide object oriented access to pings in a PingSet. Usually not accessed directly, but rather through the Liz::PingSet object and its Ping method.


BASIC METHODS


new

Create a new Ping object from a PingSet object.

Input Parameters

 1 Liz::PingSet object
 2 ID to create Ping object with
Output Parameters

 1 instantiated object
Note

It is not intended to call this method directly, but rather indirectly through the Liz::PingSet module.

Example

 $pingset = new Liz::PingSet;
 $ping = $pingset->Ping;
 $ping = $pingset->Ping( $ID );


delete

Delete the Liz::PingSet::Ping object from the database.

Output Parameters

 1 flag: whether action was successful
Example

 $ping->delete;


CONTENT METHODS

The following methods allow you to inspect and/or change certain fields of the Liz::PingSet::Ping object.


AvgRoundTrip

Return the average roundtrip time of the Liz::PingSet::Ping object.

Output Parameters

 1 average roundtrip time in milliseconds
Example

 $avgroundtrip = $ping->AvgRoundTrip;


Created

Return the Created timestamp of the Liz::PingSet::Ping object.

Output Parameters

 1 current timestamp value of the Created date
Example

 $created = $ping->Created;


Dups

Return the number of duplicate packets of the Liz::PingSet::Ping object.

Output Parameters

 1 current number of duplicate packets
Example

 $dups = $ping->Dups;


Host

Return the host of the Liz::PingSet::Ping object. Use method IP for the IP-number associated with the host.

Output Parameters

 1 host name associated with object (IP-number if cannot be resolved)
Example

 $host = $ping->Host;


IP

Return the IP-number of the Liz::PingSet::Ping object. Use method Host for the hostname associated with the IP-number.

Output Parameters

 1 current IP-number of the object
Example

 $IP = $ping->IP;


Lost

Return the number of packets of lost the Liz::PingSet::Ping object.

Output Parameters

 1 current number of packets lost
Example

 $lost = $ping->Lost;


MaxRoundTrip

Return the maximum roundtrip time of the Liz::PingSet::Ping object.

Output Parameters

 1 maximum roundtrip time in milliseconds
Example

 $maxroundtrip = $ping->MaxRoundTrip;


MinRoundTrip

Return the minimum roundtrip time of the Liz::PingSet::Ping object.

Output Parameters

 1 minimum roundtrip time in milliseconds
Example

 $minroundtrip = $ping->MinRoundTrip;


AUTHOR

Elizabeth Mattijsen ( lizperl@INC.nl )


COPYRIGHT

(C) 1999 International Network Consultants


HISTORY

Version 0.11, 30 September 1999

Now no longer adds Exporter to ISA: it wasn't necessary.

Version 0.1, 29 August 1999

First version of this true Perl module.