ISessionListener.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/Compiler.h>
#include <OnixS/FIXEngine/FIX/SequenceNumber.h>
#include <OnixS/FIXEngine/FIX/SessionState.h>
#include <OnixS/FIXEngine/FIX/Timestamp.h>
 
namespace OnixS {
namespace FIX {
ONIXS_FIXENGINE_API_DECL(class, Message);
ONIXS_FIXENGINE_API_DECL(class, FlatMessage);
ONIXS_FIXENGINE_API_DECL(class, Session);

struct ErrorReason {
    enum Enum {
        GeneralError,

        FirstMessageNotALogon,

        MsgSeqNumTooLow,

        CannotRestoreConnection,

        ExceptionDuringProcessingOfIncomingMessage,

        InvalidIncomingMessage,

        ExceptionInEventHandler,

        SetSocketOptionError
    };
};

struct WarningReason {
    enum Enum {
        GeneralWarning,

        GarbledMessageReceived,

        LinkError,

        SeqGapIsDetected,

        ResendTimeout,

        CannotConnect
    };
};

class ONIXS_FIXENGINE_API ReceivedDataTimestamp
{
public:
 
    enum Source
    {
        None,

        Software,

        Hardware
    };
 
    ReceivedDataTimestamp():timestamp_(), source_(Source::None) { }
 
    ReceivedDataTimestamp(const Timestamp & timestamp, Source source):timestamp_(timestamp), source_(source) { }

    const Timestamp & timestamp() const
    {
        return timestamp_;
    }

    Source source() const
    {
        return source_;
    }

    std::string toString() const
    {
        const std::string TimeStr = timestamp_.toString();
        std::string str = "ReceivedDataTimestamp [source = ";
 
        if(source_ == ReceivedDataTimestamp::None)
            str += "None";
        else if(source_ == ReceivedDataTimestamp::Software)
            str += "Software, time = " + TimeStr;
        else if (source_ == ReceivedDataTimestamp::Hardware)
            str += "Hardware, time = " + TimeStr;
        else
            str += "Unknown";
 
        str += "]";
        return str;
    }
 
private:

    Timestamp timestamp_;
    Source source_;
};

class ONIXS_FIXENGINE_API ISessionListener
{
public:
    virtual ~ISessionListener() ONIXS_FIXENGINE_DEFAULT;

    virtual void onInboundApplicationMsg(Message & message, Session * session) = 0;

    virtual void onInboundApplicationMsg(FlatMessage&, Session*) {}

    virtual void onInboundSessionMsg(Message & /*message*/, Session * /*session*/) {}

    virtual void onInboundSessionMsg(FlatMessage & /*message*/, Session * /*session*/) {}

    virtual void onOutboundApplicationMsg(Message & /*message*/, Session * /*session*/) {}

    virtual void onOutboundSessionMsg(Message & /*message*/, Session * /*session*/) {}

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

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

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

    virtual bool onResendRequest(Message & /*message*/, Session * /*session*/) { return false; }

    virtual bool onResendRequest(FlatMessage & /*message*/, Session * /*session*/) { return false; }

    virtual void onResendingStarted(SequenceNumber /*beginSeqNo*/, SequenceNumber /*endSeqNo*/, Session* /*session*/) {}

    virtual void onResendingFinished(SequenceNumber /*beginSeqNo*/, SequenceNumber /*endSeqNo*/, Session* /*session*/) {}

    virtual void onError(ErrorReason::Enum /*reason*/, const std::string & /*description*/, Session * /*session*/) {}

    virtual void onWarning(WarningReason::Enum /*reason*/, const std::string & /*description*/, Session * /*session*/) {}
};
}
}