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

/// The error reason.
struct ErrorReason {
    enum Enum {
        /// The general system-related error.
        GeneralError,

        /// The first message received is not a Logon message.
        FirstMessageNotALogon,

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

        /// The FIX Connection cannot be restored.
        CannotRestoreConnection,

        /// An exception was thrown during processing of the incoming message.
        ExceptionDuringProcessingOfIncomingMessage,

        /// The FIX message received is not valid.
        InvalidIncomingMessage,

        /// An exception was thrown in the client event handler implementation.
        ExceptionInEventHandler,

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

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

        /// A garbled message is received.
        GarbledMessageReceived,

        /// The telecommunication link error is detected.
        LinkError,

        /// The sequence gap in the incoming messages is detected.
        SeqGapIsDetected,

        /// The ResendTimeout is elapsed.
        ResendTimeout,

        /// Cannot re-establish the FIX Connection after the reconnect attempt.
        CannotConnect
    };
};

/// Represents a timestamp of the received data.
/// If the source is `None`, no timestamp is available.
class ONIXS_FIXENGINE_API ReceivedDataTimestamp
{
public:

    enum Source
    {
        /// No timestamp available.
        None,

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

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

    ReceivedDataTimestamp():timestamp_(), source_(Source::None) { }

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

    /// Returns the received data timestamp.
    const Timestamp & timestamp() const
    {
        return timestamp_;
    }

    /// Returns the source of the received data timestamp.
    Source source() const
    {
        return source_;
    }

    /// Returns a human-readable presentation.
    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:

    /// The timestamp.
    Timestamp timestamp_;
    Source source_;
};

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

    /// Is called when the message mode is `Message` and the application-level message is received from the counterparty.
    ///
    /// @note: do no call the base method if you have overridden it in the derived class.
    virtual void onInboundApplicationMsg(Message & message, Session * session) = 0;

    /// Is called when the message mode is `FlatMessage` and the application-level message is received from the counterparty.
    ///
    /// @note: do no call the base method if you have overridden it in the derived class.
    virtual void onInboundApplicationMsg(FlatMessage&, Session*) {}

    /// Is called when the message mode is `Message` and the session-level message is received from the counterparty.
    /// @note: do no call the base method if you have overridden it in the derived class.
    virtual void onInboundSessionMsg(Message & /*message*/, Session * /*session*/) {}

    /// Is called when the message mode is `FlatMessage` and the session-level message is received from the counterparty.
    /// @note: do no call the base method if you have overridden it in the derived class.
    virtual void onInboundSessionMsg(FlatMessage & /*message*/, Session * /*session*/) {}

    /// Is called when the application-level message is sent to the counterparty.
    ///
    /// @note: do no call the base method if you have overridden it in the derived class.
    /// @note: The message's sequence number is the preliminary one.
    ///
    /// @warning: It is called under the session's lock.
    virtual void onOutboundApplicationMsg(Message & /*message*/, Session * /*session*/) {}

    /// Is called when the session-level message is sent to the counterparty.
    ///
    /// @note: do no call the base method if you have overridden it in the derived class.
    /// @note: The message's sequence number is the preliminary one.
    ///
    /// @warning: It is called under the session's lock.
    virtual void onOutboundSessionMsg(Message & /*message*/, Session * /*session*/) {}

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

    /// Is called just before the FIX message is sent to the wire.
    ///
    /// @warning: It is called under the session's lock.
    virtual void onMessageSending(SequenceNumber /*msgSeqNum*/, char * /*bytes*/, size_t /*size*/, Session * /*session*/) {}

    /// Is called when the session changes its state.
    virtual void onStateChange(SessionState::Enum /*newState*/, SessionState::Enum /*prevState*/, Session * /*session*/) {}

    /// Is called when the message mode is `Message` and the sent application-level message is about to be
    /// re-sent to the counterparty in reply to the ResendRequest<2> message.
    ///
    /// @return `true` if the message should be re-sent, otherwise - `false`.
    virtual bool onResendRequest(Message & /*message*/, Session * /*session*/) { return false; }

    /// Is called when the message mode is `FlatMessage` and the sent application-level message is about to be
    /// re-sent to the counterparty in reply to the ResendRequest<2> message.
    ///
    /// @return `true` if the message should be re-sent, otherwise - `false`.
    virtual bool onResendRequest(FlatMessage & /*message*/, Session * /*session*/) { return false; }

    /// Is called when the ResendRequest<2> message is received and the session is about to start to resend messages.
    virtual void onResendingStarted(SequenceNumber /*beginSeqNo*/, SequenceNumber /*endSeqNo*/, Session* /*session*/) {}

    /// Is called when the resending process is completed.
    virtual void onResendingFinished(SequenceNumber /*beginSeqNo*/, SequenceNumber /*endSeqNo*/, Session* /*session*/) {}

    /// Is called when an error condition is detected.
    virtual void onError(ErrorReason::Enum /*reason*/, const std::string & /*description*/, Session * /*session*/) {}

    /// Is called when a warning condition is detected.
    virtual void onWarning(WarningReason::Enum /*reason*/, const std::string & /*description*/, Session * /*session*/) {}
};
}
}