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);

struct SessionWarningReason
{
    enum Enum
    {
        GeneralWarning,

        SequenceGapIsDetected,

        SequenceWithKeepAliveLapsed,

        UnexpectedSbeSchemaVersion,

        UnexpectedPreviousUuid,

        UnexpectedNextSeqNo,

        UnsupportedMessageType,

        MsgSeqNumOutOfRange,

        UnexpectedUuId,

        ReceiveTimeoutIsDetected,

        ExceptionInEventHandler,

        PluggableSessionStorageException,

        RestoreSessionStateWarning,

        AsyncFileBasedStorageQueueOverflow,

        LicenseExpiration,

        IncorrectResponseTimestamp,

        RetransmitReject,

        LinkErrorIsDetected,

        LinkErrorIsDetectedDuringSessionEstablishment,

        CannotSetSocketOption,

        CannotBackup,

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

struct SessionErrorReason
{
    enum Enum
    {
        InternalError,

        GeneralError,

        UnexpectedMessageType,

        NegotiationReject,

        EstablishmentReject,

        TerminateInReplyOnEstablish,

        MsgSeqNumTooLow,

        CannotRestoreConnection,

        CannotEstablishConnection,

        ExceptionDuringProcessingOfIncomingMessage,

        DecodingError,

        KeepAliveIntervalLapsed,

        LinkErrorIsDetected,

        LinkErrorIsDetectedDuringSessionEstablishment,

        ExchangeInitiatedTerminateMessage,

        IncomingMessageGapQueueOverflow,

        PluggableSessionStorageException,

        UnexpectedUuid,

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

struct NotAppliedAction
{
    enum Enum
    {
        DoNothing,

        SendGapFill,

        Default = DoNothing
    };
};

struct ReceivedDataTimestamp
{
    enum Source
    {
        None,

        Software,

        Hardware
    };

    Messaging::Timestamp time_;
    Source source_;

    ONIXS_ILINK3_EXPORTED std::string toString() const;
};
 

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*/) {}

    virtual void onReceivedBytes(const char * /*bytes*/, size_t /*size*/, const ReceivedDataTimestamp& /*timestamp*/, Session * /*sn*/) {}

    virtual void onMessageSending(char * /*bytes*/, size_t /*size*/, Session * /*sn*/) {}

    virtual void onStateChange(SessionStateId::Enum /*newState*/, SessionStateId::Enum /*prevState*/, Session * /*sn*/) {}

    virtual void onError(SessionErrorReason::Enum /*reason*/, const std::string & /*description*/, Session * /*sn*/, Messaging::SbeMessage) {}

    virtual void onWarning(SessionWarningReason::Enum /*reason*/, const std::string & /*description*/, Session * /*sn*/, Messaging::SbeMessage) {}
 
protected:
    virtual ~SessionListener() = 0;
};
 
}
}
}