GRPC C++  1.39.1
alarm.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
21 #ifndef GRPCPP_ALARM_H
22 #define GRPCPP_ALARM_H
23 
24 #include <functional>
25 
26 #include <grpc/grpc.h>
32 
33 namespace grpc {
34 
36  public:
38  Alarm();
39 
41  ~Alarm() override;
42 
50  template <typename T>
51  Alarm(::grpc::CompletionQueue* cq, const T& deadline, void* tag) : Alarm() {
52  SetInternal(cq, ::grpc::TimePoint<T>(deadline).raw_time(), tag);
53  }
54 
59  //
60  // USAGE NOTE: This is frequently used to inject arbitrary tags into \a cq by
61  // setting an immediate deadline. Such usage allows synchronizing an external
62  // event with an application's \a grpc::CompletionQueue::Next loop.
63  template <typename T>
64  void Set(::grpc::CompletionQueue* cq, const T& deadline, void* tag) {
65  SetInternal(cq, ::grpc::TimePoint<T>(deadline).raw_time(), tag);
66  }
67 
69  Alarm(const Alarm&) = delete;
70  Alarm& operator=(const Alarm&) = delete;
71 
73  Alarm(Alarm&& rhs) noexcept : alarm_(rhs.alarm_) { rhs.alarm_ = nullptr; }
74  Alarm& operator=(Alarm&& rhs) noexcept {
75  alarm_ = rhs.alarm_;
76  rhs.alarm_ = nullptr;
77  return *this;
78  }
79 
82  void Cancel();
83 
87  template <typename T>
88  void Set(const T& deadline, std::function<void(bool)> f) {
89  SetInternal(::grpc::TimePoint<T>(deadline).raw_time(), std::move(f));
90  }
91 
92  private:
93  void SetInternal(::grpc::CompletionQueue* cq, gpr_timespec deadline,
94  void* tag);
95  void SetInternal(gpr_timespec deadline, std::function<void(bool)> f);
96 
98 };
99 
100 } // namespace grpc
101 
102 #endif // GRPCPP_ALARM_H
Definition: alarm.h:35
Alarm()
Create an unset completion queue alarm.
Alarm & operator=(const Alarm &)=delete
void Cancel()
Cancel a completion queue alarm.
void Set(const T &deadline, std::function< void(bool)> f)
Set an alarm to invoke callback f.
Definition: alarm.h:88
Alarm(::grpc::CompletionQueue *cq, const T &deadline, void *tag)
DEPRECATED: Create and set a completion queue alarm instance associated to cq.
Definition: alarm.h:51
Alarm(Alarm &&rhs) noexcept
Alarms are movable.
Definition: alarm.h:73
~Alarm() override
Destroy the given completion queue alarm, cancelling it in the process.
void Set(::grpc::CompletionQueue *cq, const T &deadline, void *tag)
Trigger an alarm instance on completion queue cq at the specified time.
Definition: alarm.h:64
Alarm & operator=(Alarm &&rhs) noexcept
Definition: alarm.h:74
Alarm(const Alarm &)=delete
Alarms aren't copyable.
A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....
Definition: completion_queue.h:102
Classes that require gRPC to be initialized should inherit from this class.
Definition: grpc_library.h:38
If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec ...
Definition: time.h:40
An interface allowing implementors to process and filter event tags.
Definition: completion_queue_tag.h:26
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
Analogous to struct timespec.
Definition: gpr_types.h:47