From 44e53412789b35d71b68c656331439d22bcd5720 Mon Sep 17 00:00:00 2001 From: Adam Obuchowicz Date: Fri, 17 Apr 2020 12:40:34 +0200 Subject: [PATCH] Move `visualisationUpdate` to a more appropriate place (#659) --- .../specification/enso-protocol.md | 84 +++++++++---------- 1 file changed, 42 insertions(+), 42 deletions(-) diff --git a/doc/language-server/specification/enso-protocol.md b/doc/language-server/specification/enso-protocol.md index 10b66716c8..6b0d4ac9f1 100644 --- a/doc/language-server/specification/enso-protocol.md +++ b/doc/language-server/specification/enso-protocol.md @@ -81,7 +81,6 @@ services components, as well as any open questions that may remain. - [`file/receivesTreeUpdates`](#filereceivestreeupdates) - [`executionContext/canModify`](#executioncontextcanmodify) - [`executionContext/receiveUpdates`](#executioncontextreceiveupdates) - - [`executionContext/visualisationUpdate`](#executioncontextvisualisationupdate) - [File Management Operations](#file-management-operations) - [`file/write`](#filewrite) - [`file/read`](#fileread) @@ -122,6 +121,7 @@ services components, as well as any open questions that may remain. - [`executionContext/attachVisualisation`](#executioncontextattachvisualisation) - [`executionContext/detachVisualisation`](#executioncontextdetachvisualisation) - [`executionContext/modifyVisualisation`](#executioncontextmodifyvisualisation) + - [`executionContext/visualisationUpdate`](#executioncontextvisualisationupdate) - [Errors - Language Server](#errors---language-server) @@ -1434,46 +1434,6 @@ a given execution context. ##### Disables None -#### `executionContext/visualisationUpdate` -This message is responsible for providing a visualisation data update to the -client. - -- **Type:** Notification -- **Direction:** Server -> Client -- **Connection:** Data -- **Visibility:** Public - -The `visualisationData` component of the table definition _must_ be -pre-serialized before being inserted into this message. As far as this level of -transport is concerned, it is just a binary blob. - -##### Parameters - -```idl -namespace executionContext; - -struct UUID { - lowBytes:uint64; - highBytes:uint64; -} - -struct VisualisationContext { - visualisationId:UUID; - contextId:UUID; - expressionId:UUID; -} - -struct VisualisationUpdate { - visualisationContext:VisualisationContext; - data:[ubyte]; -} - -root_type VisualisationUpdate; -``` - -##### Errors -N/A - ### File Management Operations The language server also provides file operations to the IDE. @@ -2573,6 +2533,46 @@ null ##### Errors TBC +#### `executionContext/visualisationUpdate` +This message is responsible for providing a visualisation data update to the +client. + +- **Type:** Notification +- **Direction:** Server -> Client +- **Connection:** Data +- **Visibility:** Public + +The `visualisationData` component of the table definition _must_ be +pre-serialized before being inserted into this message. As far as this level of +transport is concerned, it is just a binary blob. + +##### Parameters + +```idl +namespace executionContext; + +struct UUID { + lowBytes:uint64; + highBytes:uint64; +} + +struct VisualisationContext { + visualisationId:UUID; + contextId:UUID; + expressionId:UUID; +} + +struct VisualisationUpdate { + visualisationContext:VisualisationContext; + data:[ubyte]; +} + +root_type VisualisationUpdate; +``` + +##### Errors +N/A + ### Errors - Language Server The language server component also has its own set of errors. This section is not a complete specification and will be updated as new errors are added. @@ -2838,4 +2838,4 @@ Signals that session is already initialised. "code" : 6002, "message" : "Session already initialised" } -``` \ No newline at end of file +```