FeedEngineSettings.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 "ThreadAffinity.h"

#include <iosfwd>
#include <string>

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

/// Collection of settings affecting Feed Engine behavior.
class ONIXS_ICEMDH_EXPORT FeedEngineSettings
{
public:
    /// Initializes options with default values.
    FeedEngineSettings();

    /// Defines set of CPUs allowed for each working thread
    /// to be executed on while processing market data by Handlers
    /// binded to Feed Engine instance which is configured by given
    /// settings.
    ///
    /// \note By default set is empty thus allowing threads
    /// to be executed on any CPU available in the system.
    ThreadAffinity threadAffinity;

    /// Number of working threads to be used by feed engine.
    ///
    /// \note Default value is '1'.
    unsigned int threadCount;

    /// Defines amount of time Feed Engine spends on socket
    /// waiting for I/O while running master processing loop.
    ///
    /// Time is measured in milliseconds.
    ///
    /// \note Default value is '10'.
    ///
    /// \warning Given parameter significantly affects the
    /// Handler's responsiveness and load onto CPU!
    unsigned int dataWaitTime;

    /// Defines amount of time Feed Engine keeps cycling before
    /// going to sleep when no useful activity can be done.
    ///
    /// Time is measured in milliseconds.
    ///
    /// \note Default value is '1'.
    ///
    /// \warning Given parameter has direct influence onto CPU load!
    unsigned int spinBeforeIdleTime;

    /// Defines size of receiving buffer in bytes for sockets.
    ///
    /// \note Default value is 8 MiB.
    unsigned int socketBufferSize;

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

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

}}}}