Handler.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/Eurex/Trading/AdminListener.h"
#include "OnixS/Eurex/Trading/CLIPListener.h"
#include "OnixS/Eurex/Trading/ConnectionStateListener.h"
#include "OnixS/Eurex/Trading/Defines.h"
#include "OnixS/Eurex/Trading/ErrorListener.h"
#include "OnixS/Eurex/Trading/Export.h"
#include "OnixS/Eurex/Trading/HandlerSettings.h"
#include "OnixS/Eurex/Trading/HandlerStateListener.h"
#include "OnixS/Eurex/Trading/InfoListener.h"
#include "OnixS/Eurex/Trading/Logon.h"
#include "OnixS/Eurex/Trading/OrderHandlingListener.h"
#include "OnixS/Eurex/Trading/QuoteAndCrossRequestListener.h"
#include "OnixS/Eurex/Trading/QuoteHandlingListener.h"
#include "OnixS/Eurex/Trading/SRQSListener.h"
#include "OnixS/Eurex/Trading/SessionListener.h"
#include "OnixS/Eurex/Trading/StrategyCreationListener.h"
#include "OnixS/Eurex/Trading/TESListener.h"
#include "OnixS/Eurex/Trading/WarningListener.h"

#include <string>

namespace OnixS { namespace Eurex { namespace Trading {

/// Eurex ETI Trading Handler.
class ONIXS_EUREX_ETI_EXPORT 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);

    /// Finalizes the Handler.
    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 char* hostName, UInt16 port, const Logon& logon, const char* localNetworkInterface = "");

    /**
     * Establishes the connection.
     *
     * @note Blocks until the logon reply is received.
     *
     * @note Should be called only when Handler is disconnected.
     *
     * @param primaryHostName Primary hostname to connect to.
     *
     * @param primaryPort Primary port number to connect to.
     *
     * @param secondaryHostName Secondary hostname to connect to.
     *
     * @param secondaryPort Secondary 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 char* primaryHostName,
        UInt16 primaryPort,
        const char* secondaryHostName,
        UInt16 secondaryPort,
        const Logon& logon,
        const char* localNetworkInterface = ""
    );

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

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

    /// Send message
    ///
    /// \returns MsgSeqNum
    ///
    /// \throws OperationException Attempt to send data before connection creation
    /// \throws std::exception with system dependent message if sending has been failed
    UInt32 send(Message&);

    /**
     * Checks the throttling of a session that must be called before each send function call.
     *
     * If the count of messages per time unit exceeds the throttling limit,
     * the function returns the delay (in milliseconds) until the sending becomes possible.
     * Otherwise, it returns 0.
     *
     * @note This call is thread-safe.
     */
    size_t tryThrottle();

    /// 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 connection 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 registerConnectionStateListener(ConnectionStateListener* 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 registerAdminListener(AdminListener* listener);

    /// Assigns listener for strategy creation 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 registerStrategyCreationListener(StrategyCreationListener* listener);

    /// Assigns listener for order handling 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 registerOrderHandlingListener(OrderHandlingListener* listener);

    /// Assigns listener for quote and cross request 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 registerQuoteAndCrossRequestListener(QuoteAndCrossRequestListener* listener);

    /// Assigns listener for quote handling 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 registerQuoteHandlingListener(QuoteHandlingListener* listener);

    /// Assigns listener for other 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 registerInfoListener(InfoListener* listener);

    /// Assigns listener for TES 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 registerTESListener(TESListener* listener);

    /// Assigns listener for SRQS 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 registerSRQSListener(SRQSListener* 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.
    ///
    /// Date format is YYYYMMDD.
    const std::string& licenseExpirationDate() const;

    /// Encrypts the given password using the given key.
    /// \param password Password to encrypt.
    /// \param pubKeyPath Path to the RSA public key file.
    /// \returns Encrypted and Base64-encoded password.
    static std::string encryptPassword(const std::string& password, const std::string& pubKeyPath);

    /// 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_;
};
}}} // namespace OnixS::Eurex::Trading