PurgeAcknowledgement.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 <vector>

#include <OnixS/CboeCFE/Trading/BOE/ABI.h>
#include <OnixS/CboeCFE/Trading/BOE/Defines.h>
#include <OnixS/CboeCFE/Trading/BOE/Enumerations.h>
#include <OnixS/CboeCFE/Trading/BOE/BinaryMessage.h>


namespace OnixS {
namespace CboeCFE {
namespace Trading {
namespace BOE {

    /// A Purge Acknowledgment is an unsequenced message sent when a Purge Orders message requesting an order purge has completed cancelling all individual orders.
    struct ONIXS_CBOE_CFE_BOE_API PurgeAcknowledgement : public BinaryMessage
    {
        /// The time the event occurred in the CFE Matching Engine (not the time the message was sent).
        DateTime transactionTime() const
        {
            return ordinary<DateTime>(0);
        }

        /// Echoed back from the TPH message
        StrRef massCancelId() const
        {
            return fixedStr<20>(8);
        }

        /// Number of orders cancelled.
        Binary4 cancelledOrderCount() const
        {
            return ordinary<Binary4>(28);
        }

        /// The earliest timestamp, populated with nanosecond precision, recorded by CFE of the corresponding inbound message being acknowledged.
        DateTime requestReceivedTime() const
        {
            return ordinary<DateTime>(32);
        }

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

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

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

}
}
}
}