Handler.h

Go to the documentation of this file.

#pragma once
/*
* 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.
*/

#include "OnixS/MTS/BondVision/SDP/ABI.h"
#include "OnixS/MTS/BondVision/SDP/AdminMessageListener.h"
#include "OnixS/MTS/BondVision/SDP/SMP.ClassListener.h"
#include "OnixS/MTS/BondVision/SDP/SessionListener.h"
#include "OnixS/MTS/BondVision/SDP/ServiceAddressInformationListener.h"
#include "OnixS/MTS/BondVision/SDP/SMP.ClassIds.h"

namespace OnixS {
namespace Mts {
namespace BondVision {
namespace SDP {

class Class;
struct ReplayOptions;

/// OnixS MTS BonVision/SDP Handler
///
class ONIXS_MTS_BONDVISION_SDP_API Handler
{
public:
    /// Performs instance initialization.
    /// @param settings defines values for various options
    /// which affect handler behavior like enabling logging
    /// during execution of the handler.
    Handler (const HandlerSettings& settings);

    virtual ~Handler();

    /// Establishes the connection.
    ///
    /// @note Blocks until the logon reply is received.
    ///
    /// @note Should be called only when Handler is disconnected.
    ///
    /// @param hostName Hostname to connect to.
    ///
    /// @param port Port number to connect to.
    ///
    /// @param logon Initial logon message parameters.
    ///
    /// @param localNetworkInterface Local network interface.
    ///
    /// @throw std::exception Cannot set the local network interface.
    /// @throw std::exception Cannot connect to hostname on port.
    /// @throw std::exception Cannot configure size of receive buffer for the socket.
    /// @throw std::exception Cannot configure size of send buffer for the socket.
    /// @throw OperationException Invalid argument is given.
    void connect (const ConnectionSettings& connectionSettings, const LogonSettings& logonSettings, const std::string& hostName, UInt16 port, const std::string& localNetworkInterface = "");

    /// Force session disconnect.
    ///
    /// @note Blocks until the Session Logout procedure is finished.
    void disconnect ();

    /// Async force session disconnect.
    ///
    void disconnectAsync ();

    /// Replays previously logged data.
    void replay(const ReplayOptions& options);

    /// Request address service information
    ///
    /// @note The requested information will be provided by ServiceAddressInformationListener::onServiceAddressInformation callback.
    ///
    /// @throws OperationException Attempt to send data before connection creation
    /// @throws std::exception with system dependent message if requesting has been failed
    void requestAddressServiceInformation ();

    /// subscribe to market information
    ///
    /// @param classId ClassId to subscribe to.
    ///
    /// @note The subscribed information will be provided by corresponding callbacks.
    ///
    /// @throws OperationException Attempt to send data before connection creation
    /// @throws std::exception with system dependent message if requesting has been failed
    void subscribe(ClassId::Enum classId, SubscribeType::Enum subscribeType = SubscribeType::All);

    /// subscribe to market information with filter
    void subscribeFiltered(ClassId::Enum classId, UInt32 filterKey, SubscribeType::Enum subscribeType = SubscribeType::All);

    /// unsubscribe from market information
    ///
    /// @param classId ClassId to unsubscribe from.
    ///
    /// @throws OperationException Attempt to send data before connection creation
    /// @throws std::exception with system dependent message if requesting has been failed
    void unsubscribe(ClassId::Enum classId);

    /// perform action
    ///
    /// @param 
    ///
    /// @throws OperationException Attempt to send data before connection creation
    /// @throws std::exception with system dependent message if requesting has been failed
    UInt32 act(ActionType::Enum actionType, Class* msg, bool dataInResponse = false);

    /// add filter
    /// return filter key
    UInt32 addFilter(UInt32 filterId, const std::string& value);

    /// Assigns listener for errors occurred while executing handler.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected
    void registerErrorListener (ErrorListener* listener);

    /// Assigns listener for warnings occurred while executing handler.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected
    void registerWarningListener (WarningListener* listener);

    /// Assigns listener for state change events occurred while executing handler.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerHandlerStateListener (HandlerStateListener* listener);

    /// Assigns listener for session events occurred while executing handler.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerSessionListener (SessionListener* listener);

    /// Assigns listener for notification abaout address service information.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerServiceAddressInformationListener (ServiceAddressInformationListener* listener);

    /// Assigns listener for administrative events.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerAdminMessageListener (AdminMessageListener* listener);

    /// Assigns listener for exchange events.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerClassListener (ClassListener* listener);

    /// Assigns listener for action result events.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerActResultListener(ActResultListener* listener);

    /// Assigns listener for action result events.
    /// It's permissible to change the listener multiple times during
    /// handler's life-time, but only when handler is in disconnected state.
    /// @throw OperationException if handler not disconnected.
    void registerSubscriptionListener(SubscriptionListener* listener);

    /// Returns handler state.
    ///
    HandlerState::Enum state () const;

    /// Logs the given user-level message to the handler log.
    ///
    void log (LogLevel::Enum logLevel, const char* logMessage, size_t length);

    /// Logs the given user-level message to the handler log
    ///
    void log (LogLevel::Enum logLevel, const char* logMessage);

    /// Logs the given user-level message to the handler log.
    ///
    void log (LogLevel::Enum logLevel, const std::string& str);

    /// Returns the license expiration date.
    ///
    const std::string& licenseExpirationDate () const;

    /// Returns Handler's version.
    ///
    static const std::string version ();

private:
    Handler (const Handler&); // no implementation
    Handler& operator = (const Handler&); // no implementation

private:
    struct Impl;
    Impl* impl_;
};
}
}
}
}