luo980/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: describe signal send emulation on windows

Browse Source 
Signals don't exist on Windows, but libuv emulates the behaviour of
several Unix signals. This wasn't documented, and the existing
documentation for signal reception emulation on Windows was worded as if
it applied to signal sending, which it does not.
This commit is contained in:
Sam Roberts 2014-01-15 14:20:55 -08:00 committed by Saúl Ibarra Corretgé
parent 451de61b72
commit a3c0e48faa
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
include/uv.h
View File

@ -1549,11 +1549,27 @@ UV_EXTERN int uv_spawn(uv_loop_t* loop,
/*
* Kills the process with the specified signal. The user must still
* call uv_close on the process.
*
* Emulates some aspects of Unix exit status on Windows, in that while the
* underlying process will be terminated with a status of `1`,
* `uv_process_t.exit_signal` will be set to signum, so the process will appear
* to have been killed by `signum`.
*/
UV_EXTERN int uv_process_kill(uv_process_t*, int signum);
/* Kills the process with the specified signal. */
/* Kills the process with the specified signal.
*
* Emulates some aspects of Unix signals on Windows:
* - SIGTERM, SIGKILL, and SIGINT call TerminateProcess() to unconditionally
* cause the target to exit with status 1. Unlike Unix, this cannot be caught
* or ignored (but see uv_process_kill() and uv_signal_start()).
* - Signal number `0` causes a check for target existence, as in Unix. Return
* value is 0 on existence, UV_ESRCH on non-existence.
*
* Returns 0 on success, or an error code on failure. UV_ESRCH is portably used
* for non-existence of target process, other errors may be system specific.
*/
UV_EXTERN int uv_kill(int pid, int signum);
@ -1849,7 +1865,7 @@ UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle);
* signals will lead to unpredictable behavior and is strongly discouraged.
* Future versions of libuv may simply reject them.
*
* Some signal support is available on Windows:
* Reception of some signals is emulated on Windows:
*
* SIGINT is normally delivered when the user presses CTRL+C. However, like
* on Unix, it is not generated when terminal raw mode is enabled.
@ -1868,11 +1884,14 @@ UV_EXTERN int uv_fs_poll_stop(uv_fs_poll_t* handle);
* the console buffer will also trigger a SIGWINCH signal.
*
* Watchers for other signals can be successfully created, but these signals
* are never generated. These signals are: SIGILL, SIGABRT, SIGFPE, SIGSEGV,
* are never received. These signals are: SIGILL, SIGABRT, SIGFPE, SIGSEGV,
* SIGTERM and SIGKILL.
*
* Note that calls to raise() or abort() to programmatically raise a signal are
* not detected by libuv; these will not trigger a signal watcher.
*
* See uv_process_kill() and uv_kill() for information about support for sending
* signals.
*/
struct uv_signal_s {
UV_HANDLE_FIELDS