countdown_event.h 1.59 KB
Newer Older
gejun's avatar
gejun committed
1
// bthread - A M:N threading library to make applications more concurrent.
gejun's avatar
gejun committed
2
// Copyright (c) 2016 Baidu, Inc.
gejun's avatar
gejun committed
3 4 5 6 7 8 9 10 11 12 13 14
// 
// Licensed 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.
gejun's avatar
gejun committed
15 16 17 18 19 20 21 22 23 24 25

// Author: Zhangyi Chen (chenzhangyi01@baidu.com)
// Date: 2016/06/03 13:06:40

#ifndef  PUBLIC_BTHREAD_COUNTDOWN_EVENT_H
#define  PUBLIC_BTHREAD_COUNTDOWN_EVENT_H

#include "bthread/bthread.h"

namespace bthread {

gejun's avatar
gejun committed
26
// A synchronization primitive to wait for multiple signallers.
gejun's avatar
gejun committed
27 28
class CountdownEvent {
public:
gejun's avatar
gejun committed
29
    CountdownEvent(int initial_count = 1);
gejun's avatar
gejun committed
30 31 32
    ~CountdownEvent();

    // Increase current counter by |v|
gejun's avatar
gejun committed
33
    void add_count(int v = 1);
gejun's avatar
gejun committed
34 35

    // Reset the counter to |v|
gejun's avatar
gejun committed
36 37 38 39
    void reset(int v = 1);

    // Decrease the counter by |sig|
    void signal(int sig = 1);
gejun's avatar
gejun committed
40

gejun's avatar
gejun committed
41
    // Block current thread until the counter reaches 0
gejun's avatar
gejun committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55
    void wait();

    // Block the current thread until the counter reaches 0 or duetime has expired
    // Returns 0 on success, ETIMEDOUT otherwise.
    int timed_wait(const timespec& duetime);

private:
    int *_butex;
    bool _wait_was_invoked;
};

}  // namespace bthread

#endif  //PUBLIC_BTHREAD_COUNTDOWN_EVENT_H