Packet.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>
#include <vector>

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

/// Packet Type.
struct ONIXS_ICEMDH_EXPORT PacketSource
{
    /// \copydoc PacketSource
    enum Enum
    {
        /// Undefined.
        Undefined,

        /// TCP.
        TCP,

        /// UDP.
        UDP
    };

    /// Deserializes constant from string representation.
    static Enum deserialize(const char*);

    /// Returns string representation.
    static const char* toString(Enum);
};

/// Packet.
struct ONIXS_ICEMDH_EXPORT Packet
{
    /// Default constructor.
    Packet();

    /// Source of the packet.
    PacketSource::Enum source;

    /// Packet's data.
    Bytes data;

    /// Timestamp.
    Timestamp time;

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

/// Make it printable to formatted C++ I/O streams.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const Packet&);

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