Move visualisationUpdate to a more appropriate place (#659)

This commit is contained in:
Adam Obuchowicz 2020-04-17 12:40:34 +02:00 committed by GitHub
parent 839967d2ac
commit 44e5341278
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -81,7 +81,6 @@ services components, as well as any open questions that may remain.
- [`file/receivesTreeUpdates`](#filereceivestreeupdates) - [`file/receivesTreeUpdates`](#filereceivestreeupdates)
- [`executionContext/canModify`](#executioncontextcanmodify) - [`executionContext/canModify`](#executioncontextcanmodify)
- [`executionContext/receiveUpdates`](#executioncontextreceiveupdates) - [`executionContext/receiveUpdates`](#executioncontextreceiveupdates)
- [`executionContext/visualisationUpdate`](#executioncontextvisualisationupdate)
- [File Management Operations](#file-management-operations) - [File Management Operations](#file-management-operations)
- [`file/write`](#filewrite) - [`file/write`](#filewrite)
- [`file/read`](#fileread) - [`file/read`](#fileread)
@ -122,6 +121,7 @@ services components, as well as any open questions that may remain.
- [`executionContext/attachVisualisation`](#executioncontextattachvisualisation) - [`executionContext/attachVisualisation`](#executioncontextattachvisualisation)
- [`executionContext/detachVisualisation`](#executioncontextdetachvisualisation) - [`executionContext/detachVisualisation`](#executioncontextdetachvisualisation)
- [`executionContext/modifyVisualisation`](#executioncontextmodifyvisualisation) - [`executionContext/modifyVisualisation`](#executioncontextmodifyvisualisation)
- [`executionContext/visualisationUpdate`](#executioncontextvisualisationupdate)
- [Errors - Language Server](#errors---language-server) - [Errors - Language Server](#errors---language-server)
<!-- /MarkdownTOC --> <!-- /MarkdownTOC -->
@ -1434,46 +1434,6 @@ a given execution context.
##### Disables ##### Disables
None 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 ### File Management Operations
The language server also provides file operations to the IDE. The language server also provides file operations to the IDE.
@ -2573,6 +2533,46 @@ null
##### Errors ##### Errors
TBC 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 ### Errors - Language Server
The language server component also has its own set of errors. This section is 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. 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, "code" : 6002,
"message" : "Session already initialised" "message" : "Session already initialised"
} }
``` ```