[gprpp] absl::Notification polyfill (#31008)
* [gprpp] absl::Notification polyfill * grpc_core:: * Automated change: Fix sanity tests * fix * Automated change: Fix sanity tests Co-authored-by: ctiller <ctiller@users.noreply.github.com>pull/30996/head
Craig Tiller
3 years ago
committed by
GitHub
parent
868b7d82a7
commit
d9ac89a441
25 changed files with 298 additions and 45 deletions
@ -0,0 +1,67 @@ |
||||
// Copyright 2022 The gRPC Authors
|
||||
//
|
||||
// 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.
|
||||
|
||||
#ifndef GRPC_CORE_LIB_GPRPP_NOTIFICATION_H |
||||
#define GRPC_CORE_LIB_GPRPP_NOTIFICATION_H |
||||
|
||||
#include <grpc/support/port_platform.h> |
||||
|
||||
#include "absl/time/clock.h" |
||||
#include "absl/time/time.h" |
||||
|
||||
#include "src/core/lib/gprpp/sync.h" |
||||
|
||||
namespace grpc_core { |
||||
|
||||
// Polyfill for absl::Notification until we can use that type.
|
||||
class Notification { |
||||
public: |
||||
void Notify() { |
||||
MutexLock lock(&mu_); |
||||
notified_ = true; |
||||
cv_.SignalAll(); |
||||
} |
||||
|
||||
void WaitForNotification() { |
||||
MutexLock lock(&mu_); |
||||
while (!notified_) { |
||||
cv_.Wait(&mu_); |
||||
} |
||||
} |
||||
|
||||
bool WaitForNotificationWithTimeout(absl::Duration timeout) { |
||||
auto now = absl::Now(); |
||||
auto deadline = now + timeout; |
||||
MutexLock lock(&mu_); |
||||
while (!notified_ && now < deadline) { |
||||
cv_.WaitWithTimeout(&mu_, deadline - now); |
||||
now = absl::Now(); |
||||
} |
||||
return notified_; |
||||
} |
||||
|
||||
bool HasBeenNotified() { |
||||
MutexLock lock(&mu_); |
||||
return notified_; |
||||
} |
||||
|
||||
private: |
||||
Mutex mu_; |
||||
CondVar cv_; |
||||
bool notified_ = false; |
||||
}; |
||||
|
||||
} // namespace grpc_core
|
||||
|
||||
#endif // GRPC_CORE_LIB_GPRPP_NOTIFICATION_H
|
||||
@ -0,0 +1,88 @@ |
||||
// Copyright 2022 The gRPC Authors
|
||||
//
|
||||
// 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.
|
||||
|
||||
#include "src/core/lib/gprpp/notification.h" |
||||
|
||||
#include <stdlib.h> |
||||
|
||||
#include <memory> |
||||
#include <thread> |
||||
|
||||
#include <gtest/gtest.h> |
||||
|
||||
namespace grpc_core { |
||||
namespace testing { |
||||
namespace { |
||||
|
||||
TEST(Notification, Works) { |
||||
Notification n; |
||||
EXPECT_FALSE(n.HasBeenNotified()); |
||||
n.Notify(); |
||||
EXPECT_TRUE(n.HasBeenNotified()); |
||||
n.WaitForNotification(); |
||||
EXPECT_TRUE(n.HasBeenNotified()); |
||||
} |
||||
|
||||
TEST(Notification, Waits) { |
||||
Notification n; |
||||
auto start = absl::Now(); |
||||
std::thread t([&n] { |
||||
absl::SleepFor(absl::Seconds(5)); |
||||
n.Notify(); |
||||
}); |
||||
n.WaitForNotification(); |
||||
auto end = absl::Now(); |
||||
EXPECT_GE(end - start, absl::Seconds(5)); |
||||
t.join(); |
||||
} |
||||
|
||||
TEST(Notification, WaitsWithTimeout) { |
||||
Notification n; |
||||
auto start = absl::Now(); |
||||
std::thread t([&n] { |
||||
absl::SleepFor(absl::Seconds(5)); |
||||
n.Notify(); |
||||
}); |
||||
EXPECT_TRUE(n.WaitForNotificationWithTimeout(absl::Seconds(10))); |
||||
auto end = absl::Now(); |
||||
EXPECT_GE(end - start, absl::Seconds(5)); |
||||
EXPECT_LE(end - start, absl::Seconds(10)); |
||||
t.join(); |
||||
} |
||||
|
||||
TEST(Notification, WaitWithTimeoutCanFinishEarly) { |
||||
Notification n; |
||||
auto start = absl::Now(); |
||||
std::thread t([&n] { |
||||
absl::SleepFor(absl::Seconds(5)); |
||||
n.Notify(); |
||||
}); |
||||
EXPECT_FALSE(n.WaitForNotificationWithTimeout(absl::Seconds(1))); |
||||
auto end = absl::Now(); |
||||
EXPECT_GE(end - start, absl::Seconds(1)); |
||||
EXPECT_LE(end - start, absl::Seconds(5)); |
||||
n.WaitForNotification(); |
||||
end = absl::Now(); |
||||
EXPECT_GE(end - start, absl::Seconds(5)); |
||||
t.join(); |
||||
} |
||||
|
||||
} // namespace
|
||||
} // namespace testing
|
||||
} // namespace grpc_core
|
||||
|
||||
int main(int argc, char** argv) { |
||||
::testing::InitGoogleTest(&argc, argv); |
||||
return RUN_ALL_TESTS(); |
||||
} |
||||
Loading…
Reference in new issue