Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_Private_The current connection status of the kernel.
A signal emitted when the kernel connection status changes.
A signal emitted when the object is disposed.
The id of the server-side kernel.
A signal emitted after an iopub kernel message is handled.
The kernel model, for convenience.
The name of the server-side kernel.
A signal emitted when a kernel has pending inputs from the user.
The server settings for the kernel.
The current status of the kernel.
A signal emitted when the kernel status changes.
The subshell ID, main shell has null.
Check if this kernel supports JEP 91 kernel subshells.
A signal emitted for unhandled non-iopub kernel messages that claimed to be responses for messages we sent using this kernel object.
The client username.
The client username.
Private_Handles incoming WebSocket messages and emits appropriate signals.
Clone the current kernel with a new clientId.
Optional_options: Partial<Kernel.IKernelConnection.IOptions>Create a new comm.
Optional_commId: stringA comm instance.
Dispose of the resources held by the object.
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Check if a comm exists.
Interrupt a kernel.
A promise that resolves when the kernel has interrupted.
Uses the Jupyter Server API.
The promise is fulfilled on a valid response and rejected otherwise.
It is assumed that the API call does not mutate the kernel id or name.
The promise will be rejected if the kernel status is 'dead' or if the
request fails or the response is invalid.
Remove the input guard, if any.
Send a comm_info_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the comm_info_reply content when the shell reply is
received and validated.
Send a complete_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the complete_reply content when the shell reply is
received and validated.
Send a create_subshell_request message.
Optional_disposeOnDone: booleanA promise that resolves with the response message.
Send a delete_subshell_request message.
Optional_disposeOnDone: booleanA promise that resolves with the response message.
Send an execute_request message.
The content of the request.
OptionaldisposeOnDone: booleanWhether to dispose of the future when done.
Optionalmetadata: unknownA kernel future.
See Messaging in Jupyter.
This method returns a kernel future, rather than a promise, since execution may have many response messages (for example, many iopub display messages).
Future onReply is called with the execute_reply content when the
shell reply is received and validated.
See also: [[IExecuteReply]]
Send a history_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the history_reply content when the shell reply is
received and validated.
Send an inspect_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the inspect_reply content when the shell reply is
received and validated.
Send an is_complete_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the is_complete_response content when the shell reply is
received and validated.
Send a kernel_info_request message.
A promise that resolves with the response message.
See Messaging in Jupyter.
Fulfills with the kernel_info_response content when the shell reply is
received and validated.
Send a list_subshell_request message.
Optional_disposeOnDone: booleanA promise that resolves with the response message.
Restart a kernel.
A promise that resolves when the kernel has restarted.
Uses the Jupyter Server API and validates the response model.
Any existing Future or Comm objects are cleared.
It is assumed that the API call does not mutate the kernel id or name.
The promise will be rejected if the kernel status is 'dead' or if the
request fails or the response is invalid.
Send an input_reply message.
Shutdown a kernel.
A promise that resolves when the kernel has shut down.
Uses the Jupyter Notebook API.
On a valid response, closes the websocket, disposes of the kernel object, and fulfills the promise.
The promise will be rejected if the kernel status is 'dead', the
request fails, or the response is invalid.
A custom KernelConnection that wraps a local kernel WebSocket. This bypasses the session management and provides a pre-connected kernel.