Readonly commThe unique id for the comm channel.
Readonly isCallback for a comm close event.
This is called when the comm is closed from either the server or client. If this is called in response to a kernel message and the handler returns a promise, all kernel message processing pauses until the promise is resolved.
Callback for a comm message received event.
If the handler returns a promise, all kernel message processing pauses until the promise is resolved.
Readonly targetThe target name for the comm channel.
Close the comm.
Optional data: JSONValueThe data to send to the server on opening.
Optional metadata: JSONObjectAdditional metadata for the message.
Optional buffers: (ArrayBuffer | ArrayBufferView)[]A future for the generated message.
This will send a comm_close message to the kernel, and call the
onClose callback if set.
This is a no-op if the comm is already closed.
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.
Open a comm with optional data and metadata.
Optional data: JSONValueThe data to send to the server on opening.
Optional metadata: JSONObjectAdditional metadata for the message.
Optional buffers: (ArrayBuffer | ArrayBufferView)[]A future for the generated message.
This sends a comm_open message to the server.
Send a comm_msg message to the kernel.
The data to send to the server on opening.
Optional metadata: JSONObjectAdditional metadata for the message.
Optional buffers: (ArrayBuffer | ArrayBufferView)[]Optional buffer data.
Optional disposeOnDone: booleanWhether to dispose of the future when done.
A future for the generated message.
This is a no-op if the comm has been closed.
Generated using TypeDoc
A client side Comm interface.