ClickHouse/base/poco/Net/include/Poco/Net/ICMPClient.h

93 lines
2.5 KiB
C++

//
// ICMPClient.h
//
// Library: Net
// Package: ICMP
// Module: ICMPClient
//
// Definition of the ICMPClient class.
//
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
// and Contributors.
//
// SPDX-License-Identifier: BSL-1.0
//
#ifndef Net_ICMPClient_INCLUDED
#define Net_ICMPClient_INCLUDED
#include "Poco/BasicEvent.h"
#include "Poco/Net/ICMPEventArgs.h"
#include "Poco/Net/ICMPSocket.h"
#include "Poco/Net/Net.h"
#include "Poco/Net/SocketAddress.h"
namespace Poco
{
namespace Net
{
class Net_API ICMPClient
/// This class provides ICMP Ping functionality.
///
/// The events are available when class is instantiated
/// and non-static member functions are called.
///
/// A "lightweight" alternative is direct (without instantiation)
/// use of static member functions.
{
public:
mutable Poco::BasicEvent<ICMPEventArgs> pingBegin;
mutable Poco::BasicEvent<ICMPEventArgs> pingReply;
mutable Poco::BasicEvent<ICMPEventArgs> pingError;
mutable Poco::BasicEvent<ICMPEventArgs> pingEnd;
explicit ICMPClient(SocketAddress::Family family, int dataSize = 48, int ttl = 128, int timeout = 50000);
/// Creates an ICMP client.
~ICMPClient();
/// Destroys the ICMP client.
int ping(SocketAddress & address, int repeat = 1) const;
/// Pings the specified address [repeat] times.
/// Notifications are posted for events.
///
/// Returns the number of valid replies.
int ping(const std::string & address, int repeat = 1) const;
/// Calls ICMPClient::ping(SocketAddress&, int) and
/// returns the result.
///
/// Returns the number of valid replies.
static int
ping(SocketAddress & address, SocketAddress::Family family, int repeat = 1, int dataSize = 48, int ttl = 128, int timeout = 50000);
/// Pings the specified address [repeat] times.
/// Notifications are not posted for events.
///
/// Returns the number of valid replies.
static int pingIPv4(const std::string & address, int repeat = 1, int dataSize = 48, int ttl = 128, int timeout = 50000);
/// Calls ICMPClient::ping(SocketAddress&, int) and
/// returns the result.
///
/// Returns the number of valid replies.
private:
mutable SocketAddress::Family _family;
int _dataSize;
int _ttl;
int _timeout;
};
}
} // namespace Poco::Net
#endif // Net_ICMPClient_INCLUDED