Skip to content

Commit 0c29843

Browse files
MichaelOrlovmorlov-apexai
authored andcommitted
Address review comment
- Replaced `handle_sigint` to the `install_signal_handler` Signed-off-by: Michael Orlov <michael.orlov@apex.ai>
1 parent 417cb65 commit 0c29843

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/design/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,9 @@ via pressing `Ctrl+C`. This signal handling could overlap with registered specif
111111
handler on upper level or inside keyboard handler's clients. To avoid this overlap keyboard handler
112112
will save previous `SIGINT` handler and call it after processing its own signal handler. It will
113113
also restore the previous `SIGINT` handler in destructor. The keyboard handler constructor has an
114-
optional parameter `bool handle_sigint` which by default is set to `true`. If this parameter
115-
is set to `false`, keyboard handler will not register its own `SIGINT` handler and will not
116-
restore previous `SIGINT` handler in destructor. This could be useful in cases when client
114+
optional parameter `bool install_signal_handler` which by default is set to `true`. If this
115+
parameter is set to `false`, keyboard handler will not register its own `SIGINT` handler and
116+
will not restore previous `SIGINT` handler in destructor. This could be useful in cases when client
117117
code already registered its own `SIGINT` handler and don't want to overlap it with keyboard
118118
handler's one. In this case client code should be responsible for restoring terminal input in
119119
canonical mode after abnormal program termination via pressing `Ctrl+C` by calling static method
@@ -249,4 +249,3 @@ issues:
249249
`F1..F12` and other control keys.
250250
- Windows implementation not able to detect `CTRL` + `ALT` + `key` combinations.
251251
- Windows implementation not able to detect `ALT` + `F1..12` keys.
252-

0 commit comments

Comments
 (0)