iCommand.h

/* Copyright (c) 2006-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2012, Daniel Nachbaur <danielnachbaur@gmail.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_ICOMMAND_H
#define CO_ICOMMAND_H

#include <co/api.h>
#include <co/commands.h>        // for enum CommandType
#include <co/dataIStream.h>     // base class


namespace co
{
namespace detail { class ICommand; }

    class ICommand : public DataIStream
    {
    public:
        CO_API ICommand(); 
        CO_API ICommand( LocalNodePtr local, NodePtr remote,
                        ConstBufferPtr buffer, const bool swap ); 
        CO_API ICommand( const ICommand& rhs ); 

        CO_API virtual ~ICommand(); 

        CO_API ICommand& operator = ( const ICommand& rhs ); 

        CO_API void clear(); 

        CO_API uint32_t getType() const;

        CO_API uint32_t getCommand() const;

        CO_API uint64_t getSize() const;

        template< typename T > T get()
        {
            T value;
            *this >> value;
            return value;
        }

        CO_API NodePtr getNode() const;

        CO_API LocalNodePtr getLocalNode() const;

        CO_API bool isValid() const;

        CO_API ConstBufferPtr getBuffer() const;

        CO_API void setType( const CommandType type );

        CO_API void setCommand( const uint32_t cmd );

        void setDispatchFunction( const Dispatcher::Func& func );

        CO_API bool operator()();

    private:
        detail::ICommand* const _impl;

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

        CO_API virtual size_t nRemainingBuffers() const;
        CO_API virtual uint128_t getVersion() const;
        CO_API virtual NodePtr getMaster();
        CO_API virtual bool getNextBuffer( uint32_t&, uint32_t&, const void**,
                                           uint64_t& );

        void _skipHeader(); 
    };

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