Struct signal_hook::iterator::backend::Handle

pub struct Handle { /* fields omitted */ }

A struct to control an instance of an associated type (like for example Signals).

It allows to register more signal handlers and to shutdown the signal delivery. You can clone this type which isn't a very expensive operation. The cloned instances can be shared between multiple threads.

Implementations

impl Handle

pub fn add_signal(&self, signal: c_int) -> Result<(), Error>

Registers another signal to the set watched by the associated instance.

Notes

• This is safe to call concurrently from whatever thread.
• This is not safe to call from within a signal handler.
• If the signal number was already registered previously, this is a no-op.
• If this errors, the original set of signals is left intact.

Panics

• If the given signal is [forbidden][crate::FORBIDDEN].
• If the signal number is negative or larger than internal limit. The limit should be larger than any supported signal the OS supports.
• If the relevant Exfiltrator does not support this particular signal. The default [SignalOnly] one supports all signals.

pub fn close(&self)

Closes the associated instance.

This is meant to signalize termination of the signal delivery process. After calling close:

• is_closed will return true.
• All currently blocking operations of associated instances are interrupted and terminate.
• Any further operations will not block.
• Further signals may or may not be returned from the iterators. However, if any are returned, these are real signals that happened.

The goal is to be able to shut down any background thread that handles only the signals.

pub fn is_closed(&self) -> bool

Is it closed?

See close.

Trait Implementations

impl Clone for Handle

pub fn clone(&self) -> Handle

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Handle

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

Formats the value using the given formatter.