diff options
| author | Eugene Ostroukhov <eostroukhov@gmail.com> | 2019-07-26 20:40:54 +0300 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-09-25 19:20:55 +0300 |
| commit | a26865849631b370866db04ac808373606164191 (patch) | |
| tree | 1e652f29cefae8d13c48d0b2e92bcd3265475930 /doc/api | |
| parent | bbf209b5df201d60b603b6eff4d95017954273a2 (diff) | |
inspector: new API - Session.connectToMainThread
This API is designed to enable worker threads use Inspector protocol
on main thread (and other workers through NodeWorker domain).
Note that worker can cause dead lock by suspending itself. I will
work on a new API that will allow workers to be hidden from the
inspector.
Fixes: https://github.com/nodejs/node/issues/28828
PR-URL: https://github.com/nodejs/node/pull/28870
Reviewed-By: Aleksei Koziatinskii <ak239spb@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/errors.md | 6 | ||||
| -rw-r--r-- | doc/api/inspector.md | 12 |
2 files changed, 15 insertions, 3 deletions
diff --git a/doc/api/errors.md b/doc/api/errors.md index d2946435ca3..87a080b081f 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1213,6 +1213,12 @@ The `inspector` module is not available for use. While using the `inspector` module, an attempt was made to use the inspector before it was connected. +<a id="ERR_INSPECTOR_NOT_WORKER"></a> +### ERR_INSPECTOR_NOT_WORKER + +An API was called on the main thread that can only be used from +the worker thread. + <a id="ERR_INVALID_ADDRESS_FAMILY"></a> ### ERR_INVALID_ADDRESS_FAMILY diff --git a/doc/api/inspector.md b/doc/api/inspector.md index f82c53f5bc3..96c3ad03c06 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -121,9 +121,15 @@ session.on('Debugger.paused', ({ params }) => { added: v8.0.0 --> -Connects a session to the inspector back-end. An exception will be thrown -if there is already a connected session established either through the API or by -a front-end connected to the Inspector WebSocket port. +Connects a session to the inspector back-end. + +### session.connectToMainThread() +<!-- YAML +added: REPLACEME +--> + +Connects a session to the main thread inspector back-end. An exception will +be thrown if this API was not called on a Worker thread. ### session.disconnect() <!-- YAML |