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

#include <string>

namespace OnixS { namespace Eurex { namespace Trading { namespace AuditTrail {

/// Indicates message flow direction.
struct ONIXS_EUREX_ETI_EXPORT Direction
{
    /// \copydoc Direction
    enum Enum
    {
        NoValue, ///< No value.
        In,      ///< Received.
        Out,     ///< Sent.
    };

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

/// Collects Audit Trail file record fields.
struct ONIXS_EUREX_ETI_EXPORT Entry
{
    /// Creates empty record entry.
    Entry()
      : direction(Direction::NoValue)
    {
    }

    /// Direction.
    Direction::Enum direction;

    /// Timestamp.
    HighResolutionTimeFields timestamp;

    /// Message.
    PtrTraits<Message>::UniquePtr message;

    /// Message info.
    MessageInfo messageInfo;
};

/// A Reader reads Audit Trail files, created by Handler,
/// and decodes them into entries. Each entry contains direction
/// (In or Out), timestamp, message info and pointer to Message object.
class ONIXS_EUREX_ETI_EXPORT Reader
{
public:
    /// Creates an Reader that reads files from given directory.
    ///
    /// \param filePath full path to Audit Trail file.
    Reader(const std::string& filePath);

    /// Creates an Reader that reads files from given directory.
    ///
    /// \param directory the directory where audit trail files stored.
    /// \param fileNamePrefix template of Audit Trail file name without extension.
    ///
    /// \remarks Standard wildcard '*' can be used in fileNamePrefix argument.
    Reader(const std::string& directory, const std::string& fileNamePrefix);

    /// Releases any system resources associated with instance.
    ~Reader();

    /// Reads a single Audit Trail entry.
    ///
    /// \param entry Audit Trail record entry fields.
    bool read(Entry& entry);

private:
    Reader(const Reader&);            // no implementation
    Reader& operator=(const Reader&); // no implementation

private:
    struct Impl;
    Impl* impl_;
};

}}}} // namespace OnixS::Eurex::Trading::AuditTrail