Class CommManager

Public constructor

Param

@jupyterlab/services Kernel.IKernel instance

Hierarchy

CommManager

Index

Constructors

Properties

comms jsServicesKernel kernel targets

Methods

init_kernel new_comm register_comm register_target unregister_target

Constructors

constructor

new CommManager(jsServicesKernel: IKernelConnection): CommManager
Parameters
- jsServicesKernel: IKernelConnection
Returns CommManager
- Defined in packages/base/src/services-shim.ts:100

Properties

comms

comms: any = ...

jsServicesKernel

jsServicesKernel: IKernelConnection

kernel

kernel: IKernelConnection

targets

targets: any = ...

Methods

init_kernel

init_kernel(jsServicesKernel: IKernelConnection): void
Hookup kernel events.
Parameters
- jsServicesKernel: IKernelConnection
  
  @jupyterlab/services Kernel.IKernel instance
Returns void
- Defined in packages/base/src/services-shim.ts:108

new_comm

new_comm(target_name: string, data: any, callbacks: any, metadata: any, comm_id: string, buffers?: ArrayBuffer[] | ArrayBufferView[]): Promise<Comm>
Creates a new connected comm
Parameters
- target_name: string
- data: any
- callbacks: any
- metadata: any
- comm_id: string
- Optional buffers: ArrayBuffer[] | ArrayBufferView[]
Returns Promise<Comm>
- Defined in packages/base/src/services-shim.ts:116

register_comm

register_comm(comm: Comm): string
Register a comm in the mapping
Parameters
- comm: Comm
Returns string
- Defined in packages/base/src/services-shim.ts:177

register_target

register_target(target_name: string, f: ((comm: Comm, object: IMessage<MessageType>) => void)): void
Register a comm target
Parameters
- target_name: string
- f: ((comm: Comm, object: IMessage<MessageType>) => void)
  
  callback that is called when the comm is made. Signature of f(comm, msg).
  - - (comm: Comm, object: IMessage<MessageType>): void
    - Parameters
      
      comm: Comm
      
      object: IMessage<MessageType>
      
      Returns void
Returns void
- Defined in packages/base/src/services-shim.ts:137

unregister_target

unregister_target(target_name: string, f: ((comm: Comm, object: IMessage<MessageType>) => void)): void
Unregisters a comm target
Parameters
- target_name: string
- f: ((comm: Comm, object: IMessage<MessageType>) => void)
  - - (comm: Comm, object: IMessage<MessageType>): void
    - Parameters
      
      comm: Comm
      
      object: IMessage<MessageType>
      
      Returns void
Returns void
- Defined in packages/base/src/services-shim.ts:165

Generated using TypeDoc