Struct fruity__bbqsrc::dispatch::DispatchSource

#[repr(C)]
pub struct DispatchSource(_);

An object that coordinates the processing of specific low-level system events, such as file-system events, timers, and UNIX signals.

Documentation: Swift | Objective-C

Implementations

impl DispatchSource

pub unsafe fn create(
    source_type: &DispatchSourceType,
    handle: usize,
    mask: usize,
    queue: Option<&DispatchQueue>
) -> Arc<Self>

Creates a new dispatch source to monitor low-level system events.

Dispatch sources are created in a suspended state. After creating the source and setting any desired attributes (for example, the handler or the context), your application must call activate to begin event delivery.

Important: Event source creation is asynchronous, so be aware of any race conditions with monitored system handles. For example, if a dispatch source is created for a process and that process exits before the source is created, any specified cancellation handler may not be called.

Documentation: Objective-C

Safety

The expectations for the given source type must be upheld.

pub fn data(&self) -> usize

Returns pending data for this dispatch source.

Documentation: Swift | Objective-C

pub unsafe fn merge_data(&self, value: usize)

Merges data into a dispatch source and submits its event handler block to its target queue.

Documentation: Objective-C

Safety

This dispatch source must be of type DispatchSourceType::data_add or DispatchSourceType::data_or.

pub fn mask(&self) -> usize

Returns the mask of events monitored by this dispatch source.

Documentation: Swift | Objective-C

pub fn handle(&self) -> usize

Returns the underlying system handle associated with this dispatch source.

Documentation: Swift | Objective-C

pub unsafe fn set_timer(&self, start: DispatchTime, interval: u64, leeway: u64)

Sets a start time, interval, and leeway value for this dispatch timer source.

Documentation: Objective-C

Safety

This dispatch source must be of type DispatchSourceType::timer.

pub fn cancel(&self)

Asynchronously cancels this dispatch source, preventing any further invocation of its event handler block.

Documentation: Swift | Objective-C

pub fn is_cancelled(&self) -> bool

Returns true if this dispatch source has been cancelled.

Documentation: Swift | Objective-C

Methods from Deref<Target = DispatchObject>

pub fn activate(&self)

Activates self.

Once a dispatch object has been activated, it cannot change its target queue.

See documentation.

pub fn resume(&self)

Resumes the invocation of block objects on self.

See documentation.

pub fn suspend(&self)

Suspends the invocation of block objects on self.

See documentation.

pub unsafe fn set_target<Q>(&self, queue: Option<&DispatchQueue>)

Specifies the dispatch queue on which to perform work associated with self.

If this queue has already been activated, then this method will fail.

Important: When setting up target queues, it is a programmer error to create cycles in the dispatch queue hierarchy. In other words, don’t set the target of queue A to queue B and set the target of queue B to queue A.

Documentation: Swift | Objective-C

Safety

The target queue must be expected for this dispatch object. For example, an object may expect to dispatch to the main queue.

pub fn context(&self) -> *mut c_void

Returns the application-defined context of an object.

See documentation.

pub unsafe fn set_context(&self, context: *mut c_void)

Associates an application-defined context with the object.

See documentation.

Safety

The object or dependent code may make assumptions about its current context. Callers must be careful to not invalidate any assumptions.

Trait Implementations

impl AsMut<DispatchSource> for DispatchSource

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl<T> AsMut<T> for DispatchSource where
    DispatchObject: AsMut<T>, 

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

Performs the conversion.

impl AsRef<DispatchSource> for DispatchSource

fn as_ref(&self) -> &Self

Performs the conversion.

impl<T> AsRef<T> for DispatchSource where
    DispatchObject: AsRef<T>, 

fn as_ref(&self) -> &T

Performs the conversion.

impl Deref for DispatchSource

type Target = DispatchObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ObjectType for DispatchSource

fn retain(obj: &Self) -> Arc<Self>

Increments the object’s retain count and returns a smart pointer that automatically calls release on Drop.

unsafe fn release(obj: NonNull<Self>)

Decrements the object’s retain count.