mirror of
https://github.com/pocoproject/poco.git
synced 2025-10-25 10:09:36 +02:00
* NTP client implementation
This commit is contained in:
Rangel Reale
86
Net/include/Poco/Net/NTPClient.h
Normal file
86
Net/include/Poco/Net/NTPClient.h
Normal file
@@ -0,0 +1,86 @@
|
||||
//
|
||||
// NTPClient.h
|
||||
//
|
||||
// $Id: //poco/1.4/Net/include/Poco/Net/NTPClient.h#1 $
|
||||
//
|
||||
// Library: Net
|
||||
// Package: NTP
|
||||
// Module: NTPClient
|
||||
//
|
||||
// Definition of the NTPClient class.
|
||||
//
|
||||
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Net_NTPClient_INCLUDED
|
||||
#define Net_NTPClient_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Net/Net.h"
|
||||
#include "Poco/Net/NTPEventArgs.h"
|
||||
#include "Poco/Net/SocketAddress.h"
|
||||
#include "Poco/BasicEvent.h"
|
||||
|
||||
|
||||
namespace Poco {
|
||||
namespace Net {
|
||||
|
||||
|
||||
class Net_API NTPClient
|
||||
/// This class provides NTP (Network Time Protocol) client functionality.
|
||||
{
|
||||
public:
|
||||
mutable Poco::BasicEvent<NTPEventArgs> response;
|
||||
|
||||
explicit NTPClient(IPAddress::Family family, int timeout = 3000000);
|
||||
/// Creates an NTP client.
|
||||
|
||||
~NTPClient();
|
||||
/// Destroys the NTP client.
|
||||
|
||||
int request(SocketAddress& address) const;
|
||||
/// Request the time from the server at address.
|
||||
/// Notifications are posted for events.
|
||||
///
|
||||
/// Returns the number of valid replies.
|
||||
|
||||
int request(const std::string& address) const;
|
||||
/// Request the time from the server at address.
|
||||
/// Notifications are posted for events.
|
||||
///
|
||||
/// Returns the number of valid replies.
|
||||
|
||||
private:
|
||||
mutable IPAddress::Family _family;
|
||||
int _timeout;
|
||||
};
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
#endif // Net_NTPClient_INCLUDED
|
||||
106
Net/include/Poco/Net/NTPEventArgs.h
Normal file
106
Net/include/Poco/Net/NTPEventArgs.h
Normal file
@@ -0,0 +1,106 @@
|
||||
//
|
||||
// NTPEventArgs.h
|
||||
//
|
||||
// $Id: //poco/1.4/Net/include/Poco/Net/NTPEventArgs.h#1 $
|
||||
//
|
||||
// Library: Net
|
||||
// Package: NTP
|
||||
// Module: NTPEventArgs
|
||||
//
|
||||
// Definition of NTPEventArgs.
|
||||
//
|
||||
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Net_NTPEventArgs_INCLUDED
|
||||
#define Net_NTPEventArgs_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Net/Net.h"
|
||||
#include "Poco/Net/SocketAddress.h"
|
||||
#include "Poco/Net/NTPPacket.h"
|
||||
|
||||
|
||||
namespace Poco {
|
||||
namespace Net {
|
||||
|
||||
|
||||
class Net_API NTPEventArgs
|
||||
/// The purpose of the NTPEventArgs class is to be used as template parameter
|
||||
/// to instantiate event members in NTPClient 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.
|
||||
{
|
||||
public:
|
||||
NTPEventArgs(const SocketAddress& address);
|
||||
/// Creates NTPEventArgs.
|
||||
|
||||
virtual ~NTPEventArgs();
|
||||
/// Destroys NTPEventArgs.
|
||||
|
||||
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.
|
||||
|
||||
const NTPPacket &packet();
|
||||
/// Returns the NTP packet.
|
||||
|
||||
private:
|
||||
NTPEventArgs();
|
||||
|
||||
void setPacket(NTPPacket &packet);
|
||||
|
||||
SocketAddress _address;
|
||||
NTPPacket _packet;
|
||||
|
||||
friend class NTPClient;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// inlines
|
||||
//
|
||||
inline const NTPPacket &NTPEventArgs::packet()
|
||||
{
|
||||
return _packet;
|
||||
}
|
||||
|
||||
|
||||
inline void NTPEventArgs::setPacket(NTPPacket &packet)
|
||||
{
|
||||
_packet = packet;
|
||||
}
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
#endif
|
||||
229
Net/include/Poco/Net/NTPPacket.h
Normal file
229
Net/include/Poco/Net/NTPPacket.h
Normal file
@@ -0,0 +1,229 @@
|
||||
//
|
||||
// NTPPacket.h
|
||||
//
|
||||
// $Id: //poco/1.4/Net/include/Poco/Net/NTPPacket.h#1 $
|
||||
//
|
||||
// Library: Net
|
||||
// Package: NTP
|
||||
// Module: NTPPacket
|
||||
//
|
||||
// Definition of the NTPPacket class.
|
||||
//
|
||||
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
|
||||
// and Contributors.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person or organization
|
||||
// obtaining a copy of the software and accompanying documentation covered by
|
||||
// this license (the "Software") to use, reproduce, display, distribute,
|
||||
// execute, and transmit the Software, and to prepare derivative works of the
|
||||
// Software, and to permit third-parties to whom the Software is furnished to
|
||||
// do so, all subject to the following:
|
||||
//
|
||||
// The copyright notices in the Software and this entire statement, including
|
||||
// the above license grant, this restriction and the following disclaimer,
|
||||
// must be included in all copies of the Software, in whole or in part, and
|
||||
// all derivative works of the Software, unless such copies or derivative
|
||||
// works are solely in the form of machine-executable object code generated by
|
||||
// a source language processor.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
||||
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
||||
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
||||
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
// DEALINGS IN THE SOFTWARE.
|
||||
//
|
||||
|
||||
|
||||
#ifndef Net_NTPPacket_INCLUDED
|
||||
#define Net_NTPPacket_INCLUDED
|
||||
|
||||
|
||||
#include "Poco/Foundation.h"
|
||||
#include "Poco/Net/Net.h"
|
||||
#include "Poco/Timestamp.h"
|
||||
|
||||
namespace Poco {
|
||||
namespace Net {
|
||||
|
||||
|
||||
class Net_API NTPPacket
|
||||
/// This class is the NTP packet abstraction.
|
||||
{
|
||||
public:
|
||||
NTPPacket();
|
||||
/// Creates an NTPPacket.
|
||||
|
||||
NTPPacket(Poco::UInt8 *packet);
|
||||
/// Creates an NTPPacket.
|
||||
///
|
||||
/// Assumed to have at least 48 bytes.
|
||||
|
||||
~NTPPacket();
|
||||
/// Destroys the NTPPacket.
|
||||
|
||||
void packet(Poco::UInt8 *packet) const;
|
||||
/// Returns the NTP packet.
|
||||
///
|
||||
/// Assumed to have at least 48 bytes.
|
||||
|
||||
void setPacket(Poco::UInt8 *packet);
|
||||
/// Returns the NTP packet.
|
||||
///
|
||||
/// Assumed to have exactly 48 bytes.
|
||||
|
||||
Poco::Int8 leapIndicator() const;
|
||||
/// Returns the leap indicator.
|
||||
|
||||
Poco::Int8 version() const;
|
||||
/// Returns the version.
|
||||
|
||||
Poco::Int8 mode() const;
|
||||
/// Returns the mode.
|
||||
|
||||
Poco::Int8 stratum() const;
|
||||
/// Returns the stratum.
|
||||
|
||||
Poco::Int8 pool() const;
|
||||
/// Returns the pool.
|
||||
|
||||
Poco::Int8 precision() const;
|
||||
/// Returns the precision
|
||||
|
||||
Poco::Int32 rootDelay() const;
|
||||
/// Returns the root delay
|
||||
|
||||
Poco::Int32 rootDispersion() const;
|
||||
/// Returns the root dispersion
|
||||
|
||||
Poco::Int32 referenceId() const;
|
||||
/// Returns the reference id
|
||||
|
||||
Poco::Int64 referenceTimestamp() const;
|
||||
/// Returns the reference timestamp
|
||||
|
||||
Poco::Int64 originateTimestamp() const;
|
||||
/// Returns the originate timestamp
|
||||
|
||||
Poco::Int64 receiveTimestamp() const;
|
||||
/// Returns the receive timestamp
|
||||
|
||||
Poco::Int64 transmitTimestamp() const;
|
||||
/// Returns the transmit timestamp
|
||||
|
||||
Poco::Timestamp referenceTime() const;
|
||||
/// Returns the reference time
|
||||
|
||||
Poco::Timestamp originateTime() const;
|
||||
/// Returns the originate time
|
||||
|
||||
Poco::Timestamp receiveTime() const;
|
||||
/// Returns the receive time
|
||||
|
||||
Poco::Timestamp transmitTime() const;
|
||||
/// Returns the transmit time
|
||||
private:
|
||||
Poco::Timestamp convertTime(Poco::Int64 tm) const;
|
||||
|
||||
Poco::Int8 _leapIndicator;
|
||||
Poco::Int8 _version;
|
||||
Poco::Int8 _mode;
|
||||
Poco::Int8 _stratum;
|
||||
Poco::Int8 _pool;
|
||||
Poco::Int8 _precision;
|
||||
Poco::Int32 _rootDelay;
|
||||
Poco::Int32 _rootDispersion;
|
||||
Poco::Int32 _referenceId;
|
||||
Poco::Int64 _referenceTimestamp;
|
||||
Poco::Int64 _originateTimestamp;
|
||||
Poco::Int64 _receiveTimestamp;
|
||||
Poco::Int64 _transmitTimestamp;
|
||||
};
|
||||
|
||||
|
||||
//
|
||||
// inlines
|
||||
//
|
||||
inline Poco::Int8 NTPPacket::leapIndicator() const
|
||||
{
|
||||
return _leapIndicator;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int8 NTPPacket::version() const
|
||||
{
|
||||
return _version;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int8 NTPPacket::mode() const
|
||||
{
|
||||
return _mode;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int8 NTPPacket::stratum() const
|
||||
{
|
||||
return _stratum;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int8 NTPPacket::pool() const
|
||||
{
|
||||
return _pool;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int8 NTPPacket::precision() const
|
||||
{
|
||||
return _precision;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int32 NTPPacket::rootDelay() const
|
||||
{
|
||||
return _rootDelay;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int32 NTPPacket::rootDispersion() const
|
||||
{
|
||||
return _rootDispersion;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int32 NTPPacket::referenceId() const
|
||||
{
|
||||
return _referenceId;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int64 NTPPacket::referenceTimestamp() const
|
||||
{
|
||||
return _referenceTimestamp;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int64 NTPPacket::originateTimestamp() const
|
||||
{
|
||||
return _originateTimestamp;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int64 NTPPacket::receiveTimestamp() const
|
||||
{
|
||||
return _receiveTimestamp;
|
||||
}
|
||||
|
||||
|
||||
inline Poco::Int64 NTPPacket::transmitTimestamp() const
|
||||
{
|
||||
return _transmitTimestamp;
|
||||
}
|
||||
|
||||
|
||||
} } // namespace Poco::Net
|
||||
|
||||
|
||||
#endif // Net_NTPPacket_INCLUDED
|
||||
@@ -69,6 +69,7 @@ POCO_DECLARE_EXCEPTION(Net_API, FTPException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, SMTPException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, POP3Exception, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, ICMPException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, NTPException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, HTMLFormException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, WebSocketException, NetException)
|
||||
POCO_DECLARE_EXCEPTION(Net_API, UnsupportedFamilyException, NetException)
|
||||
|
||||
Reference in New Issue
Block a user