binary_semaphore.h

// Copyright 2020 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 <stdbool.h>
#include <stddef.h>
 
#include "pw_chrono/system_clock.h"
#include "pw_preprocessor/util.h"
 
#ifdef __cplusplus
 
#include "pw_sync_backend/binary_semaphore_native.h"
 
namespace pw::sync {
 
class BinarySemaphore {
 public:
  using native_handle_type = backend::NativeBinarySemaphoreHandle;
 
  BinarySemaphore();
  ~BinarySemaphore();
  BinarySemaphore(const BinarySemaphore&) = delete;
  BinarySemaphore(BinarySemaphore&&) = delete;
  BinarySemaphore& operator=(const BinarySemaphore&) = delete;
  BinarySemaphore& operator=(BinarySemaphore&&) = delete;
 
  void release();
 
  void acquire();
 
  [[nodiscard]] bool try_acquire() noexcept;
 
  [[nodiscard]] bool try_acquire_for(chrono::SystemClock::duration timeout);
 
  [[nodiscard]] bool try_acquire_until(
      chrono::SystemClock::time_point deadline);
 
  [[nodiscard]] static constexpr ptrdiff_t max() noexcept {
    return backend::kBinarySemaphoreMaxValue;
  }
 
  [[nodiscard]] native_handle_type native_handle();
 
 private:
  backend::NativeBinarySemaphore native_type_;
};
 
}  // namespace pw::sync
 
#include "pw_sync_backend/binary_semaphore_inline.h"
 
using pw_sync_BinarySemaphore = pw::sync::BinarySemaphore;
 
#else  // !defined(__cplusplus)
 
typedef struct pw_sync_BinarySemaphore pw_sync_BinarySemaphore;
 
#endif  // __cplusplus
 
PW_EXTERN_C_START
 
void pw_sync_BinarySemaphore_Release(pw_sync_BinarySemaphore* semaphore);
void pw_sync_BinarySemaphore_Acquire(pw_sync_BinarySemaphore* semaphore);
bool pw_sync_BinarySemaphore_TryAcquire(pw_sync_BinarySemaphore* semaphore);
bool pw_sync_BinarySemaphore_TryAcquireFor(
    pw_sync_BinarySemaphore* semaphore, pw_chrono_SystemClock_Duration timeout);
bool pw_sync_BinarySemaphore_TryAcquireUntil(
    pw_sync_BinarySemaphore* semaphore,
    pw_chrono_SystemClock_TimePoint deadline);
ptrdiff_t pw_sync_BinarySemaphore_Max(void);
 
PW_EXTERN_C_END