/
comm.ts
219 lines (204 loc) · 5.4 KB
/
comm.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { JSONObject } from '@lumino/coreutils';
import { DisposableDelegate } from '@lumino/disposable';
import * as Kernel from './kernel';
import * as KernelMessage from './messages';
/**
* Comm channel handler.
*/
export class CommHandler extends DisposableDelegate implements Kernel.IComm {
/**
* Construct a new comm channel.
*/
constructor(
target: string,
id: string,
kernel: Kernel.IKernelConnection,
disposeCb: () => void
) {
super(disposeCb);
this._id = id;
this._target = target;
this._kernel = kernel;
}
/**
* The unique id for the comm channel.
*/
get commId(): string {
return this._id;
}
/**
* The target name for the comm channel.
*/
get targetName(): string {
return this._target;
}
/**
* Get the callback for a comm close event.
*
* #### Notes
* This is called when the comm is closed from either the server or client.
*
* **See also:** [[ICommClose]], [[close]]
*/
get onClose(): (
msg: KernelMessage.ICommCloseMsg
) => void | PromiseLike<void> {
return this._onClose;
}
/**
* Set the callback for a comm close event.
*
* #### Notes
* This is called when the comm is closed from either the server or client. If
* the function returns a promise, and the kernel was closed from the server,
* kernel message processing will pause until the returned promise is
* fulfilled.
*
* **See also:** [[close]]
*/
set onClose(
cb: (msg: KernelMessage.ICommCloseMsg) => void | PromiseLike<void>
) {
this._onClose = cb;
}
/**
* Get the callback for a comm message received event.
*/
get onMsg(): (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void> {
return this._onMsg;
}
/**
* Set the callback for a comm message received event.
*
* #### Notes
* This is called when a comm message is received. If the function returns a
* promise, kernel message processing will pause until it is fulfilled.
*/
set onMsg(cb: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>) {
this._onMsg = cb;
}
/**
* Open a comm with optional data and metadata.
*
* #### Notes
* This sends a `comm_open` message to the server.
*
* **See also:** [[ICommOpen]]
*/
open(
data?: JSONObject,
metadata?: JSONObject,
buffers: (ArrayBuffer | ArrayBufferView)[] = []
): Kernel.IShellFuture {
if (this.isDisposed || this._kernel.isDisposed) {
throw new Error('Cannot open');
}
const msg = KernelMessage.createMessage({
msgType: 'comm_open',
channel: 'shell',
username: this._kernel.username,
session: this._kernel.clientId,
content: {
comm_id: this._id,
target_name: this._target,
data: data ?? {}
},
metadata,
buffers
});
return this._kernel.sendShellMessage(msg, false, true);
}
/**
* Send a `comm_msg` message to the kernel.
*
* #### Notes
* This is a no-op if the comm has been closed.
*
* **See also:** [[ICommMsg]]
*/
send(
data: JSONObject,
metadata?: JSONObject,
buffers: (ArrayBuffer | ArrayBufferView)[] = [],
disposeOnDone: boolean = true
): Kernel.IShellFuture {
if (this.isDisposed || this._kernel.isDisposed) {
throw new Error('Cannot send');
}
const msg = KernelMessage.createMessage({
msgType: 'comm_msg',
channel: 'shell',
username: this._kernel.username,
session: this._kernel.clientId,
content: {
comm_id: this._id,
data: data
},
metadata,
buffers
});
return this._kernel.sendShellMessage(msg, false, disposeOnDone);
}
/**
* Close the comm.
*
* #### Notes
* 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.
*
* **See also:** [[ICommClose]], [[onClose]]
*/
close(
data?: JSONObject,
metadata?: JSONObject,
buffers: (ArrayBuffer | ArrayBufferView)[] = []
): Kernel.IShellFuture {
if (this.isDisposed || this._kernel.isDisposed) {
throw new Error('Cannot close');
}
const msg = KernelMessage.createMessage({
msgType: 'comm_close',
channel: 'shell',
username: this._kernel.username,
session: this._kernel.clientId,
content: {
comm_id: this._id,
data: data ?? {}
},
metadata,
buffers
});
const future = this._kernel.sendShellMessage(msg, false, true);
const onClose = this._onClose;
if (onClose) {
const ioMsg = KernelMessage.createMessage({
msgType: 'comm_close',
channel: 'iopub',
username: this._kernel.username,
session: this._kernel.clientId,
content: {
comm_id: this._id,
data: data ?? {}
},
metadata,
buffers
});
// In the future, we may want to communicate back to the user the possible
// promise returned from onClose.
void onClose(ioMsg);
}
this.dispose();
return future;
}
private _target = '';
private _id = '';
private _kernel: Kernel.IKernelConnection;
private _onClose: (
msg: KernelMessage.ICommCloseMsg<'iopub'>
) => void | PromiseLike<void>;
private _onMsg: (msg: KernelMessage.ICommMsgMsg) => void | PromiseLike<void>;
}