CommHandler

Kind of message broker between the Jupyter UI and the kernel.

See https://jupyter-client.readthedocs.io/en/5.2.3/messaging.html#custom-messages.

Typically available in the implicit scope of user code run via the kernel.

Can be used by users to send messages to custom code running in the browser, and receive messages from it.

Registering a target with name "target_name" allows to receive messages from frontends. From the Jupyter classic UI, one can send messages to this target via code like

var comm = Jupyter.notebook.kernel.comm_manager.new_comm("target_name", '{"a": 2, "b": false}');
comm.open();
comm.send('{"c": 2, "d": {"foo": [1, 2]}}');

Linear Supertypes

UpdateHelpers, UpdateDisplay, AnyRef, Any

Instance Constructors

new CommHandler()

Abstract Value Members

abstract def commClose(id: String, data: String): Unit
abstract def commMessage(id: String, data: String): Unit
abstract def commOpen(targetName: String, id: String, data: String): Unit
abstract def registerCommTarget(name: String, target: CommTarget): Unit
abstract def unregisterCommTarget(name: String): Unit
abstract def updateDisplay(displayData: DisplayData): Unit

Updates a previously published element.
Updates a previously published element.

Definition Classes
UpdateDisplay

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def receiver(name: String, onOpen: (String, String) ⇒ Unit = (_, _) => (), onClose: (String, String) ⇒ Unit = (_, _) => ())(onMessage: (String) ⇒ Unit): Unit
final def sender(targetName: String, id: String = UUID.randomUUID().toString, data: String = "{}"): Comm
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def updateHtml(html0: String, id: String): Unit

Definition Classes
UpdateHelpers
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CommHandler | package api

abstract class CommHandler extends UpdateHelpers

Instance Constructors

new CommHandler()

Abstract Value Members

abstract def commClose(id: String, data: String): Unit

abstract def commMessage(id: String, data: String): Unit

abstract def commOpen(targetName: String, id: String, data: String): Unit

abstract def registerCommTarget(name: String, target: CommTarget): Unit

abstract def unregisterCommTarget(name: String): Unit

abstract def updateDisplay(displayData: DisplayData): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def receiver(name: String, onOpen: (String, String) ⇒ Unit = (_, _) => (), onClose: (String, String) ⇒ Unit = (_, _) => ())(onMessage: (String) ⇒ Unit): Unit

final def sender(targetName: String, id: String = UUID.randomUUID().toString, data: String = "{}"): Comm

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def updateHtml(html0: String, id: String): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from UpdateHelpers

Inherited from UpdateDisplay

Inherited from AnyRef

Inherited from Any

Ungrouped