Watch.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable
// OnixS Software Services Agreement (the Agreement) and Customer end user license
// agreements granting a non-assignable, non-transferable and non-exclusive license
// to use the software for it's own data processing purposes under the terms defined
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or
// reproduction of any part of this source code or associated reference material
// to any other location for further reproduction or redistribution, and any
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in
// accordance with the terms of the Agreement is a violation of copyright law.
//

#pragma once

#include <OnixS/CME/MDH/String.h>
#include <OnixS/CME/MDH/Time.h>

ONIXS_CMEMDH_NAMESPACE_BEGIN

/// Abstract watch service.
struct ONIXS_CMEMDH_EXPORTED WatchService
{
    /// Identifies watch service.
    virtual const Char* id() const = 0;

    /// Returns current time.
    virtual Timestamp now() = 0;
};

/// Local watch.
class ONIXS_CMEMDH_EXPORTED LocalWatch
{
public:
    /// Returns current local time.
    static Timestamp now();

    /// Returns watch service implementing local watch.
    static WatchService& service();

private:
    LocalWatch(const LocalWatch&);
    LocalWatch& operator=(const LocalWatch&);
};

/// UTC watch.
class ONIXS_CMEMDH_EXPORTED UtcWatch
{
public:
    /// Returns current UTC time.
    static Timestamp now();

    /// Returns watch service implementing UTC watch.
    static WatchService& service();

private:
    UtcWatch(const UtcWatch&);
    UtcWatch& operator=(const UtcWatch&);
};

/// The network interface watch.
///
/// This class is designed to use the network adapter's watch if the capability is supported.
/// When an instance of the class is linked to a feed engine supporting hardware timestamps retrieval,
/// the feed engine extracts hardware timestamps and assigns them to the incoming multicast packets.
///
/// An ordinary system (UTC) clock is used in all other cases.
class ONIXS_CMEMDH_EXPORTED NicWatch
{
public:
    /// Returns the watch service instance reference.
    static WatchService& service();

private:
    NicWatch(const NicWatch&);
    NicWatch& operator=(const NicWatch&);
};

ONIXS_CMEMDH_NAMESPACE_END