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 <string>

#include <OnixS/CboeCFE/Trading/BOE/ABI.h>
#include <OnixS/CboeCFE/Trading/BOE/Integral.h>
#include <OnixS/CboeCFE/Trading/BOE/HandlerStateListener.h>
#include <OnixS/CboeCFE/Trading/BOE/LogSettings.h>
#include <OnixS/CboeCFE/Trading/BOE/Defines.h>


namespace OnixS {
namespace CboeCFE {
namespace Trading {
namespace BOE {

ONIXS_CBOE_CFE_BOE_API_DECL(struct, OutgoingMessage);
ONIXS_CBOE_CFE_BOE_API_DECL(class, ErrorListener);
ONIXS_CBOE_CFE_BOE_API_DECL(class, WarningListener);
ONIXS_CBOE_CFE_BOE_API_DECL(class, MessageListener);
ONIXS_CBOE_CFE_BOE_API_DECL(class, SessionListener);
ONIXS_CBOE_CFE_BOE_API_DECL(class, ReplayListener);
ONIXS_CBOE_CFE_BOE_API_DECL(struct, HandlerSettings);
ONIXS_CBOE_CFE_BOE_API_DECL(struct, LogonSettings);
ONIXS_CBOE_CFE_BOE_API_DECL(class, HandlerStateListener);

///
typedef std::pair<Port, Port> PortRange;

/// OnixS CBOE CFE Binary Order Entry (BOE) Handler
///
class ONIXS_CBOE_CFE_BOE_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.
    explicit 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 logonSettings Initial logon message parameters.
    ///
    /// @param hostName Hostname to connect to.
    ///
    /// @param port Port number to connect to.
    ///
    /// @param localNetworkInterface Local network interface.
    ///
    /// @param localPortRange Range to choose local port from.
    ///
    /// @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 LogonSettings& logonSettings,
                  const std::string& hostName,
                  Port port,
                  const std::string& localNetworkInterface = "", const PortRange& localPortRange = PortRange(0,0));

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

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

    /// \return the local network port number.
    Port localPort();

    /// 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 message 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 registerMessageListener(MessageListener* listener);

    /// Assigns listener for message 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 registerReplayListener(ReplayListener* listener);
    
    ///// Sends outgoing message 
    /////
    ///// @throws OperationException Attempt to send data before connection creation
    ///// @throws std::exception with system dependent message if requesting has been failed
    UInt32 send(const OutgoingMessage&);

    ///// Warms outgoing messageup
    /////
    ///// @throws OperationException Attempt to send data before connection creation
    ///// @throws std::exception with system dependent message if requesting has been failed
    ///// @param warmupFlags Specific flags which can be used to turn on the warmup feature for a specific NIC.
    void warmup(OutgoingMessage&, int warmupFlags = 0);

    /// Sets the next sequence number for sending messages
    void nextSendingSeqNum(SeqNumber value);

    /// Gets the next sequence number for sending messages
    SeqNumber nextSendingSeqNum();

    /// 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_;
};
}
}
}
}