connectionDescription.h

/* Copyright (c) 2005-2011, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * 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/connectionType.h> // member enum
#include <co/api.h>
#include <co/types.h>

#include <co/base/api.h>
#include <co/base/referenced.h>

namespace co
{
    class ConnectionDescription : public base::Referenced
    {
    public:
        ConnectionDescription() 
                : type( CONNECTIONTYPE_TCPIP )
                , bandwidth( 0 )
                , port( 0 )
                , _filename( "default" )
            {}

        ConnectionDescription( const char* data );

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

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

        ConnectionType type;

        int32_t bandwidth;

        uint16_t port;

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

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

        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;

        CO_API bool isSameMulticastGroup( ConnectionDescriptionPtr rhs );

        // Note: also update string array init in connectionDescription.cpp
        enum SAttribute
        {
            SATTR_HOSTNAME,
            SATTR_FILENAME,
            SATTR_FILL1,
            SATTR_FILL2,
            SATTR_ALL
        };

        enum IAttribute
        {
            IATTR_TYPE,
            IATTR_PORT,
            IATTR_BANDWIDTH,
            IATTR_FILL1,
            IATTR_FILL2,
            IATTR_ALL
        };

        CO_API static const std::string&
        getSAttributeString( const SAttribute attr );
        CO_API static const std::string&
        getIAttributeString( const IAttribute attr );

    protected:
        virtual ~ConnectionDescription() {}

    private:
        std::string _hostname;

        std::string _interface;

        std::string _filename;
    };

    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