Defines.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/Euronext/MarketData/OptiqMdg/ABI.h>
#include <OnixS/Euronext/MarketData/OptiqMdg/Time.h>

#include <string>
#include <ostream>
#include <memory>
#include <set>

namespace OnixS
{
    namespace Euronext
    {
        namespace MarketData
        {
            namespace OptiqMdg
            {
                typedef char Char;

                /// Alias for Packet Sequence Number type (PSN).
                typedef UInt64 PacketSequenceNumber;

                /// Alias for Message Sequence Number type (Market Data Sequence Number, MDSN).
                typedef UInt64 MessageSequenceNumber;

                /// Data source
                struct ONIXS_EURONEXT_OPTIQMDG_API DataSource
                {
                    DataSource() {}
                    DataSource(const Timestamp& ts) : packetReceptionTime(ts) {}

                    enum Origin
                    {
                        Multicast   = 0,
                        Replay      = 1,
                        Spin        = 2
                    };

                    /// Time when the packet was received by Handler from UDP, in system ticks, @see Time.h
                    Timestamp packetReceptionTime;

                    /// Exchange sending time (number of nanoseconds since 01/01/1970 UTC).
                    UInt64 sendingTime;

                    /// Packet Sequence Number
                    PacketSequenceNumber psn;

                    /// Number of message in packet
                    UInt8 packetMessageNumber;

                    /// the way data received
                    Origin origin;

                    /// The packet was cached due to incorrect sequence
                    bool cached;

                    std::string toString () const;
                };

                ONIXS_EURONEXT_OPTIQMDG_API std::ostream& operator << (std::ostream& stream, const DataSource& ds);

                /// Zero-based index of CPU.
                typedef size_t CpuIndex;

                /// Represents set of CPU indices.
                class ONIXS_EURONEXT_OPTIQMDG_API ThreadAffinity
                {
                    typedef std::set<CpuIndex> CpuIndexes;

                public:
                    /// Initializes empty set.
                    ThreadAffinity();

                    /// Initializes as copy of other set.
                    ThreadAffinity(const ThreadAffinity&);

                    /// Utilizes all the resources.
                    ~ThreadAffinity();

                    /// Indicates whether is empty.
                    bool empty() const;

                    /// Copies set into another set.
                    void copyTo(CpuIndexes&) const;

                    /// Adds CPU index into set.
                    bool insert(CpuIndex index);

                    /// Removes CPU index from the set.
                    bool erase(CpuIndex index);

                    /// Makes set empty.
                    void clear();

                    /// Re-initializes instance as copy of other set.
                    ThreadAffinity& operator = (const ThreadAffinity&);

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

                private:

                    /// System index.
                    CpuIndexes* indices_;
                };
            }
        }
    }
}