blob: 5b6311d898deb166fd387978262404002d44ac09 (
plain) (
blame)
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
|
#pragma clang system_header
// 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.
#ifndef ARROW_COUNTING_SEMAPHORE_H
#define ARROW_COUNTING_SEMAPHORE_H
#include <memory>
#include "contrib/libs/apache/arrow_next/cpp/src/arrow/status.h"
namespace arrow20 {
namespace util {
/// \brief Simple mutex-based counting semaphore with timeout
class ARROW_EXPORT CountingSemaphore {
public:
/// \brief Create an instance with initial_avail starting permits
///
/// \param[in] initial_avail The semaphore will start with this many permits available
/// \param[in] timeout_seconds A timeout to be applied to all operations. Operations
/// will return Status::Invalid if this timeout elapses
explicit CountingSemaphore(uint32_t initial_avail = 0, double timeout_seconds = 10);
~CountingSemaphore();
/// \brief Block until num_permits permits are available
Status Acquire(uint32_t num_permits);
/// \brief Make num_permits permits available
Status Release(uint32_t num_permits);
/// \brief Wait until num_waiters are waiting on permits
///
/// This method is non-standard but useful in unit tests to ensure sequencing
Status WaitForWaiters(uint32_t num_waiters);
/// \brief Immediately time out any waiters
///
/// This method will return Status::OK only if there were no waiters to time out.
/// Once closed any operation on this instance will return an invalid status.
Status Close();
private:
class Impl;
std::unique_ptr<Impl> impl_;
};
} // namespace util
} // namespace arrow20
#endif // ARROW_COUNTING_SEMAPHORE_H
|
