SessionListener.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/CME/iLink3/ABI.h>
#include <OnixS/CME/iLink3/Messaging.h>
#include <OnixS/CME/iLink3/SessionStateId.h>

#include <string>

namespace OnixS {
namespace CME {
namespace iLink3 {

ONIXS_ILINK3_API_DECL(class, Session);

/**
 * Session Warning Reason.
 */
struct SessionWarningReason
{
    enum Enum
    {
        /// General session-related warning.
        GeneralWarning,

        /// Incoming message sequence gap is detected.
        SequenceGapIsDetected,

        /// Received the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Sequence">Sequence</a> message with
        /// the `Lapsed` value of the `KeepAliveIntervalLapsed` field.
        SequenceWithKeepAliveLapsed,

        /// Unexpected SBE Schema version is received from CME.
        UnexpectedSbeSchemaVersion,

        /// The value of the `PreviousUUID` field in the received
        /// <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Establishment+Acknowledgment">Establishment Acknowledgment</a>
        /// message does not match to the local value.
        UnexpectedPreviousUuid,

        /// Received an unexpected `NextSeqNo` value.
        UnexpectedNextSeqNo,

        /// Received an unsupported message type.
        UnsupportedMessageType,

        /// The incoming message has a sequence number is out of the expected  range and the <i>PossRetransFlag</i> is
        /// set, it indicates a warning. It is strongly recommended that the session be terminated and manual intervention
        /// be initiated.
        MsgSeqNumOutOfRange,

        /// Received a message with an unexpected uuid
        UnexpectedUuId,

        /// Raised when the `KeepAliveInterval` has expired and no keep alive message is received.
        ReceiveTimeoutIsDetected,

        /// Exception was thrown from user's event handler.
        ExceptionInEventHandler,

        /// An exception is thrown from the user-provided Session Storage
        PluggableSessionStorageException,

        /// Session state cannot be restored.
        RestoreSessionStateWarning,

        /// Raised when the AsyncFileBasedStorage queue exceeded `SessionSettings::asyncFileBasedStorageQueueMaxSize`
        AsyncFileBasedStorageQueueOverflow,

        /// Raised when the license will expire in less than `SessionSettings::licenseAlertingDaysBeforeExpiration`
        LicenseExpiration,

        /// A response message with unexpected `requestTimestamp` field value is received
        IncorrectResponseTimestamp,

        /// The <i>Retransmit Reject</i> message is received in reply to the <i>Retransmit Request</i> message.
        RetransmitReject,

        /// Telecommunication link error is detected.
        LinkErrorIsDetected,

        /// After sending the initial Negotiate or Establish message the telecommunication link error is detected.
        LinkErrorIsDetectedDuringSessionEstablishment,

        /// Error setting socket option
        CannotSetSocketOption,

        /// Cannot backup the file.
        CannotBackup,

        /// Session state cannot be restored.
        CannotRestoreSessionState,
    };

    ONIXS_ILINK3_EXPORTED static const char* toString(Enum type) ONIXS_ILINK3_NOTHROW;
};

/**
 * Session Error Reason.
 */
struct SessionErrorReason
{
    enum Enum
    {
        /// Internal error
        InternalError,

        /// A general session-related error.
        GeneralError,

        /// First message received is not the <i>NegotiationResponse</i> or <i>EstablishmentAck</i> message.
        UnexpectedMessageType,

        /// The <i>Negotiation Reject</i> message is received in reply to the <i>Negotiation</i> message.
        NegotiationReject,

        /// The <i>Establishment Reject</i> message is received in reply to the <i>Establish</i> message.
        EstablishmentReject,

        /// The <i>Terminate</i> message is received in reply to the <i>Establish</i> message.
        TerminateInReplyOnEstablish,

        /// The incoming message has a sequence number less than expected and the <i>PossRetransFlag</i> is not
        /// set, it indicates a serious error.
        /// The incoming message has a sequence number less than expected and the <i>PossRetransFlag</i> is not set, it
        /// indicates a serious error. It is strongly recommended that the session be terminated and manual intervention
        /// be initiated.
        MsgSeqNumTooLow,

        /// Connection cannot be restored.
        CannotRestoreConnection,

        /// Connection cannot be established.
        CannotEstablishConnection,

        /// Exception during processing of an incoming message.
        ExceptionDuringProcessingOfIncomingMessage,

        /// Received an invalid incoming message.
        DecodingError,

        /// When two times the `KeepAliveInterval` has expired and no keep alive
        /// message is received then the session is terminated ungracefully and will need to be re-established.
        KeepAliveIntervalLapsed,

        /// Telecommunication link error is detected.
        LinkErrorIsDetected,

        /// After sending the initial Negotiate or Establish message the telecommunication link error is detected.
        LinkErrorIsDetectedDuringSessionEstablishment,

        /// The Exchange sent the initial Terminate message.
        ExchangeInitiatedTerminateMessage,

        /// The maximum size of the incoming message gap queue is exceeded.
        IncomingMessageGapQueueOverflow,

        /// An exception is thrown from the user-provided Session Storage
        PluggableSessionStorageException,

        /// A message with unexpected UUID is received.
        UnexpectedUuid,

        /// Session state cannot be restored.
        CannotRestoreSessionState,
    };

    ONIXS_ILINK3_EXPORTED static const char* toString(Enum type) ONIXS_ILINK3_NOTHROW;
};

/// Action to be taken when the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Not+Applied">NotApplied message</a> is received from the exchange.
struct NotAppliedAction
{
    /// Action to be taken when the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Not+Applied">NotApplied message</a> is received from the exchange.
    enum Enum
    {
        /// No messages are sent in reply.
        DoNothing,

        /// Send the <a href="https://www.cmegroup.com/confluence/display/EPICSANDBOX/Sequence">Sequence</a> message.
        SendGapFill,

        /// The default action.
        Default = DoNothing
    };
};

/// Represents a timestamp of the received data.
/// If the source is `None`, no timestamp is available.
struct ReceivedDataTimestamp
{
    enum Source
    {
        /// No timestamp available.
        None,

        /// Timestamp provided by the OS kernel / user-level network stack.
        Software,

        /// Timestamp provided by the network card.
        Hardware
    };

    /// The timestamp.
    Messaging::Timestamp time_;
    Source source_;

    /// \return a human-readable presentation.
    ONIXS_ILINK3_EXPORTED std::string toString() const;
};


/// Session's Listener.
class ONIXS_ILINK3_EXPORTED SessionListener
{
public:
    virtual void onNegotiationResponse(const Messaging::NegotiationResponse501 & /*msg*/, Session * /*sn*/) {}
    virtual void onNegotiationReject(const Messaging::NegotiationReject502 & /*msg*/, Session * /*sn*/) {}
    virtual void onEstablishmentAck(const Messaging::EstablishmentAck504 & /*msg*/, Session * /*sn*/) {}
    virtual void onEstablishmentReject(const Messaging::EstablishmentReject505 & /*msg*/, Session * /*sn*/) {}
    virtual void onSequence(const Messaging::Sequence506 & /*msg*/, Session * /*sn*/) {}
    virtual void onTerminate(const Messaging::Terminate507 & /*msg*/, Session * /*sn*/) {}
    virtual void onRetransmitReject(const Messaging::RetransmitReject510 & /*msg*/, Session * /*sn*/) {}
    virtual void onRetransmission(const Messaging::Retransmission509 & /*msg*/, Session * /*sn*/) {}
    virtual void onFailover(Messaging::FTI::Enum /*faultToleranceIndicator*/, Session * /*sn*/) {}

    virtual NotAppliedAction::Enum onNotApplied(const Messaging::NotApplied513 & /*msg*/, Session* /*sn*/) {
        return NotAppliedAction::Default;
    }

    virtual void onBusinessReject(const Messaging::BusinessReject521 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportNew(const Messaging::ExecutionReportNew522 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportModify(const Messaging::ExecutionReportModify531 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportCancel(const Messaging::ExecutionReportCancel534 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportStatus(const Messaging::ExecutionReportStatus532 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeOutright(const Messaging::ExecutionReportTradeOutright525 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeSpread(const Messaging::ExecutionReportTradeSpread526 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeSpreadLeg(const Messaging::ExecutionReportTradeSpreadLeg527 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportElimination(const Messaging::ExecutionReportElimination524 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportReject(const Messaging::ExecutionReportReject523 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeAddendumOutright(const Messaging::ExecutionReportTradeAddendumOutright548 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeAddendumSpread(const Messaging::ExecutionReportTradeAddendumSpread549 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportTradeAddendumSpreadLeg(const Messaging::ExecutionReportTradeAddendumSpreadLeg550 & /*msg*/, Session * /*sn*/) {}
    virtual void onOrderCancelReject(const Messaging::OrderCancelReject535 & /*msg*/, Session * /*sn*/) {}
    virtual void onOrderCancelReplaceReject(const Messaging::OrderCancelReplaceReject536 & /*msg*/, Session * /*sn*/) {}
    virtual void onSecurityDefinitionResponse(const Messaging::SecurityDefinitionResponse561 & /*msg*/, Session * /*sn*/) {}
    virtual void onMassQuoteAck(const Messaging::MassQuoteAck545 & /*msg*/, Session * /*sn*/) {}
    virtual void onRequestForQuoteAck(const Messaging::RequestForQuoteAck546 & /*msg*/, Session * /*sn*/) {}
    virtual void onQuoteCancelAck(const Messaging::QuoteCancelAck563& /*msg*/, Session* /*sn*/) {}
    virtual void onOrderMassActionReport(const Messaging::OrderMassActionReport562& /*msg*/, Session* /*sn*/) {}
    virtual void onPartyDetailsDefinitionRequestAck(const Messaging::PartyDetailsDefinitionRequestAck519 & /*msg*/, Session * /*sn*/) {}
    virtual void onPartyDetailsListReport(const Messaging::PartyDetailsListReport538 & /*msg*/, Session * /*sn*/) {}
    virtual void onExecutionReportPendingCancel(const Messaging::ExecutionReportPendingCancel564& /*msg*/, Session* /*sn*/) {}
    virtual void onExecutionReportPendingReplace(const Messaging::ExecutionReportPendingReplace565& /*msg*/, Session* /*sn*/) {}

    /// Called as soon as bytes are received from the wire.
    virtual void onReceivedBytes(const char * /*bytes*/, size_t /*size*/, const ReceivedDataTimestamp& /*timestamp*/, Session * /*sn*/) {}

    /// Called when the SBE message is about to be sent to the wire.
    virtual void onMessageSending(char * /*bytes*/, size_t /*size*/, Session * /*sn*/) {}

    /// Called when the session changes its state.
    virtual void onStateChange(SessionStateId::Enum /*newState*/, SessionStateId::Enum /*prevState*/, Session * /*sn*/) {}

    /// Called when an error condition is detected.
    /// \note the message argument provided is a message which caused the problem, must be checked to be valid before usage
    virtual void onError(SessionErrorReason::Enum /*reason*/, const std::string & /*description*/, Session * /*sn*/, Messaging::SbeMessage) {}

    /// Called when a warning condition is detected.
    /// \note the message argument provided is a message which caused the problem, must be checked to be valid before usage
    virtual void onWarning(SessionWarningReason::Enum /*reason*/, const std::string & /*description*/, Session * /*sn*/, Messaging::SbeMessage) {}

protected:
    virtual ~SessionListener() = 0;
};

}
}
}