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/Eurex/Trading/Defines.h"
#include "OnixS/Eurex/Trading/Export.h"
#include "OnixS/Eurex/Trading/Message.h"

#include <cstddef>

namespace OnixS { namespace Eurex { namespace Trading {

/// Session Listener.
class ONIXS_EUREX_ETI_EXPORT SessionListener
{
public:
    /// Implement this member to get notifications immediately before message sending.
    ///
    /// \note This callback is called just before writing message data to a socket
    /// and immediately after throttling delay (if throttling is needed).
    ///
    /// \param msgSeqNum Message sequence number.
    /// \param message Message.
    virtual void onMessageSending(UInt32 msgSeqNum, const Message& message);

    /// Implement this member to get notifications as soon as bytes are received from the wire.
    ///
    /// \param bytes Bytes to be sent.
    /// \param size Total number of bytes.
    virtual void onReceivedBytes(const char* bytes, size_t size);

    /// Implement this member to get notifications about throttling settings.
    ///
    /// \param throttleTimeInterval Throttle time interval in number of milliseconds; applicable for
    /// transaction limit. \param throttleNoMsgs Transaction limit per ThrottleTimeInterval. \param
    /// throttleDisconnectLimit Disconnect limit - maximum number of sequential message rejects
    /// allowed by the Eurex ETI.
    virtual void
    onThrottleSettingsChanged(UInt64 throttleTimeInterval, UInt32 throttleNoMsgs, UInt32 throttleDisconnectLimit);

    /// Implement this member to get notifications about throttling start.
    ///
    /// \param delayInMilliseconds Throttle delay in milliseconds.
    virtual void onThrottleDelayStarted(UInt32 delayInMilliseconds);

    /// Implement this member to get notifications about throttling finish.
    virtual void onThrottleDelayFinished();

protected:
    /// Disables public <b>delete</b> operator in the interface class.
    virtual ~SessionListener();
};

inline void SessionListener::onMessageSending(UInt32, const Message&) {}

inline void SessionListener::onReceivedBytes(const char*, size_t) {}

inline void SessionListener::onThrottleSettingsChanged(UInt64, UInt32, UInt32) {}

inline void SessionListener::onThrottleDelayStarted(UInt32) {}

inline void SessionListener::onThrottleDelayFinished() {}

inline SessionListener::~SessionListener() {}

}}}