ThreadWeaver

sequence.h
1 /* -*- C++ -*-
2  This file declares the Sequence class.
3 
4  SPDX-FileCopyrightText: 2004-2013 Mirko Boehm <[email protected]>
5 
6  SPDX-License-Identifier: LGPL-2.0-or-later
7 
8  $Id: DebuggingAids.h 30 2005-08-16 16:16:04Z mirko $
9 */
10 
11 #ifndef JOBSEQUENCE_H
12 #define JOBSEQUENCE_H
13 
14 #include "collection.h"
15 
16 namespace ThreadWeaver
17 {
18 namespace Private
19 {
20 class Sequence_Private;
21 }
22 
23 /** @brief A Sequence is a vector of Jobs that will be executed in a sequence.
24  *
25  * It is implemented by automatically creating the necessary dependencies between the Jobs in the sequence.
26  *
27  * Sequence provides a handy cleanup and unwind mechanism: the stop() slot. If it is called, the processing
28  * of the sequence will stop, and all its remaining Jobs will be dequeued.
29  * A Sequence is the first element of itself. */
30 class THREADWEAVER_EXPORT Sequence : public Collection
31 {
32 public:
33  explicit Sequence();
34 
35 private:
36  Private::Sequence_Private *d();
37  const Private::Sequence_Private *d() const;
38 };
39 
40 }
41 
42 #endif
A Sequence is a vector of Jobs that will be executed in a sequence.
Definition: sequence.h:30
A Collection is a vector of Jobs that will be queued together.
Definition: collection.h:31
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Feb 7 2023 04:09:38 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.