summaryrefslogtreecommitdiff
path: root/qpid/cpp/src/qpid/sys/Activity.h
blob: 36db9da216d02571b28054ba0efe3aee0a7e20ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
#ifndef QPID_SYS_ACTIVITY_H
#define QPID_SYS_ACTIVITY_H

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

#include <boost/function.hpp>

namespace qpid {
namespace sys {

/**
 * An activity that may be executed by multiple threads concurrently.
 * An activity has 3 states:
 * - active: may have active threads, new threads may enter.
 * - stopping: may have active threads but  no new threads may enter.
 * - stopped: no active threads and no new threads may enter.
 */
class Activity {
  public:
    /**
     * Initially active.
     *@param stoppedCallback: called when all threads have stopped.
     */
    Activity(boost::function<void()> stoppedCallback)
        : busy(0), stopped(false), notify(stoppedCallback) {}

    /** Mark the scope of an activity thread like this:
     * <pre>
     * {
     *   Activity::Scope working(activity);
     *   if (working) { do stuff } // Only if activity is active.
     * }
     * </pre>
     */
    class Scope {
        Activity& state;
        bool entered;
      public:
        Scope(Activity& s) : state(s) { entered = state.enter(); }
        ~Scope() { if (entered) state.exit(); }
        operator bool() const { return entered; }
    };

  friend class Scope;

    // FIXME aconway 2011-09-30: fix pre-conditions with asserts, don't allow
    // multiple stops/starts.
    /**
     * Set state to "stopped", so no new threads can enter.
     * Notify function will be called when all busy threads have left.
     * No-op if already stopping.
     */
    void stop() {
        sys::Monitor::ScopedLock l(lock);
        stopped = true;
        check(l);
    }

    /** Set the state to "started", allow threads to enter.
     * If already stopping this will prevent notify function from being called.
     */
    void start() {
        sys::Monitor::ScopedLock l(lock);
        stopped = false;
    }

    /** True if Activity is stopped with no */
    bool isStopped() {
        sys::Monitor::ScopedLock l(lock);
        return stopped && busy == 0;
    }

  private:
    // Busy thread enters scope
    bool enter() {
        sys::Monitor::ScopedLock l(lock);
        if (!stopped) ++busy;
        return !stopped;
    }

    // Busy thread exits scope
    void exit() {
        sys::Monitor::ScopedLock l(lock);
        assert(busy > 0);
        --busy;
        check(l);
    }

    void check(const sys::Monitor::ScopedLock&) {
        // Called with lock held.
        if (stopped && busy == 0 && notify) notify();
    }

    uint busy;
    bool stopped;
    sys::Monitor lock;
    boost::function< void() > notify;
};

}} // namespace qpid::sys

#endif  /*!QPID_SYS_ACTIVITY_H*/