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

#include <OnixS/CME/MDH/Integral.h>

ONIXS_CMEMDH_NAMESPACE_BEGIN

/// List of network interfaces.
typedef std::vector<std::string> NifList;

/// Deserializes semicolon or comma-delimited
/// list of hosts and/or network interface names.
ONIXS_CMEMDH_EXPORTED
void fromStr(NifList&, const std::string&, const std::string& = std::string("; ,"));

/// Network feed connection attributes.
class ONIXS_CMEMDH_LTWT NetFeedConnection
{
public:
    /// Initializes blank instance.
    NetFeedConnection()
        : port_(0)
        , address_()
        , nifs_()
    {
    }

    /// Initializes connection information
    /// using its primary attributes.
    NetFeedConnection(const std::string& address, UInt32 port)
        : port_(port)
        , address_(address)
        , nifs_()
    {
    }

    /// Cleans everything up.
    ~NetFeedConnection() {}

    /// Identifies connection port.
    UInt32 port() const
    {
        return port_;
    }

    /// Updates connection port.
    void port(UInt32 port)
    {
        port_ = port;
    }

    /// Identifies connection address.
    const std::string& address() const
    {
        return address_;
    }

    /// Updates connection address.
    void address(const std::string& address)
    {
        address_ = address;
    }

    /// List of network interfaces on which
    /// connection is to be binded (if binding
    /// to network interfaces is applicable).
    NifList& nifs()
    {
        return nifs_;
    }

    /// List of network interfaces on which
    /// connection is to be binded (if binding
    /// to network interfaces is applicable).
    const NifList& nifs() const
    {
        return nifs_;
    }

private:
    UInt32 port_;

    std::string address_;

    NifList nifs_;
};

/// Serializes feed connection attributes to a given string.
ONIXS_CMEMDH_EXPORTED
void toStr(std::string&, const NetFeedConnection&);

/// Serializes feed connection attributes to a given string.
inline std::string toStr(const NetFeedConnection& connection)
{
    std::string str;

    toStr(str, connection);

    return str;
}

/// Establishes the order between two connections.
struct ONIXS_CMEMDH_EXPORTED NetFeedConnectionLess
{
    /// Establishes the order between two connections.
    bool operator()(const NetFeedConnection&, const NetFeedConnection&) const;
};

ONIXS_CMEMDH_NAMESPACE_END