From 1409b6ae110f60c410e83d1923dd59ae3659a887 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?=
Date: Wed, 1 Feb 2017 16:44:50 +0100
Subject: kernel: Document signal server
---
lib/kernel/doc/src/kernel_app.xml | 59 +++++++++++++++++++++++++++++++++++++--
lib/kernel/doc/src/os.xml | 31 ++++++++++++++++++--
2 files changed, 84 insertions(+), 6 deletions(-)
(limited to 'lib')
diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index df681a505f..c581fa9d1e 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -11,7 +11,7 @@
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -19,7 +19,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
+
kernel
@@ -57,6 +57,60 @@
error_logger(3).
+
+ OS Signal Event Handler
+ Asynchronous OS signals may be subscribed to via the Kernel applications event manager
+ (see OTP Design Principles and
+ gen_event(3)) registered as erl_signal_server.
+ A default signal handler is installed which handles the following signals:
+
+ sigusr1
+ The default handler will halt Erlang and produce a crashdump
+ with slogan "Received SIGUSR1".
+ This is equivalent to calling erlang:halt("Received SIGUSR1").
+
+
+ sigquit
+ The default handler will halt Erlang immediately.
+ This is equivalent to calling erlang:halt().
+
+
+ sigterm
+ The default handler will terminate Erlang normally.
+ This is equivalent to calling init:stop().
+
+
+
+
+ Events
+ Any event handler added to erl_signal_server must handle the following events.
+
+ sighup
+ Hangup detected on controlling terminal or death of controlling process
+ sigquit
+ Quit from keyboard
+ sigabrt
+ Abort signal from abort
+ sigalrm
+ Timer signal from alarm
+ sigterm
+ Termination signal
+ sigusr1
+ User-defined signal 1
+ sigusr2
+ User-defined signal 2
+ sigchld
+ Child process stopped or terminated
+ sigstop
+ Stop process
+ sigtstp
+ Stop typed at terminal
+
+
+ Setting OS signals are described in os:set_signal/2.
+
+
+
Configuration
The following configuration parameters are defined for the Kernel
@@ -405,4 +459,3 @@ MaxT = TickTime + TickTime / 4
timer(3)
-
diff --git a/lib/kernel/doc/src/os.xml b/lib/kernel/doc/src/os.xml
index 739ac35d2a..6ba69d12a3 100644
--- a/lib/kernel/doc/src/os.xml
+++ b/lib/kernel/doc/src/os.xml
@@ -11,7 +11,7 @@
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
@@ -19,7 +19,7 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
+
os
@@ -155,6 +155,32 @@ DirOut = os:cmd("dir"), % on Win32 platform
+
+
+ Enables or disables handling of OS signals.
+
+ Enables or disables OS signals.
+ Each signal my be set to one of the following options:
+
+ ignore
+ -
+ This signal will be ignored.
+
+
+ default
+ -
+ This signal will use the default signal handler for the operating system.
+
+
+ handle
+ -
+ This signal will notify erl_signal_server when it is received by
+ the Erlang runtime system.
+
+
+
+
+
Current OS system time.
@@ -296,4 +322,3 @@ calendar:now_to_universal_time(TS),
-
--
cgit v1.2.3