Library: Net
Package: ICMP
Header: Poco/Net/ICMPEventArgs.h
The purpose of the ICMPEventArgs class is to be used as template parameter to instantiate event members in ICMPClient class. When clients register for an event notification, the reference to the class is passed to the handler function to provide information about the event.
Member Functions: avgRTT, dataSize, error, hostAddress, hostName, maxRTT, minRTT, percent, received, repetitions, replyTime, sent, ttl
ICMPEventArgs(
const SocketAddress & address,
int repetitions,
int dataSize,
int ttl
);
Creates ICMPEventArgs.
virtual ~ICMPEventArgs();
Destroys ICMPEventArgs.
int avgRTT() const;
Returns the average round trip time for a sequence of requests.
int dataSize() const;
Returns the packet data size in bytes.
const std::string & error(
int index = - 1
) const;
Returns the error string for the request specified with index. If index == -1 (default), returns the most recent error string.
std::string hostAddress() const;
Returns the target IP address.
std::string hostName() const;
Tries to resolve the target IP address into host name. If unsuccessful, all exceptions are silently ignored and the IP address is returned.
int maxRTT() const;
Returns the maximum round trip time for a sequence of requests.
int minRTT() const;
Returns the minimum round trip time for a sequence of requests.
float percent() const;
Returns the success percentage for a sequence of requests.
int received() const;
Returns the number of packets received.
int repetitions() const;
Returns the number of repetitions for the ping operation.
int replyTime(
int index = - 1
) const;
Returns the reply time for the request specified with index. If index == -1 (default), returns the most recent reply time.
int sent() const;
Returns the number of packets sent.
int ttl() const;
Returns time to live.