BundleMarker.h

Go to the documentation of this file.

/**
 * \file
 * \brief Declare `OnixS::ICE::iMpact::MarketData::BundleMarker` message structure
 */
/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "../Export.h"
#include "../Types.h"
#include "../Enumerations.h"

#include <iosfwd>
#include <string>

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// This class represents the Message Bundle Marker.
struct ONIXS_ICEMDH_EXPORT BundleMarker
{
    /// Message type constant
    enum  { messageType = 'T' };

    /// Start/End of a message bundle indicator.
    StartOrEnd::Enum startOrEnd;

    /// The value used to associate bundles of the same transaction. This
    /// value will be `0` when the transaction has no trade. The value will be
    /// `-1` if the channel does not support sub-bundling.
    long long tradeTransactionId;

    /// This field will always be set to `false` for Start of a message
    /// bundle. true - When this is the last or only bundle for a transaction.
    /// false - When this is not the last or only bundle for a transaction.
    bool isTransactionEnd;

    /// Default constructor.
    BundleMarker();

    /// Initialize from raw message data.
    BundleMarker(const char* data, size_t dataSize);

    /// Deserialize from raw data.
    void deserialize(const char* data, size_t dataSize);

    /// Reset all fields to default values.
    void reset();

    /// Returns string representation.
    std::string toString() const;
};

/// Make it printable using C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const BundleMarker&);

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS