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/ConflatedUDP/String.h>
#include <OnixS/CME/ConflatedUDP/Time.h>

ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

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

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

/// Local watch.
ONIXS_CONFLATEDUDP_EXPORTED_CLASS LocalWatch
{
    LocalWatch(const LocalWatch&);
    LocalWatch& operator =(const LocalWatch&);

public:
    /// Returns current local time. 
    static Timestamp now();

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

/// UTC watch. 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS UtcWatch
{
    UtcWatch(const UtcWatch&);
    UtcWatch& operator =(const UtcWatch&);

public:
    /// Returns current UTC time. 
    static Timestamp now();

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

/// The network interface watch. 
/// 
/// The given class is designed to identify use 
/// of the network adapter's watch if the capability 
/// is supported. When an instance of the given class 
/// is linked to a feed engine supporting hardware 
/// timestamps retrieval, then the feed engine extracts 
/// hardware timestamps assigns them to the incoming 
/// multicast packets. In all other cases, an ordinary 
/// system (UTC) clock is used. 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS NicWatch
{
    NicWatch(const NicWatch&);
    NicWatch& operator =(const NicWatch&);

public:
    /// Returns watch service implementing a NIC watch. 
    static WatchService& service();
};

ONIXS_CONFLATEDUDP_NAMESPACE_END