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/ICE/BOE/ABI.h>
#include <OnixS/ICE/BOE/SessionStateId.h>
 
#include <OnixS/ICE/BOE/messaging/Time.h>
#include <OnixS/ICE/BOE/messaging/SbeMessage.h>
#include <OnixS/ICE/BOE/messaging/Messages.h>
 
#include <string>
 
ONIXS_ICEBOE_NAMESPACE_BEGIN
 
ONIXS_ICEBOE_API_DECL(class, Session);

struct SessionWarningReason
{
    enum Enum
    {
        GeneralWarning,

        SequenceGapIsDetected,

        UnexpectedSbeSchemaVersion,

        UnexpectedNextSeqNo,

        UnsupportedMessageType,

        MsgSeqNumOutOfRange,

        ReceiveTimeoutIsDetected,

        ExceptionInEventHandler,

        PluggableSessionStorageException,

        RestoreSessionStateWarning,

        AsyncFileBasedStorageQueueOverflow,

        LicenseExpiration,

        IncorrectResponseTimestamp,

        LinkErrorIsDetected,

        LinkErrorIsDetectedDuringSessionEstablishment,

        CannotSetSocketOption,

        CannotBackup,

        CannotRestoreSessionState,
    };
 
    ONIXS_ICEBOE_EXPORTED static const char* toString(Enum type) noexcept;
};

struct SessionErrorReason
{
    enum Enum
    {
        InternalError,

        GeneralError,

        UnexpectedMessageType,

        UnsuccessfulLogonReportInReplyOnLogonRequest,

        LogoutReportInReplyOnLogonRequest,

        ErrorInReplyOnLogonRequest,

        MsgSeqNumTooLow,

        CannotRestoreConnection,

        CannotEstablishConnection,

        ExceptionDuringProcessingOfIncomingMessage,

        DecodingError,

        KeepAliveIntervalLapsed,

        LinkErrorIsDetected,

        LinkErrorIsDetectedDuringSessionEstablishment,

        ExchangeInitiatedTerminateMessage,

        IncomingMessageGapQueueOverflow,

        PluggableSessionStorageException,

        CannotRestoreSessionState,
    };
 
    ONIXS_ICEBOE_EXPORTED static const char* toString(Enum type) noexcept;
};

struct ReceivedDataTimestamp
{
    enum Source
    {
        None,

        Software,

        Hardware
    };

    Messaging::Timestamp time_;
    Source source_;

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

class ONIXS_ICEBOE_EXPORTED SessionListener
{
public:
    virtual void onLogonReport(const Messaging::LogonReport, Session*) {}
    virtual void onLogoutReport(const Messaging::LogoutReport, Session*) {}
    virtual void onHeartBeat(const Messaging::HeartBeat, Session*) {}
    virtual void onError(const Messaging::Error, Session*) {}
    virtual void onNews(const Messaging::News, Session*) {}
    virtual void onSecurityDefinitionReport_Strategy(const Messaging::SecurityDefinitionReport_Strategy, Session*) {}
    virtual void onSecurityDefinitionReport(const Messaging::SecurityDefinitionReport, Session*) {}
    virtual void onSecurityDefinitionReject(const Messaging::SecurityDefinitionReject, Session*) {}
    virtual void onSecurityDefinitionReport_Product(const Messaging::SecurityDefinitionReport_Product, Session*) {}
    virtual void onIPReport(const Messaging::IPReport, Session*) {}
    virtual void onTraderLogonReport(const Messaging::TraderLogonReport, Session*) {}
    virtual void onTraderLogoutReport(const Messaging::TraderLogoutReport, Session*) {}
 
    virtual void onExecutionReport_New(const Messaging::ExecutionReport_New, Session*) {}
    virtual void onExecutionReport_Modify(const Messaging::ExecutionReport_Modify, Session*) {}
    virtual void onExecutionReport_Cancel(const Messaging::ExecutionReport_Cancel, Session*) {}
    virtual void onExecutionReport_Reject(const Messaging::ExecutionReport_Reject, Session*) {}
    virtual void onExecutionReport_Snapshot(const Messaging::ExecutionReport_Snapshot, Session*) {}
    virtual void onExecutionReport_Trade(const Messaging::ExecutionReport_Trade, Session*) {}
    virtual void onQuoteReport(const Messaging::QuoteReport, Session*) {}
    virtual void onNewOrderCrossReport(const Messaging::NewOrderCrossReport, Session*) {}
    virtual void onOrderMassCancelReport(const Messaging::OrderMassCancelReport, Session*) {}
    virtual void onMassQuoteReport(const Messaging::MassQuoteReport, Session*) {}
 
    virtual void onSequenceReset(const Messaging::SequenceReset, Session*) {}
    virtual void onResendReport(const Messaging::ResendReport, Session*) {}
 

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

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

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

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

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