TcpSettings.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 "Enumerations.h"

#include <iosfwd>
#include <string>
#include <map>

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

/// Defines TCP server options.
struct ONIXS_ICEMDH_EXPORT TcpServerSettings
{
    /// Host.
    std::string ip;

    /// Port.
    int port;

    /// Username.
    std::string userName;

    /// Password.
    std::string password;

    /// Flag to indicate whether the client wants to get
    /// Strip Info Messages or not. It is false by default.
    bool getStripInfoMessages;

    /// Flag to indicate whether the client wants to get
    /// Strip Info Messages for UDS or not. It is false by default.
    bool getStripInfoForStrategies;

    /// Indicates Strategy Publication Preference.
    StrategyPreference::Enum strategyPreference;

    /// Local network interface from which you
    /// intend to send and receive TCP data.
    std::string localNetworkInterface;

    /// This option determines the size of a
    /// socket's receive buffer that is used
    /// by the underlying transport.
    ///
    /// By default, receive buffer size is \c 65535.
    size_t receiveBufferSize;

    /// Flag to indicate whether the client wants
    /// to use SSL.
    ///
    /// By default, SSL is disabled.
    bool sslEnabled;

    /// Default constructor.
    TcpServerSettings();

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

/// Standard output operator.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const TcpServerSettings&);

/// Alias for TCP server settings map.
typedef std::map<std::string, TcpServerSettings> TcpServersMap;

/// Defines TCP connectivity options.
struct ONIXS_ICEMDH_EXPORT TcpSettings
{
    /// TCP servers map.
    TcpServersMap tcpServers;

    /// The time interval to determine
    /// if data is not available in TCP stream.
    ///
    /// By default, it is 30000 milliseconds.
    unsigned int timeoutInMilliseconds;

    /// The time interval between the attempts to
    /// restore the telecommunication link (in seconds).
    ///
    /// By default, it is 16 seconds.
    unsigned int reconnectTimeoutInSeconds;

    /// Maximum number of reconnect attempts.
    ///
    /// \li \c -1 - unlimited
    /// \li \c 0 - never (default)
    /// \li \c >0 - the number of attempts
    int maximumNumberOfReconnectAttempts;

    /// Default constructor.
    TcpSettings();

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

/// Standard output operator.
ONIXS_ICEMDH_EXPORT std::ostream& operator<<(std::ostream&, const TcpSettings&);

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