HandlerStateListener.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/SURF/MarketData/Export.h>

#include <string>

namespace OnixS { namespace SURF { namespace MarketData {

/// Defines the state that the handler is in.
struct HandlerState
{
    /// \copydoc HandlerState
    enum Enum
    {
        Disconnected,  ///< Disconnected.
        Disconnecting, ///< Disconnecting.
        Connected,     ///< Connected.
        Connecting,    ///< Connecting.
    };
};

/// Returns string representation of HandlerState value.
ONIXS_TP_SURF_EXPORT std::string enumToString(HandlerState::Enum);

/// Defines an interface through which the Handler notifies subscribers
/// about state change events occurred in runtime.
class HandlerStateListener
{
public:
    /// Implement this member to get notifications about handler state change.
    ///
    /// \param newState new Handler's state.
    virtual void onStateChanged(HandlerState::Enum newState) = 0;

protected:
    /// Class provides an interface for handling Handler's state change events.
    /// It doesn't provide an interface for instance deletion. However,
    /// since C++ doesn't have pure interface concept, destructor will be
    /// generated anyway. We can only control proper use of it. For this
    /// reason we hide from public use and make it available for descendants.
    virtual ~HandlerStateListener() {}
};

}}} // namespace OnixS::SURF::MarketData