Line data Source code
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_QUEUEMASTER_H
23 : #define CO_QUEUEMASTER_H
24 :
25 : #include <co/object.h> // base class
26 : #include <co/types.h>
27 :
28 : namespace co
29 : {
30 : namespace detail { class QueueMaster; }
31 :
32 : /**
33 : * The producer end of a distributed queue.
34 : *
35 : * One instance of this class is registered with a LocalNode to for the producer
36 : * end of a distributed queue. One or more QueueSlave instances are mapped to
37 : * this master instance and consume the data.
38 : */
39 : class QueueMaster : public Object
40 : {
41 : public:
42 : /** Construct a new queue master. @version 1.0 */
43 : CO_API QueueMaster();
44 :
45 : /** Destruct this queue master. @version 1.0 */
46 : virtual CO_API ~QueueMaster();
47 :
48 : /**
49 : * Enqueue a new queue item.
50 : *
51 : * The returned queue item can stream additional data using the DataOStream
52 : * operators. Note that the item is enqueued once it is destroyed, i.e. when
53 : * it runs out of scope.
54 : *
55 : * @return the item to enqueue.
56 : * @version 1.0
57 : */
58 : CO_API QueueItem push();
59 :
60 : /** Remove all enqueued items. @version 1.0 */
61 : CO_API void clear();
62 :
63 : private:
64 : detail::QueueMaster* const _impl;
65 :
66 : CO_API void attach( const uint128_t& id,
67 : const uint32_t instanceID ) override;
68 :
69 2 : ChangeType getChangeType() const override { return STATIC; }
70 : void getInstanceData( co::DataOStream& os ) override;
71 0 : void applyInstanceData( co::DataIStream& ) override { LBDONTCALL }
72 :
73 : friend class QueueItem;
74 : void _addItem( QueueItem& item );
75 : };
76 :
77 : } // co
78 :
79 : #endif // CO_QUEUEMASTER_H
|