Collage  1.4.0
High-performance C++ library for developing object-oriented distributed applications.
queueSlave.h
1 
2 /* Copyright (c) 2011-2014, Stefan Eilemann <eile@eyescale.ch>
3  * 2011, Carsten Rohn <carsten.rohn@rtt.ag>
4  * 2011-2012, Daniel Nachbaur <danielnachbaur@gmail.com>
5  *
6  * This file is part of Collage <https://github.com/Eyescale/Collage>
7  *
8  * This library is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU Lesser General Public License version 2.1 as published
10  * by the Free Software Foundation.
11  *
12  * This library is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
15  * details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License
18  * along with this library; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21 
22 #ifndef CO_QUEUESLAVE_H
23 #define CO_QUEUESLAVE_H
24 
25 #include <co/api.h>
26 #include <co/object.h> // base class
27 #include <co/types.h>
28 
29 namespace co
30 {
31 namespace detail { class QueueSlave; }
32 
39 class QueueSlave : public Object
40 {
41 public:
57  CO_API QueueSlave( const uint32_t prefetchMark = LB_UNDEFINED_UINT32,
58  const uint32_t prefetchAmount = LB_UNDEFINED_UINT32 );
59 
61  virtual CO_API ~QueueSlave();
62 
74  CO_API ObjectICommand pop( const uint32_t timeout = LB_TIMEOUT_INDEFINITE );
75 
76 protected:
77  ChangeType getChangeType() const override { return STATIC; }
78  void getInstanceData( co::DataOStream& ) override { LBDONTCALL }
79  void applyInstanceData( co::DataIStream& is ) override;
80 
81 private:
82  detail::QueueSlave* const _impl;
83 
84  CO_API void attach( const uint128_t& id,
85  const uint32_t instanceID ) override;
86 };
87 
88 } // co
89 
90 #endif // CO_QUEUESLAVE_H
CO_API ObjectICommand pop(const uint32_t timeout=LB_TIMEOUT_INDEFINITE)
Dequeue an item.
virtual CO_API ~QueueSlave()
Destruct this queue consumer.
Defines export visibility macros for library Collage.
A distributed object.
Definition: object.h:45
CO_API QueueSlave(const uint32_t prefetchMark=LB_UNDEFINED_UINT32, const uint32_t prefetchAmount=LB_UNDEFINED_UINT32)
Construct a new queue consumer.
ChangeType
Object change handling characteristics, see Programming Guide.
Definition: object.h:49
The consumer end of a distributed queue.
Definition: queueSlave.h:39
A std::ostream-like interface for object serialization.
Definition: dataOStream.h:48
Object-oriented network library.
Definition: barrier.h:27
non-versioned, unbuffered, static object.
Definition: object.h:52
void getInstanceData(co::DataOStream &) override
Serialize all instance information of this distributed object.
Definition: queueSlave.h:78
void applyInstanceData(co::DataIStream &is) override
Deserialize the instance data.
A std::istream-like input data stream for binary data.
Definition: dataIStream.h:41
An input command specialization for objects.
ChangeType getChangeType() const override
Definition: queueSlave.h:77