IEngineListener.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/FIXEngine/ABI.h>
#include <OnixS/FIXEngine/Compiler.h>

namespace OnixS {
namespace FIX {
ONIXS_FIXENGINE_API_DECL(class, FlatMessage);
ONIXS_FIXENGINE_API_DECL(class, Session);

/// The warning reason.
struct EngineWarningReason {
    enum Enum {
        /// The general system-related warning.
        GeneralWarning,

        /// The first message cannot be received during the timeout.
        CannotReceiveFirstMessageDuringTimeout,

        /// A garbled message is received.
        GarbledMessageReceived,

        /// The session state cannot be changed.
        RestoreSessionStateWarning,

        /// The license expiration warning.
        LicenseExpiration
    };
};

/// The error reason.
struct EngineErrorReason {
    enum Enum {
        /// Cannot backup the file.
        BackupError,

        /// An exception was thrown during the reading of the sent message.
        ErrorWhileReadingSentMessages,

        /// The general system-related error.
        GeneralError,

        /// The internal error, please contact support@onixs.biz to investigate the issue.
        InternalError,

        /// The session state cannot be restored.
        RestoreSessionStateError,

        /// Socket options cannot be set.
        SetSocketOptionError
    };
};

/// The Engine's Listener.
class ONIXS_FIXENGINE_API IEngineListener
{
public:
    /// @note The FIX Engine does NOT manage the lifetime of this listener.
    virtual ~IEngineListener() ONIXS_FIXENGINE_DEFAULT;

    /// Called when an unknown incoming FIX connection is detected.
    ///
    /// To accept the connection, a dynamic new session may be created in scope of this callback with an appropriate
    /// TargetCompID, SenderCompID and FIX version/dialect.
    /// This dynamically created session should be logon as an acceptor otherwise the incoming connection will be rejected.
    ///
    /// If the dynamic session will not be created, the incoming FIX connection will be rejected, and the rejectReason could be specified then the Logout(5) message will be sent to the counterparty.
    ///
    /// @param[in] incomingLogon The incoming Logon message. In general it is needed to examine the content and properties of this message
    /// to create an appropriate acceptor.
    ///
    /// @param[in] listenPort The listen port.
    ///
    /// @param[in] counterpartyPort The counterparty port.
    ///
    /// @param[in] counterpartyIpAddress The counterparty IP address.
    ///
    /// @param[out] rejectReason To send the Logout message before closing the rejected connection, set the rejection description to this parameter.
    virtual void onUnknownIncomingConnection(const FlatMessage & incomingLogon, const int listenPort,
                                             const int counterpartyPort, const std::string & counterpartyIpAddress,
                                             std::string * rejectReason) = 0;

    /// Called when an incoming FIX connection is detected.
    ///
    /// If the rejectReason is set, the incoming FIX connection will be rejected, and the Logout(5) message will be sent to the counterparty.
    ///
    /// @param[in] incomingLogon The incoming Logon message.
    ///
    /// @param[in] listenPort The listen port.
    ///
    /// @param[in] counterpartyPort The counterparty port.
    ///
    /// @param[in] counterpartyIpAddress The counterparty IP address.
    ///
    /// @param[out] rejectReason To send the Logout message before closing the rejected connection, set the rejection description to this parameter.
    virtual void onIncomingConnection(ONIXS_FIXENGINE_UNUSED const FlatMessage & incomingLogon, ONIXS_FIXENGINE_UNUSED const int listenPort,
                                      ONIXS_FIXENGINE_UNUSED const int counterpartyPort, ONIXS_FIXENGINE_UNUSED const std::string & counterpartyIpAddress,
                                      ONIXS_FIXENGINE_UNUSED std::string * rejectReason) {};

    /// Called when an incoming TCP connection is detected.
    ///
    /// If the rejectReason is set, the incoming TCP connection will be rejected.
    ///
    /// @param[in] listenPort The listen port.
    ///
    /// @param[in] counterpartyPort The counterparty port.
    ///
    /// @param[in] counterpartyIpAddress The counterparty IP address.
    ///
    /// @param[out] rejectReason To send the Logout message before closing the rejected connection, set the rejection description to this parameter.
    virtual void onIncomingTelecommunicationLink(ONIXS_FIXENGINE_UNUSED const int listenPort, ONIXS_FIXENGINE_UNUSED const int counterpartyPort,
                                                 ONIXS_FIXENGINE_UNUSED const std::string & counterpartyIpAddress, ONIXS_FIXENGINE_UNUSED std::string * rejectReason) {};

    /// Called when an error is detected.
    ///
    /// @param[in] reason The error reason.
    ///
    /// @param[in] description The error description.
    virtual void onError(EngineErrorReason::Enum reason, const std::string & description) = 0;

    /// Called when a warning is detected.
    ///
    /// @param[in] reason The warning reason.
    ///
    /// @param[in] description The warning description.
    virtual void onWarning(EngineWarningReason::Enum reason, const std::string & description) = 0;
};
}
}