Package Exports
- vscode-ws-jsonrpc
- vscode-ws-jsonrpc/lib
- vscode-ws-jsonrpc/lib/disposable
- vscode-ws-jsonrpc/lib/logger
- vscode-ws-jsonrpc/lib/server
- vscode-ws-jsonrpc/lib/server/launch
- vscode-ws-jsonrpc/lib/socket/connection
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vscode-ws-jsonrpc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
VSCode WebSocket JSON RPC
NPM module to implement communication between a jsonrpc client and server over WebSocket.
Client side connection handling
import * as rpc from 'vscode-ws-jsonrpc';
const webSocket = new WebSocket('ws://www.example.com/socketserver');
rpc.listen({
webSocket,
onConnection: (connection: rpc.MessageConnection) => {
const notification = new rpc.NotificationType<string, void>('testNotification');
connection.listen();
connection.sendNotification(notification, 'Hello World');
}
});Server side connection handling
import * as rpc from 'vscode-ws-jsonrpc';
const socket: rpc.IWebSocket; // open the web socket
const reader = new rpc.WebSocketMessageReader(socket);
const writer = new rpc.WebSocketMessageWriter(socket);
const logger = new rpc.ConsoleLogger();
const connection = rpc.createMessageConnection(reader, writer, logger);
const notification = new rpc.NotificationType<string, void>('testNotification');
connection.onNotification(notification, (param: string) => {
console.log(param); // This prints Hello World
});
connection.listen();Server side connection forwarding
import * as rpc from 'vscode-ws-jsonrpc';
import * as server from 'vscode-ws-jsonrpc/lib/server';
const socket: rpc.IWebSocket; // open the web socket
const reader = new rpc.WebSocketMessageReader(socket);
const writer = new rpc.WebSocketMessageWriter(socket);
const socketConnection = server.createConnection(reader, writer, () => socket.dispose())
const serverConnection = server.createServerProcess('Example', 'node', ['example.js']);
server.forward(socketConnection, serverConnection, message => {
if (rpc.isNotificationMessage(message)) {
if (message.method === 'testNotification') {
// handle the test notification
}
}
return message;
});