ConformanceTools.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 "Messages/DebugResponse.h"
#include "Messages/MulticastChannelGroups.h"

#include <string>

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

/// \brief Provides tools for conformance testing.
class ONIXS_ICEMDH_EXPORT ConformanceTools
{
public:
    /// Opens connection to ICE server and synchronously sends a Debug Request
    /// and returns the Debug Response.
    ///
    /// \param host The host to connect to.
    /// \param port The port to connect to.
    /// \param useSsl Indicates whether to use SSL.
    /// \param timeoutInMilliseconds The timeout in milliseconds.
    /// \param localNetworkInterface The local network interface to use.
    ///
    /// \throws OnixS::ICE::iMpact::MarketData::Exception in case of an error:
    /// - if the connection to the server cannot be established;
    /// - if the request cannot be sent;
    /// - if the response cannot be received.
    ///
    /// \returns The Debug Response message structure.
    static DebugResponse fetchDebugResponse(
        const std::string& host,
        int port,
        bool useSsl = true,
        unsigned int timeoutInMilliseconds = 30000,
        const std::string& localNetworkInterface = ""
    );

    /// Opens connection to ICE server to fetch Multicast Channel Groups Message.
    ///
    /// \param host The host to connect to.
    /// \param port The port to connect to.
    /// \param username The username to use.
    /// \param password The password to use.
    /// \param useSsl Indicates whether to use SSL.
    /// \param timeoutInMilliseconds The timeout in milliseconds.
    /// \param localNetworkInterface The local network interface to use.
    ///
    /// \throws OnixS::ICE::iMpact::MarketData::Exception in case of an error:
    /// - if the connection to the server cannot be established;
    /// - if the request cannot be sent;
    /// - if the response cannot be received.
    ///
    /// \returns The Multicast Channel Groups message structure.
    static MulticastChannelGroups fetchMulticastChannelGroups(
        const std::string& host,
        int port,
        const std::string& username,
        const std::string& password,
        bool useSsl = true,
        unsigned int timeoutInMilliseconds = 30000,
        const std::string& localNetworkInterface = ""
    );
};

}}}} // namespace OnixS::ICE::iMpact::MarketData