FeedConsumer.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>

ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

// A bit of forward declarations. 

ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL(NetFeed);
ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL(NetPacket);

/// Represents an interface through which the 
/// Feed Engine pushes market data received for 
/// the feeds. 
ONIXS_CONFLATEDUDP_EXPORTED_CLASS NetFeedConsumer
{
    NetFeedConsumer(
        const NetFeedConsumer&);

    NetFeedConsumer& 
    operator =(
        const NetFeedConsumer&);

protected:
    /// Protected construction for descendants. 
    NetFeedConsumer()
    {
    }

    /// Lifetime of the instance is not maintained 
    /// through the interface of the given class. 
    virtual ~NetFeedConsumer()
    {
    }

public:
    /// Tries to gain access to the given consumer. 
    /// 
    /// Before invoking any other member, the consumer
    /// must be successfully acquired. This is because
    /// the consumer may be busy while handling the other 
    /// event from the other source. 
    virtual 
    bool 
    tryAcquire() = 0;

    /// Releases previously acquired consumer. 
    virtual 
    void 
    release() = 0;

    /// Invoked by the feed engine machinery 
    /// when a packet is received for the feed 
    /// associated with the given consumer. 
    /// 
    /// The given member must be invoked only when 
    /// the consumer was already successfully acquired. 
    virtual 
    void 
    onPacket(
        const NetPacket&) = 0;

    /// Invoked by the feed engine machinery 
    /// when any packet wasn't received for the 
    /// feed associated with the given consumer 
    /// for a predefined amount of time. 
    /// 
    /// The given member must be invoked only when 
    /// the consumer was already successfully acquired. 
    virtual 
    void 
    onTimeout(
        const NetFeed&) = 0;

    /// Invoked by the feed engine machinery 
    /// when the feed associated with the given 
    /// consumer has reached its expiration time. 
    /// The expiration time for the feed is defined 
    /// by the 'expirationTime' member. 
    /// 
    /// The given member must be invoked only when 
    /// the consumer was already successfully acquired. 
    virtual 
    void 
    onExpiration(
        const NetFeed&) = 0;

    /// Invoked by the feed engine machinery when 
    /// it experienced an issue while receiving data 
    /// for the feed associated with the given consumer. 
    /// 
    /// The given member must be invoked only when 
    /// the consumer was already successfully acquired. 
    virtual 
    void 
    onFailure(
        const NetFeed&, 
        const Char*) = 0;
};

ONIXS_CONFLATEDUDP_NAMESPACE_END