aboutsummaryrefslogtreecommitdiff
path: root/pw_sync_freertos/public/pw_sync_freertos/timed_thread_notification_inline.h
blob: dd0823e6a9af8e742b8ff8e9e7d5b29c7c7fa3a2 (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
// Copyright 2021 The Pigweed 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
//
//     https://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.
#pragma once

#include "pw_chrono/system_clock.h"
#include "pw_sync/timed_thread_notification.h"

namespace pw::sync {

inline bool TimedThreadNotification::try_acquire_for(
    chrono::SystemClock::duration timeout) {
  // Because xTaskNotifyWait may spuriously return pdFALSE due to vTaskSuspend &
  // vTaskResume, a deadline is used instead of a timeout just like FreeRTOS
  // stream buffers.
  return try_acquire_until(chrono::SystemClock::TimePointAfterAtLeast(timeout));
}

}  // namespace pw::sync