MessageInfo.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/Eurex/Trading/Defines.h"
#include "OnixS/Eurex/Trading/Export.h"
#include "OnixS/Eurex/Trading/Time.h"

#include <string>

namespace OnixS { namespace Eurex { namespace Trading {

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

    /// Message sequence number used by the participant
    /// for requests sent to the gateway (MsgSeqNum (34)).
    ///
    /// Default value is UInt32NoValue.
    UInt32 msgSeqNum;

    /// Gateway request in (5979) timestamp (UTCTimestamp).
    ///
    /// Provides the time the Eurex application has read
    /// an inbound message on a gateway from the TCP socket.
    ///
    /// Default value is UInt64NoValue.
    UInt64 rawRequestTime;

    /// Gateway response out (52) timestamp (UTCTimestamp).
    ///
    /// Date and time, in UTC, represented as nanoseconds
    /// past the UNIX epoch (00:00:00 UTC on 1 January 1970).
    ///
    /// Default value is UInt64NoValue.
    UInt64 rawSendingTime;

    /// Time when the message was received by Handler (system ticks).
    ///
    /// Default value is UInt64NoValue.
    Timestamp rawReceivingTime;

    ///
    /// Gateway request in timestamp, @see Time.h
    ///
    HighResolutionTime requestTime() const;

    ///
    /// Gateway response out timestamp, @see Time.h
    ///
    HighResolutionTime sendingTime() const;

    ///
    /// Time when the message was received by Handler, @see Time.h
    ///
    HighResolutionTime receivingTime() const;

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

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

}}}