lib/net/connectionDescription.h

/* Copyright (c) 2005-2009, 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 EQNET_CONNECTIONDESCRIPTION_H
#define EQNET_CONNECTIONDESCRIPTION_H

#include <eq/net/connectionType.h>

#include <eq/base/base.h>
#include <eq/base/referenced.h>

namespace eq
{
namespace net
{
    class ConnectionDescription : public base::Referenced
    {
    public:
        ConnectionDescription() 
                : type( CONNECTIONTYPE_TCPIP )
                , bandwidth( 0 )
                , launchTimeout( 10000 )
                , launchCommandQuote( '\'' )
            {
                TCPIP.port = 0;
            }

        ConnectionType type;

        int32_t bandwidth;

        int32_t launchTimeout;

        union
        {
            struct
            {
                uint16_t port;

            } TCPIP, SDP;
        };

        char launchCommandQuote;

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

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

        EQ_EXPORT void setHostname( const std::string& hostname );
        EQ_EXPORT const std::string& getHostname() const;
        EQ_EXPORT void setLaunchCommand( const std::string& launchCommand );
        EQ_EXPORT const std::string& getLaunchCommand() const;
        EQ_EXPORT void setFilename( const std::string& filename );
        EQ_EXPORT const std::string& getFilename() const;

    protected:
        EQ_EXPORT virtual ~ConnectionDescription() {}

    private:
        std::string _launchCommand; 

        std::string _hostname;

        std::string _filename;
    };

    EQ_EXPORT std::ostream& operator << ( std::ostream&,
                                          const ConnectionDescription* );
}
}

#endif // EQNET_CONNECTION_DESCRIPTION_H