queueSlave.h

/* Copyright (c) 2011-2014, Stefan Eilemann <eile@eyescale.ch>
 *                    2011, Carsten Rohn <carsten.rohn@rtt.ag>
 *               2011-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_QUEUESLAVE_H
#define CO_QUEUESLAVE_H

#include <co/api.h>
#include <co/object.h> // base class
#include <co/types.h>

namespace co
{
namespace detail
{
class QueueSlave;
}

class QueueSlave : public Object
{
public:
    CO_API QueueSlave(const uint32_t prefetchMark = LB_UNDEFINED_UINT32,
                      const uint32_t prefetchAmount = LB_UNDEFINED_UINT32);

    virtual CO_API ~QueueSlave();

    CO_API ObjectICommand pop(const uint32_t timeout = LB_TIMEOUT_INDEFINITE);

protected:
    ChangeType getChangeType() const override { return STATIC; }
    void getInstanceData(co::DataOStream&) override { LBDONTCALL }
    void applyInstanceData(co::DataIStream& is) override;

private:
    detail::QueueSlave* const _impl;

    CO_API void attach(const uint128_t& id, const uint32_t instanceID) override;
};

} // co

#endif // CO_QUEUESLAVE_H