Struct NamedSemaphoreBuilder 

pub struct NamedSemaphoreBuilder { /* private fields */ }

Builder for the NamedSemaphore.

Example

Create new named semaphore

use iceoryx2_bb_posix::semaphore::*;
use iceoryx2_bb_system_types::file_name::FileName;
use iceoryx2_bb_container::semantic_string::*;

let name = FileName::new(b"mySemaphoreName").unwrap();
let semaphore = NamedSemaphoreBuilder::new(&name)
    // defines the clock which is used in [`SemaphoreInterface::timed_wait()`]
                    .clock_type(ClockType::Monotonic)
    // the semaphore is created, if there already exists a semaphore it is deleted
                    .creation_mode(CreationMode::PurgeAndCreate)
                    .initial_value(5)
                    .permission(Permission::OWNER_ALL | Permission::GROUP_ALL)
                    .create()
                    .expect("failed to create semaphore");

Open existing semaphore

use iceoryx2_bb_posix::semaphore::*;
use iceoryx2_bb_system_types::file_name::FileName;
use iceoryx2_bb_container::semantic_string::*;

let name = FileName::new(b"mySemaphoreName").unwrap();
let semaphore = NamedSemaphoreBuilder::new(&name)
                    .clock_type(ClockType::Monotonic)
                    .open_existing()
                    .expect("failed to open semaphore");

Implementations

impl NamedSemaphoreBuilder

pub fn new(name: &FileName) -> NamedSemaphoreBuilder

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

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 open_existing( self, ) -> Result<NamedSemaphore, NamedSemaphoreCreationError>

Opens an already existing NamedSemaphore.

pub fn creation_mode( self, creation_mode: CreationMode, ) -> NamedSemaphoreCreationBuilder

Defines how the semaphore will be created and returns the NamedSemaphoreCreationBuilder which provides further means of configuration only available when a semaphore is created.

Trait Implementations

impl Debug for NamedSemaphoreBuilder

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

Formats the value using the given formatter.