class Poco::Net::ICMPEventArgs

Overview

The purpose of the ICMPEventArgs class is to be used as template parameter to instantiate event members in ICMPClient class. More…

#include <ICMPEventArgs.h>

class ICMPEventArgs
{
public:
    // construction

    ICMPEventArgs(
        const SocketAddress& address,
        int repetitions,
        int dataSize,
        int ttl
        );

    // methods

    std::string
    hostName() const;

    std::string
    hostAddress() const;

    int
    repetitions() const;

    int
    dataSize() const;

    int
    ttl() const;

    int
    sent() const;

    int
    received() const;

    int
    replyTime(int index = -1) const;

    const std::string&
    error(int index = -1) const;

    int
    minRTT() const;

    int
    maxRTT() const;

    int
    avgRTT() const;

    float
    percent() const;
};

Detailed Documentation

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.

Construction

ICMPEventArgs(
    const SocketAddress& address,
    int repetitions,
    int dataSize,
    int ttl
    )

Creates ICMPEventArgs.

Methods

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.

std::string
hostAddress() const

Returns the target IP address.

int
repetitions() const

Returns the number of repetitions for the ping operation.

int
dataSize() const

Returns the packet data size in bytes.

int
ttl() const

Returns time to live.

int
sent() const

Returns the number of packets sent.

int
received() const

Returns the number of packets received.

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.

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.

int
minRTT() const

Returns the minimum round trip time for a sequence of requests.

int
maxRTT() const

Returns the maximum round trip time for a sequence of requests.

int
avgRTT() const

Returns the average round trip time for a sequence of requests.

float
percent() const

Returns the success percentage for a sequence of requests.