SystemEventMsg.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/eSpeed/MarketData/Itch/BinaryMessage.h>
#include <OnixS/eSpeed/MarketData/Itch/IncomingMessage.h>

ONIXS_ESPEED_ITCH_NAMESPACE_BEGIN

    /// The system event message type is used to signal a
    /// market or data feed handler event.
    struct ONIXS_ESPEED_ITCH_API SystemEventMsg : public IncomingMessage
    {
        /// Timestamp
        UInt64 timestamp() const
        {
            return ordinary<UInt64>(1);
        }

        /// Reserved
        UInt8 reserved() const
        {
            return ordinaryRef<UInt8>(9);
        }

        /// Event Code
        SystemEventCode::Enum eventCode() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<SystemEventCode>(10);
        }

        /// Event Reason
        SystemEventReason::Enum eventReason() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<SystemEventReason>(11);
        }

        /// Used to identify if the event applies to a single
        /// order book within the Trading System.
        OrderBookId orderBookId() const
        {
            return ordinary<UInt32>(12);
        }

        /// Total message size.
        static ONIXS_ESPEED_ITCH_CONST_OR_CONSTEXPR MessageSize messageSize_ = 16;

        /// Check the given size.
        static void validateSize(MessageSize size)
        {
            if (ONIXS_ESPEED_ITCH_CHECK_EXPECT((size < messageSize_), false))
                throwIncorrectSize("SystemEventMsg", size, messageSize_);
        }

        /// Initializes instance over given memory block.
        SystemEventMsg(const void* data, MessageSize size)
        ONIXS_ESPEED_ITCH_NOTHROW
            : IncomingMessage(data, size)
        {
        }
    };

    /// Serializes object into string.
    ONIXS_ESPEED_ITCH_API void toStr(std::string&, const SystemEventMsg&);

    /// Serializes object into string.
    inline std::string toStr(const SystemEventMsg& msg)
    {
        std::string str;
        toStr(str, msg);
        return str;
    }

    ///
    inline std::ostream& operator<<(std::ostream& stream, const SystemEventMsg& msg)
    {
        stream << toStr(msg);
        return stream;
    }

ONIXS_ESPEED_ITCH_NAMESPACE_END