MessageInfo.h

Go to the documentation of this file.

/*
 * 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 "Time.h"

#include <string>

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

/// Message info.
struct ONIXS_ICEMDH_EXPORT MessageInfo
{
    /// Initialize default instance.
    MessageInfo();

    /// Feed identifier.
    FeedId feedId;

    /// The session number is used so that a client can easily detect when a new
    /// session has started after the daily maintenance window or failure on the
    /// server side. It should stay the same for a given multicast channel until a
    /// new session has started. It should be noted that the same number can be used
    /// by different multicast channels.
    short sessionNumber;

    /// Sequence number of message block.
    int blockSequenceNumber;

    /// Number of messages in message block.
    int numberOfMessages;

    /// Each message is assigned a sequence number that increases monotonically on the
    /// server side. To save bandwidth, the sequence number is a field in the block
    /// header, instead of every message. The sequence number for the first message is
    /// used in the header, and the client is expected to derive the sequence numbers
    /// for subsequent messages in the block. In the case of a heartbeat which includes
    /// only header in the block, the expected next sequence number is used.
    int sequenceNumber;

    /// Raw timestamp of when the message block is sent.
    ///
    /// It is the number of nanoseconds since Jan 1st, 1970, 00:00:00 GMT.
    DateTime rawSentTime;

    /// Time when the UDP packet was received by the Handler.
    ///
    /// When market data is being replayed, this member contains
    /// time of corresponding log file entry. That's the value
    /// returned represents the original time when market data
    /// message was obtained from the network.
    Timestamp receiveTime;

    /// Is message received during snapshot?
    bool isMessageReceivedDuringSnapshot;

    /// Bundle marker.
    ///
    /// This field is true if messages has been received within bundle (see BundleMarker)
    bool isBundled;

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

ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const MessageInfo&);

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