command.h

/* Copyright (c) 2006-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_COMMAND_H
#define CO_COMMAND_H

#include <co/api.h>
#include <co/localNode.h> // NodePtr members

#include <co/base/atomic.h> // member
#include <co/base/refPtr.h> // NodePtr

namespace co
{    
    struct Packet;

    class Command 
    {
    public:
        template< class P > P* get()
            { EQASSERT( _packet ); return static_cast<P*>( _packet ); }
        template< class P > const P* get() const
            { EQASSERT( _packet ); return static_cast<P*>( _packet ); }

        NodePtr getNode()      const { return _node; }
        LocalNodePtr getLocalNode() const { return _localNode; }

        bool          operator ! () const { return ( _packet==0 ); }
        Packet*       operator->()       { EQASSERT(_packet); return _packet; }
        const Packet* operator->() const { EQASSERT(_packet); return _packet; }

        bool isValid() const { return ( _packet!=0 ); }
        uint64_t getAllocationSize() const { return _dataSize; }

        void setDispatchFunction( const Dispatcher::Func& func )
            { EQASSERT( !_func.isValid( )); _func = func; }

        bool isFree() const { return ( _refCount==0 ); }
        CO_API void retain();
        CO_API void release();

        CO_API bool invoke();

    private:
        friend class CommandCache;

        explicit Command( base::a_int32_t& freeCounter );
        ~Command();

        size_t _alloc( NodePtr node, LocalNodePtr localNode,
                       const uint64_t size );

        void _clone( Command& from );

        Command& operator = ( Command& rhs ); // disable assignment
        Command( const Command& from );       // disable copy
        Command();                            // disable default ctor

        void _free();

        NodePtr       _node;      
        LocalNodePtr  _localNode; 
        Packet*       _packet;    

        Packet*  _data;     
        uint64_t _dataSize; 

        base::a_int32_t* _refCountMaster;
        base::a_int32_t  _refCount;
        base::a_int32_t& _freeCount;

        Dispatcher::Func _func;
        friend CO_API std::ostream& operator << (std::ostream&, const Command&);

        EQ_TS_VAR( _writeThread );
    };

    CO_API std::ostream& operator << ( std::ostream& os, const Command& );
}
#endif // CO_COMMAND_H