Message.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 <ostream>
#include <string>

#include <OnixS/Eurex/MarketData/FieldSet.h>
#include <OnixS/Eurex/MarketData/MessageStringingFlags.h>
#include <OnixS/Eurex/MarketData/SequenceNumber.h>


namespace OnixS
{
    class AccumulatingAllocator;

    namespace FIX
    {
        namespace Core
        {
            namespace Messaging
            {
                class Message;
            }
        }
    }

    namespace Eurex
    {
        namespace MarketData
        {

            /// Encapsulates operations over a FIX Message.
            ///
            /// Message supports 'unconstructed' state which can be
            /// treated as pointer in null state. However, in contrast to
            /// OnixS::FIX::Group and OnixS::FIX::GroupInstance classes it
            /// does NOT represent light-weight wrapper over internal structures.
            /// In fact, it holds all the data which is fully copied on assignment
            /// or copy construction and disposed at instance destruction.
            ///
            /// FIX field related operations now available via OnixS::FIX::FieldSet
            /// class from which OnixS::FIX::Message class is now derived.
            class
                ONIXS_EUREX_EMDI_API
                Message : public FieldSet
            {
                public:
                    /// Initializes instance as deep copy of other one.
                    ///
                    /// @param other Message to be copied from.
                    Message (const Message& other);

                    /// Disposes all internal data structures.
                    ///
                    /// @warning Once instance is destructed, all instances of
                    /// OnixS::FIX::Group and OnixS::FIX::GroupInstance classes
                    /// obtained from this instance must not be used any more.
                    ~Message();

                    /// Returns the message type (MsgType(35) field value).
                    FieldValueRef type() const;

                    /// Returns the message sequence number
                    /// (the MsgSeqNum (tag=34) field value).
                    SequenceNumber seqNum() const;

                    /// Returns the assigned value used to identify
                    /// firm sending message (SenderCompID (49) field value).
                    FieldValueRef senderCompId() const;

                    /// Compares two messages. Comparison is performed
                    /// using 'tag=value' message presentations.
                    bool operator == (const Message&) const;

                    /// Compares two messages. Comparison is performed
                    /// using 'tag=value' message presentations.
                    bool operator != (const Message&) const;

                    /// Returns the string representation of the message using
                    /// the given delimiter and additional control flags.
                    ///
                    /// @param delimiter Defines field delimiter to be used.
                    /// @param flags Affect how message presentation looks like.
                    std::string
                    toString (
                        char delimiter = 0x1,
                        MessageStringingFlags flags =
                            MessageStringingFlag::IncludeFieldTagNumber) const;

                    /// Returns the string representation of the message with field names using
                    /// 0x1 delimiter.
                    std::string
                    toStringWithFieldNames () const
                    {
                        return toString (0x1, MessageStringingFlag::IncludeFieldName);
                    }

                    /// Appends string representation of the message using
                    /// the given delimiter and additional control flags.
                    ///
                    /// @param str String to which presentation is appended.
                    /// @param delimiter Defines field delimiter to be used.
                    /// @param flags Affect how message presentation looks like.
                    void
                    toString (
                        std::string& str,
                        char delimiter = 0x1,
                        MessageStringingFlags flags =
                            MessageStringingFlag::IncludeFieldTagNumber) const;



                    // Reassigns message as copy of other one.
                    Message& operator = (const Message&);

                private:
                    friend class MessageOperator;

                    friend class ProductSnapshot;
                    friend class InstrumentSnapshot;
                    friend class InstrumentIncremental;
                    friend class VarianceFuturesStatus;
                    friend class TotalReturnFuturesStatus;
                    friend class TradeAtReferencePriceStatus;

                    friend class DepthSnapshot;
                    friend class DepthIncremental;
                    friend class ProductStateChange;
                    friend class MassInstrumentStateChange;
                    friend class InstrumentStateChange;
                    friend class QuoteRequest;
                    friend class CrossRequest;
                    friend class ComplexInstrumentUpdate;
                    friend class FlexibleInstrumentUpdate;
                    friend class ScaledSimpleInstrumentUpdate;

                    friend class OpenInterest;
                    friend class Settlement;
                    friend class ExchangeTrade;

                    friend class TopOfBookImplied;

                    Message (const void*);

                private:
                    AccumulatingAllocator* allocator_;
                    FIX::Core::Messaging::Message* message_;

                    unsigned char impl_[6 * sizeof (size_t)];
                    unsigned char allocatorImpl_[4 * sizeof (size_t)];

                    void construct();
                    void destruct();
            };

            inline
            std::string
            Message::toString (
                char delimiter,
                MessageStringingFlags flags) const
            {
                std::string str;

                toString (str, delimiter, flags);

                return str;
            }

            // Outputs message into standard stream.
            ONIXS_EUREX_EMDI_API
            std::ostream&
            operator << (
                std::ostream& os,
                const Message& message);
        }
    }
}