ChannelFeedListener.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/Packet.h>

ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

ONIXS_CONFLATEDUDP_EXPORTED_CLASS_DECL
(
    Handler
);

ONIXS_CONFLATEDUDP_LTWT_CLASS_DECL
(
    NetFeed
);

/// A listener for the feed-related events 
/// in bounds of a single Handler instance. 
/// 
/// Members of the given listener are invoked 
/// by the Handler when it manipulates feeds to 
/// reflects various aspects of feed behavior. 
ONIXS_CONFLATEDUDP_EXPORTED_STRUCT 
ChannelFeedListener
{
    /// Invoked when Handler establishes connection 
    /// to a feed identified by provided properties. 
    virtual 
    void
    onFeedConnected(
        Handler&, 
        const NetFeed&)
    {
    }

    /// Invoked when Handler drops connection to
    /// a feed identified by provided properties. 
    virtual 
    void 
    onFeedDisconnected(
        Handler&,
        const NetFeed&)
    {
    }

    /// Invoked when packet is received on given feed.
    /// 
    /// Given member is invoked for all data received over 
    /// the feed including duplicated and out of order one. 
    /// Actual processing of received data may be done far 
    /// later or not happen at all if data is outdated or 
    /// duplicates already processed one. Therefore, packet
    /// passed through given member may not appear through 
    /// other listeners like MarketDataListener. 
    virtual
    void
    onFeedPacket(
        Handler&,
        const PacketArgs&)
    {
    }
};

ONIXS_CONFLATEDUDP_NAMESPACE_END