FeedListener.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "Export.h"
#include "Types.h"
#include "Error.h"
#include "MessageInfo.h"

#include <string>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// \brief Defines the interface through which the Handler
/// notifies subscribers about feed events.
class ONIXS_ICEMDH_EXPORT FeedListener
{
public:
    /// Implement this member to get notifications about starting of new feeds.
    ///
    /// \param feedId Feed ID.
    /// \param ids Market IDs.
    virtual void onFeedStarted(FeedId feedId, const MarketIds& ids) = 0;

    /// Implement this member to get notifications about finishing of feeds.
    ///
    /// \param feedId Feed ID.
    virtual void onFeedStopped(FeedId feedId) = 0;

    /// \brief Implement this member to get notifications about multicast message block start.
    ///
    /// \param feedId Feed ID.
    /// \param msgInfo information about multicast message block.
    virtual void onMulticastMessageBlockBegin(FeedId feedId, const MessageInfo& msgInfo) = 0;

    /// \brief Implement this member to get notifications about multicast message block end.
    ///
    /// \param feedId Feed ID.
    /// \param marketIds updated market IDs.
    virtual void onMulticastMessageBlockEnd(FeedId feedId, const MarketIds& marketIds) = 0;

    /// \brief Implement this member to get notifications about session number change.
    ///
    /// \param feedId Feed ID.
    /// \param oldSessionNumber Old session number.
    /// \param newSessionNumber New session number.
    virtual void onSessionNumberChange(FeedId feedId, short oldSessionNumber, short newSessionNumber) = 0;

protected:
    virtual ~FeedListener() {}
};

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS