GenericMediumPriorityMessage.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/Senaf/MarketData/Enumerations.h>
#include <OnixS/Senaf/MarketData/Export.h>
#include <OnixS/Senaf/MarketData/Optional.h>

#include <iosfwd>
#include <string>

namespace OnixS { namespace Senaf { namespace MarketData {

/// Generic Medium Priority Message.
struct ONIXS_BME_SENAF_EXPORT GenericMediumPriorityMessage
{
    /// Message code.
    enum
    {
        code = 101
    };

    /// Default constructor.
    GenericMediumPriorityMessage();

    /// Market.
    ///
    /// \note If Market = 0, the message is market independent.
    unsigned char market;

    /// Instrument Type. Tabulated for each market.
    InstrumentType::Enum instrumentType;

    /// Reference.
    ///
    /// \note If Reference = 0, the message is reference independent.
    unsigned short reference;

    /// Source.
    ///
    /// \note If Source = 3, is a text message coming from Senaf Market
    /// Supervision. This message will be shown in a Senaf Terminal “pop up”.
    unsigned char source;

    /// Recipient of the message. Server, Terminal, API, F-E,…
    unsigned char recipient;

    /// Member.
    ///
    /// \note If Member = 0, the message is for all members.
    unsigned char member;

    /// Session.
    ///
    /// If Session = 0, the message is for all the sessions of a member.
    unsigned char session;

    /// User.
    unsigned char user;

    /// Subtype.
    unsigned char subtype;

    /// General information data.
    struct Subtype001
    {
        /// Constructor.
        ///
        /// \param inMessage Message.
        Subtype001(const std::string& inMessage)
          : message(inMessage)
        {
        }

        /// Text message.
        std::string message;
    };

    /// Text message. General information data.
    Optional<Subtype001> subtype001;

    /// Information message for panic cancellation notification.
    struct Subtype002
    {
        /// Constructor.
        ///
        /// \param inMember Member.
        /// \param inSource Source
        /// \param inUser User.
        Subtype002(unsigned char inMember, unsigned char inSource, unsigned char inUser)
          : member(inMember)
          , source(inSource)
          , user(inUser)
        {
        }

        /// Member.
        unsigned char member;

        /// Source (Broker, Member or Senaf).
        unsigned char source;

        /// User.
        unsigned char user;
    };

    /// This message will be sent to all involved each time a panic
    /// cancellation is requested from a client, broker or Senaf.
    Optional<Subtype002> subtype002;

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

private:
    friend class MessageDeserializer;
    GenericMediumPriorityMessage(const char* data, size_t dataSize);
    void deserialize(const char* data, size_t dataSize);
    void reset();
};

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

}}} // namespace OnixS::Senaf::MarketData