connectionSet.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_CONNECTION_SET_H
#define EQNET_CONNECTION_SET_H

#include <eq/net/connectionListener.h> // base class

#include <eq/base/base.h>
#include <eq/base/buffer.h>
#include <eq/base/hash.h>
#include <eq/base/refPtr.h>

#ifndef WIN32
#  include <poll.h>
#endif

namespace eq
{
namespace net
{
    class Message;
    class Network;

    class ConnectionSet : public ConnectionListener
    {
    public:
        enum Event
        {
            EVENT_NONE = 0,        
            EVENT_CONNECT,         
            EVENT_DISCONNECT,      
            EVENT_DATA,            
            EVENT_TIMEOUT,         
            EVENT_INTERRUPT,       
            EVENT_ERROR,           
            EVENT_SELECT_ERROR,    
            EVENT_INVALID_HANDLE,  
            EVENT_ALL
        };

        EQ_EXPORT ConnectionSet();
        EQ_EXPORT ~ConnectionSet();

        EQ_EXPORT void addConnection( ConnectionPtr connection );
        EQ_EXPORT bool removeConnection( ConnectionPtr connection );
        EQ_EXPORT void clear();
        size_t size()  const { return _connections.size(); }
        bool   empty() const { return _connections.empty(); }

        const ConnectionVector& getConnections() const { return _connections; }

        EQ_EXPORT Event select( const int timeout = -1 );

        EQ_EXPORT void interrupt();

        int           getError()     { return _error; }
        ConnectionPtr getConnection(){ return _connection; }

    private:
        base::Lock _mutex;

        ConnectionVector _connections;

        // Note: std::vector had to much overhead here
#ifdef WIN32
        base::Buffer< HANDLE > _fdSet;
#else
        base::Buffer< pollfd > _fdSetCopy; // 'const' set
        base::Buffer< pollfd > _fdSet;     // copy of _fdSetCopy used to poll
#endif
        base::Buffer< Connection* > _fdSetConnections;

        ConnectionPtr _selfConnection;
        uint8_t _selfCommand;

        // result values
        ConnectionPtr _connection;
        int           _error;

        bool _dirty;

        void _dirtyFDSet();
        bool _setupFDSet();
        bool _buildFDSet();
        virtual void notifyStateChanged( Connection* ) { _dirty = true; }

        Event _handleSelfCommand();
        Event _getSelectResult( const uint32_t index );
    };

    EQ_EXPORT std::ostream& operator << ( std::ostream& os, 
                                          const ConnectionSet* set );
    EQ_EXPORT std::ostream& operator << ( std::ostream& os, 
                                          const ConnectionSet::Event event );
}
}

#endif // EQNET_CONNECTION_SET_H