oCommand.h

/* Copyright (c) 2012, Daniel Nachbaur <danielnachbaur@gmail.com>
 *               2013, Stefan.Eilemann@epfl.ch
 *
 * 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_OCOMMAND_H
#define CO_OCOMMAND_H

#include <co/commands.h>       // for COMMANDTYPE_NODE
#include <co/dataOStream.h>    // base class


namespace co
{

namespace detail { class OCommand; }

class OCommand : public DataOStream
{
public:
    CO_API OCommand( const Connections& receivers, const uint32_t cmd,
                     const uint32_t type = COMMANDTYPE_NODE );

    CO_API OCommand( Dispatcher* const dispatcher, LocalNodePtr localNode,
                     const uint32_t cmd, const uint32_t type=COMMANDTYPE_NODE );

    CO_API OCommand( const OCommand& rhs );

    CO_API virtual ~OCommand();

    CO_API void sendHeader( const uint64_t additionalSize );

    CO_API static size_t getSize();

protected:
    CO_API virtual void sendData( const void* buffer, const uint64_t size,
                                  const bool last );

private:
    OCommand& operator = ( const OCommand& );
    detail::OCommand* const _impl;

    void _init( const uint32_t cmd, const uint32_t type );
};
}

#endif //CO_OCOMMAND_H