Interface IClassicComm

Hierarchy

IClassicComm

Implemented by

Comm

Index

Properties

comm_id target_name

Methods

close on_close on_msg open send

Properties

comm_id

comm_id: string

Comm id

Returns

target_name

target_name: string

Target name

Returns

Methods

close

close(data?: JSONValue, callbacks?: ICallbacks, metadata?: JSONObject, buffers?: ArrayBuffer[] | ArrayBufferView[]): string
Closes the sibling comm in the backend

Returns
msg id
Parameters
- Optional data: JSONValue
- Optional callbacks: ICallbacks
- Optional metadata: JSONObject
- Optional buffers: ArrayBuffer[] | ArrayBufferView[]
Returns string
- Defined in packages/base/src/services-shim.ts:73

on_close

on_close(callback: ((x: any) => void)): void
Register a handler for when the comm is closed by the backend
Parameters
- callback: ((x: any) => void)
  - - (x: any): void
    - Parameters
      
      x: any
      
      Returns void
Returns void
- Defined in packages/base/src/services-shim.ts:90

on_msg

on_msg(callback: ((x: any) => void)): void
Register a message handler
Parameters
- callback: ((x: any) => void)
  - - (x: any): void
    - Parameters
      
      x: any
      
      Returns void
Returns void
- Defined in packages/base/src/services-shim.ts:84

open

open(data: JSONValue, callbacks?: ICallbacks, metadata?: JSONObject, buffers?: ArrayBuffer[] | ArrayBufferView[]): string
Opens a sibling comm in the backend

Returns
msg id
Parameters
- data: JSONValue
- Optional callbacks: ICallbacks
- Optional metadata: JSONObject
- Optional buffers: ArrayBuffer[] | ArrayBufferView[]
Returns string
- Defined in packages/base/src/services-shim.ts:43

send

send(data: JSONValue, callbacks?: ICallbacks, metadata?: JSONObject, buffers?: ArrayBuffer[] | ArrayBufferView[]): string
Sends a message to the sibling comm in the backend

Returns
message id
Parameters
- data: JSONValue
- Optional callbacks: ICallbacks
- Optional metadata: JSONObject
- Optional buffers: ArrayBuffer[] | ArrayBufferView[]
Returns string
- Defined in packages/base/src/services-shim.ts:58

Generated using TypeDoc