Skip to main content

IpcQuota

Struct IpcQuota 

Source
pub struct IpcQuota {
    pub channels: AtomicU32,
    pub queue_slots: AtomicU64,
    pub buffered_bytes: AtomicU64,
}
Expand description

Per-process IPC resource counters.

All fields are atomic so they can be updated without holding a global lock. They are always accessed from the owning process’s context (the syscall handler), so Relaxed ordering is sufficient for the common case; AcqRel is used for the reserve/release pair to ensure that a failed reservation is never silently lost.

Fields§

§channels: AtomicU32

Number of live channel capabilities (handles) held by this process.

§queue_slots: AtomicU64

Sum of capacity across all channels created by this process.

§buffered_bytes: AtomicU64

queue_slots * size_of::<IpcMessage>() : total bytes that could be buffered across all channels.

Implementations§

Source§

impl IpcQuota

Source

pub const fn new() -> Self

Creates a new, empty quota (all counters zero).

Source

pub fn try_reserve(&self, capacity: usize) -> Result<(), QuotaExceeded>

Try to reserve resources for a new channel.

Returns Ok(()) if the reservation fits within the process quota, Err(QuotaExceeded) otherwise. On failure nothing is modified.

Source

pub fn release(&self, capacity: usize)

Release resources previously reserved by [try_reserve].

Must be called exactly once for every successful try_reserve. Passing a capacity that was never reserved will underflow the counters : the caller must ensure correctness.

Source

pub fn snapshot(&self) -> QuotaSnapshot

Returns a snapshot of the current counters.

Trait Implementations§

Source§

impl Debug for IpcQuota

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IpcQuota

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.