OrderCancelMsg.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

    /// This message is sent whenever an order in the book
    /// is modified as a result of either a partial
    /// cancellation or complete cancellation.
    struct ONIXS_ESPEED_ITCH_API OrderCancelMsg : public IncomingMessage
    {
        /// Timestamp
        UInt64 timestamp() const
        {
            return ordinary<UInt64>(1);
        }

        /// The reference number of the order being reduced.
        UInt32 orderReferenceNumber() const
        {
            return ordinary<UInt32>(9);
        }

        /// Transaction ID corresponding to the transaction ID
        /// in the response message.
        UInt32 transactionId() const
        {
            return ordinary<UInt32>(13);
        }

        /// Unique Order book identifier of a UST security
        UInt32 orderBookId() const
        {
            return ordinary<UInt32>(17);
        }

        /// The type of order being added
        Side::Enum side() const
        ONIXS_ESPEED_ITCH_NOTHROW
        {
            return enumeration<Side>(21);
        }

        /// The quantity being removed from the display size
        /// as the result of a cancellation.
        Quantity canceledQuantity() const
        {
            return ordinary<UInt32>(22);
        }

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

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

        /// Initializes instance over given memory block.
        OrderCancelMsg(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 OrderCancelMsg&);

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

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

ONIXS_ESPEED_ITCH_NAMESPACE_END