Struct UnnamedSemaphoreBuilder 

pub struct UnnamedSemaphoreBuilder { /* private fields */ }

Creates an UnnamedSemaphore which can be either used process locally or can be stored in a shared memory segment and then used during inter-process communication.

Example

use iceoryx2_bb_posix::semaphore::*;

let semaphore_handle = UnnamedSemaphoreHandle::new();
let semaphore = UnnamedSemaphoreBuilder::new().initial_value(5)
                                              .is_interprocess_capable(false)
                                              .clock_type(ClockType::Monotonic)
                                              .create(&semaphore_handle)
                                              .expect("failed to create unnamed semaphore");

Implementations

impl UnnamedSemaphoreBuilder

pub fn new() -> UnnamedSemaphoreBuilder

pub fn initial_value(self, value: u32) -> UnnamedSemaphoreBuilder

Sets the initial value of the semaphore. Must be less than MAX_INITIAL_SEMAPHORE_VALUE.

pub fn is_interprocess_capable(self, value: bool) -> UnnamedSemaphoreBuilder

Defines if the UnnamedSemaphore can be used in an inter-process communication context.

pub fn clock_type(self, value: ClockType) -> UnnamedSemaphoreBuilder

Sets the type of clock which will be used in SemaphoreInterface::timed_wait(). Be aware a clock like ClockType::Realtime is depending on the systems local time. If this time changes while waiting it can cause extrem long waits or no wait at all.

pub fn create( self, handle: &UnnamedSemaphoreHandle, ) -> Result<UnnamedSemaphore<'_>, UnnamedSemaphoreCreationError>

Creates an UnnamedSemaphore.

Trait Implementations

impl Debug for UnnamedSemaphoreBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for UnnamedSemaphoreBuilder

fn default() -> UnnamedSemaphoreBuilder

Returns the “default value” for a type.