Module condition_variable

Contains several variants of POSIX condition variables. A mutex is always included, either as reference or the object itself.

Furthermore, we distinct between

• MultiConditionVariable - waiters can wait on multiple conditions with the draw back that notify_one is not available
• ConditionVariable - the condition has to be provided on construction but notify_one is available

Re-exports

• pub use crate::ipc_capable::Handle;
• pub use crate::ipc_capable::IpcCapable;
• pub use crate::mutex::MutexHandle;
• pub use crate::mutex::*;

Structs

• ConditionVariable
  Condition variable which requires a fixed predicate on creation which is then used in ConditionVariable::blocking_wait_while() and ConditionVariable::timed_wait_while() concurrently with the benefit of triggering single waiters. The reason is when one waits on multiple conditions but triggers only one waiter it is possible that a waiter is triggered which condition is not satisfied while another waiter is not signaled which could have continued. This could lead to some deadlocks.
• ConditionVariableBuilder
  Builder for the MultiConditionVariable and the ConditionVariable. It creates a condition variable which already includes a mutex. The design idea originated from the fact that waiting on the same condition variable with two distinct mutexes is undefined behavior according to the posix standard. An integrated mutex avoids this possible pitfall.
• ConditionVariableData
  Provides access to the underlying type and predicate of a ConditionVariable or with a single static condition.
• ConditionVariableGuard
  Is returned by the ConditionVariable in ConditionVariable::notify_all() or ConditionVariable::notify_one(). It enables the user to change the guarded content before the notification is send. The trigger is signaled when the guard goes out of scope.
• MultiConditionVariable
  Condition variable which allows to use multiple conditions in MultiConditionVariable::blocking_wait_while() and MultiConditionVariable::timed_wait_while() concurrently but with the draw back that only all waiters can be triggered and not one. The reason is when one waits on multiple conditions but triggers only one waiter it is possible that a waiter is triggered which condition is not satisfied while another waiter is not signaled which could have continued. This could lead to some deadlocks.
• MultiConditionVariableGuard
  Is returned by the MultiConditionVariable in MultiConditionVariable::notify_all(). It enables the user to change the guarded content before the notification is send. The trigger is signaled when the guard goes out of scope.
• Predicate

Enums

• ConditionVariableCreationError
• ConditionVariableError
  The ConditionVariableError enum is a generalization when one doesn’t require the fine-grained error handling enums. One can forward forward ConditionVariableError as more generic return value when a method returns a Condition***Error. On a higher level it is again convertable into crate::Error.
• ConditionVariableTimedWaitError
• ConditionVariableWaitError
• ConditionVariableWithSegregatedMutexCreationError

Traits

• BasicConditionVariableInterface