Struct libuv::handles::signal::SignalHandle

pub struct SignalHandle { /* fields omitted */ }

Signal handles implement Unix style signal handling on a per-event loop bases.

Windows notes: Reception of some signals is emulated:

• SIGINT is normally delivered when the user presses CTRL+C. However, like on Unix, it is not generated when terminal raw mode is enabled.
• SIGBREAK is delivered when the user pressed CTRL + BREAK.
• SIGHUP is generated when the user closes the console window. On SIGHUP the program is given approximately 10 seconds to perform cleanup. After that Windows will unconditionally terminate it.
• SIGWINCH is raised whenever libuv detects that the console has been resized. When a libuv app is running under a console emulator, or when a 32-bit libuv app is running on 64-bit system, SIGWINCH will be emulated. In such cases SIGWINCH signals may not always be delivered in a timely manner. For a writable TtyHandle libuv will only detect size changes when the cursor is moved. When a readable TtyHandle is used, resizing of the console buffer will be detected only if the handle is in raw mode and is being read.
• Watchers for other signals can be successfully created, but these signals are never received. These signals are: SIGILL, SIGABRT, SIGFPE, SIGSEGV, SIGTERM and SIGKILL.
• Calls to raise() or abort() to programmatically raise a signal are not detected by libuv; these will not trigger a signal watcher.

Unix notes

• SIGKILL and SIGSTOP are impossible to catch.
• Handling SIGBUS, SIGFPE, SIGILL or SIGSEGV via libuv results into undefined behavior.
• SIGABRT will not be caught by libuv if generated by abort(), e.g. through assert().
• On Linux SIGRT0 and SIGRT1 (signals 32 and 33) are used by the NPTL pthreads library to manage threads. Installing watchers for those signals will lead to unpredictable behavior and is strongly discouraged. Future versions of libuv may simply reject them.

Implementations

impl SignalHandle

pub fn new(r#loop: &Loop) -> Result<SignalHandle>

Create and initialize a new signal handle

pub fn start<CB: Into<SignalCB<'static>>>(
    &mut self,
    cb: CB,
    signum: i32
) -> Result<()>

Start the handle with the given callback, watching for the given signal.

pub fn start_oneshot<CB: Into<SignalCB<'static>>>(
    &mut self,
    cb: CB,
    signum: i32
) -> Result<()>

Same functionality as start() but the signal handler is reset the moment the signal is received.

pub fn stop(&mut self) -> Result<()>

Stop the handle, the callback will no longer be called.

pub fn signum(&self) -> i32

Signal being monitored by this handle.

Trait Implementations

impl Clone for SignalHandle

fn clone(&self) -> SignalHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SignalHandle

impl From<SignalHandle> for Handle

fn from(signal: SignalHandle) -> Handle

Performs the conversion.

impl HandleTrait for SignalHandle

fn is_active(&self) -> bool

Returns non-zero if the handle is active, zero if it’s inactive. What “active” means depends on the type of handle: * An AsyncHandle is always active and cannot be deactivated, except by closing it with close(). * A PipeHandle, TcpHandle, UdpHandle, etc. - basically any handle that deals with i/o - is active when it is doing something that involves i/o, like reading, writing, connecting, accepting new connections, etc. * A CheckHandle, IdleHandle, TimerHandle, etc. is active when it has been started with a call to start().

fn is_closing(&self) -> bool

Returns non-zero if the handle is closing or closed, zero otherwise.

fn close<CB: Into<CloseCB<'static>>>(&mut self, cb: CB)

Request handle to be closed. close_cb will be called asynchronously after this call. This MUST be called on each handle before memory is released. Moreover, the memory can only be released in close_cb or after it has returned.

fn ref(&mut self)

Reference the given handle. References are idempotent, that is, if a handle is already referenced calling this function again will have no effect.

fn unref(&mut self)

Un-reference the given handle. References are idempotent, that is, if a handle is not referenced calling this function again will have no effect.

fn has_ref(&self) -> bool

Returns true if the handle referenced, zero otherwise.

fn send_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the send buffer that the operating system uses for the socket.

fn recv_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the receive buffer that the operating system uses for the socket.

fn get_fileno(&self) -> Result<OsFile>

Gets the platform dependent file descriptor equivalent.

fn get_loop(&self) -> Loop

Returns the Loop associated with this handle.

fn get_type(&self) -> HandleType

Returns the type of the handle.

impl ToHandle for SignalHandle

fn to_handle(&self) -> Handle

impl TryFrom<Handle> for SignalHandle

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(handle: Handle) -> Result<Self, Self::Error>

Performs the conversion.