connectionDescription.h

/* Copyright (c) 2005-2015, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef CO_CONNECTIONDESCRIPTION_H
#define CO_CONNECTIONDESCRIPTION_H

#include <co/api.h>
#include <co/connectionType.h> // member enum
#include <co/types.h>

#include <lunchbox/referenced.h> // base class

namespace co
{
class ConnectionDescription : public lunchbox::Referenced
{
public:
    ConnectionType type;

    int32_t bandwidth;

    uint16_t port;

    static const uint16_t RANDOM_MULTICAST_PORT = 1;

    std::string hostname;

    std::string interfacename;

    std::string filename;

    ConnectionDescription()
        : type(CONNECTIONTYPE_TCPIP)
        , bandwidth(0)
        , port(0)
        , filename("default")
    {
    }

    explicit ConnectionDescription(std::string& data);

    CO_API void serialize(std::ostream& os) const;

    CO_API std::string toString() const;

    CO_API bool fromString(std::string& data);

    CO_API bool isSameMulticastGroup(ConstConnectionDescriptionPtr rhs);

    CO_API bool operator==(const ConnectionDescription& rhs) const;

    bool operator!=(const ConnectionDescription& rhs) const
    {
        return !(*this == rhs);
    }

    CO_API void setHostname(const std::string& hostname);
    CO_API const std::string& getHostname() const;

    CO_API void setInterface(const std::string& interfacename);
    CO_API const std::string& getInterface() const;

    CO_API void setFilename(const std::string& filename);
    CO_API const std::string& getFilename() const;

protected:
    virtual ~ConnectionDescription() {}
};

CO_API std::ostream& operator<<(std::ostream&, const ConnectionDescription&);

CO_API std::string serialize(const ConnectionDescriptions&);

CO_API bool deserialize(std::string& data,
                        ConnectionDescriptions& descriptions);
}

#endif // CO_CONNECTION_DESCRIPTION_H