EgretDoc
Back to Home
Location:system/os.signal.posix

Module

Module documentation.

moduleos.signal.posix

Classes

Classes and inheritance.

Functions

Free functions and class methods.

functionos.signal.posix::mask_block
Signaturefunc mask_block() -> Int
func mask_block() -> Int {
    return 1;
}
@briefProvides the system library operation `mask_block`.
@detailsExecutes the `mask_block` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionos.signal.posix::mask_unblock
Signaturefunc mask_unblock() -> Int
func mask_unblock() -> Int {
    return 2;
}
@briefProvides the system library operation `mask_unblock`.
@detailsExecutes the `mask_unblock` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionos.signal.posix::mask_set
Signaturefunc mask_set() -> Int
func mask_set() -> Int {
    return 3;
}
@briefProvides the system library operation `mask_set`.
@detailsExecutes the `mask_set` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `Int`.
functionos.signal.posix::hangup
Signaturefunc hangup() -> os.signal.Signal
func hangup() -> os.signal.Signal {
    return os.signal.hangup();
}
@briefProvides the system library operation `hangup`.
@detailsExecutes the `hangup` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::quit
Signaturefunc quit() -> os.signal.Signal
func quit() -> os.signal.Signal {
    return os.signal.quit();
}
@briefProvides the system library operation `quit`.
@detailsExecutes the `quit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::user1
Signaturefunc user1() -> os.signal.Signal
func user1() -> os.signal.Signal {
    return os.signal.user1();
}
@briefProvides the system library operation `user1`.
@detailsExecutes the `user1` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::user2
Signaturefunc user2() -> os.signal.Signal
func user2() -> os.signal.Signal {
    return os.signal.user2();
}
@briefProvides the system library operation `user2`.
@detailsExecutes the `user2` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::alarm
Signaturefunc alarm() -> os.signal.Signal
func alarm() -> os.signal.Signal {
    return os.signal.alarm();
}
@briefProvides the system library operation `alarm`.
@detailsExecutes the `alarm` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::child
Signaturefunc child() -> os.signal.Signal
func child() -> os.signal.Signal {
    return os.signal.child();
}
@briefProvides the system library operation `child`.
@detailsExecutes the `child` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::broken_pipe
Signaturefunc broken_pipe() -> os.signal.Signal
func broken_pipe() -> os.signal.Signal {
    return os.signal.broken_pipe();
}
@briefProvides the system library operation `broken_pipe`.
@detailsExecutes the `broken_pipe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::window_change
Signaturefunc window_change() -> os.signal.Signal
func window_change() -> os.signal.Signal {
    return os.signal.window_change();
}
@briefProvides the system library operation `window_change`.
@detailsExecutes the `window_change` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::continued
Signaturefunc continued() -> os.signal.Signal
func continued() -> os.signal.Signal {
    return os.signal.continued();
}
@briefProvides the system library operation `continued`.
@detailsExecutes the `continued` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::stop_terminal
Signaturefunc stop_terminal() -> os.signal.Signal
func stop_terminal() -> os.signal.Signal {
    return os.signal.stop_terminal();
}
@briefProvides the system library operation `stop_terminal`.
@detailsExecutes the `stop_terminal` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::terminal_input
Signaturefunc terminal_input() -> os.signal.Signal
func terminal_input() -> os.signal.Signal {
    return os.signal.terminal_input();
}
@briefProvides the system library operation `terminal_input`.
@detailsExecutes the `terminal_input` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::terminal_output
Signaturefunc terminal_output() -> os.signal.Signal
func terminal_output() -> os.signal.Signal {
    return os.signal.terminal_output();
}
@briefProvides the system library operation `terminal_output`.
@detailsExecutes the `terminal_output` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::trap
Signaturefunc trap() -> os.signal.Signal
func trap() -> os.signal.Signal {
    return os.signal.trap();
}
@briefProvides the system library operation `trap`.
@detailsExecutes the `trap` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::abort
Signaturefunc abort() -> os.signal.Signal
func abort() -> os.signal.Signal {
    return os.signal.abort();
}
@briefProvides the system library operation `abort`.
@detailsExecutes the `abort` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::floating_point_exception
Signaturefunc floating_point_exception() -> os.signal.Signal
func floating_point_exception() -> os.signal.Signal {
    return os.signal.floating_point_exception();
}
@briefProvides the system library operation `floating_point_exception`.
@detailsExecutes the `floating_point_exception` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::illegal_instruction
Signaturefunc illegal_instruction() -> os.signal.Signal
func illegal_instruction() -> os.signal.Signal {
    return os.signal.illegal_instruction();
}
@briefProvides the system library operation `illegal_instruction`.
@detailsExecutes the `illegal_instruction` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::segmentation_fault
Signaturefunc segmentation_fault() -> os.signal.Signal
func segmentation_fault() -> os.signal.Signal {
    return os.signal.segmentation_fault();
}
@briefProvides the system library operation `segmentation_fault`.
@detailsExecutes the `segmentation_fault` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::bus_error
Signaturefunc bus_error() -> os.signal.Signal
func bus_error() -> os.signal.Signal {
    return os.signal.bus_error();
}
@briefProvides the system library operation `bus_error`.
@detailsExecutes the `bus_error` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::real_time_min
Signaturefunc real_time_min() -> os.signal.Signal
func real_time_min() -> os.signal.Signal {
    return os.signal.real_time_min();
}
@briefProvides the system library operation `real_time_min`.
@detailsExecutes the `real_time_min` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::real_time_max
Signaturefunc real_time_max() -> os.signal.Signal
func real_time_max() -> os.signal.Signal {
    return os.signal.real_time_max();
}
@briefProvides the system library operation `real_time_max`.
@detailsExecutes the `real_time_max` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::real_time
Signaturefunc real_time(offset: Int) -> os.signal.Signal
func real_time(offset: Int) -> os.signal.Signal {
    return os.signal.real_time(offset);
}
@briefProvides the system library operation `real_time`.
@detailsExecutes the `real_time` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • offsetByte offset measured from the start position.
@returnReturns the operation result as `os.signal.Signal`.
functionos.signal.posix::sigprocmask
Signaturefunc sigprocmask(how: Int, signals: ...os.signal.Signal) -> ErrCode
func sigprocmask(how: Int, signals: ...os.signal.Signal) -> ErrCode {
    if how == mask_block() {
        return os.signal.block(signals...);
@briefProvides the system library operation `sigprocmask`.
@detailsExecutes the `sigprocmask` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • howMode selector that specifies how the operation should be applied.
  • signalsSignal mask or signal collection used to configure signal handling.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionos.signal.posix::scoped_sigprocmask
Signaturefunc scoped_sigprocmask(how: Int, signals: ...os.signal.Signal) -> os.signal.MaskGuard, ErrCode
func scoped_sigprocmask(how: Int, signals: ...os.signal.Signal) -> os.signal.MaskGuard, ErrCode {
    if how == mask_block() {
        return os.signal.scoped_block(signals...);
@briefProvides the system library operation `scoped_sigprocmask`.
@detailsExecutes the `scoped_sigprocmask` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • howMode selector that specifies how the operation should be applied.
  • signalsSignal mask or signal collection used to configure signal handling.
@returnReturns `os.signal.MaskGuard, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionos.signal.posix::clear_mask
Signaturefunc clear_mask() -> ErrCode
func clear_mask() -> ErrCode {
    return os.signal.clear_mask();
}
@briefProvides the system library operation `clear_mask`.
@detailsExecutes the `clear_mask` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionos.signal.posix::is_blocked
Signaturefunc is_blocked(sig: os.signal.Signal) -> Bool, ErrCode
func is_blocked(sig: os.signal.Signal) -> Bool, ErrCode {
    return os.signal.is_blocked(sig);
}
@briefTests whether the state satisfies the condition represented by `is_blocked`.
@detailsExecutes the `is_blocked` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
  • sigSignal number or signal descriptor processed by the operation.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.

Variables

Class fields (var).