Collage  1.7.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
32 {
33 class QueueSlave;
34 }
35 
42 class QueueSlave : public Object
43 {
44 public:
60  CO_API QueueSlave(const uint32_t prefetchMark = LB_UNDEFINED_UINT32,
61  const uint32_t prefetchAmount = LB_UNDEFINED_UINT32);
62 
64  virtual CO_API ~QueueSlave();
65 
77  CO_API ObjectICommand pop(const uint32_t timeout = LB_TIMEOUT_INDEFINITE);
78 
79 protected:
80  ChangeType getChangeType() const override { return STATIC; }
81  void getInstanceData(co::DataOStream&) override { LBDONTCALL }
82  void applyInstanceData(co::DataIStream& is) override;
83 
84 private:
85  detail::QueueSlave* const _impl;
86 
87  CO_API void attach(const uint128_t& id, const uint32_t instanceID) override;
88 };
89 
90 } // co
91 
92 #endif // CO_QUEUESLAVE_H
Defines export visibility macros for library Collage.
A distributed object.
Definition: object.h:47
ChangeType
Object change handling characteristics, see Programming Guide.
Definition: object.h:51
The consumer end of a distributed queue.
Definition: queueSlave.h:42
A std::ostream-like interface for object serialization.
Definition: dataOStream.h:56
Object-oriented network library.
Definition: barrier.h:27
void getInstanceData(co::DataOStream &) override
Serialize all instance information of this distributed object.
Definition: queueSlave.h:81
ChangeType getChangeType() const override
Definition: queueSlave.h:80
A std::istream-like input data stream for binary data.
Definition: dataIStream.h:45
An input command specialization for objects.