diff --git a/spec/VISSv2_Core.html b/spec/VISSv2_Core.html index c1afaad..02079d0 100644 --- a/spec/VISSv2_Core.html +++ b/spec/VISSv2_Core.html @@ -188,7 +188,7 @@
Purpose: Get asynchronous messages containing the value(s) addressed by the path. - The triggering rules for issuing the notification messages are set by the filter data.
+ The triggering rules for issuing the event messages are set by the filter data.The client MAY have to obtain an authorization token before being able to subscribe to the vehicle signal(s). - The server MUST issue a notification if a trigger rule is fulfilled. + The server MUST issue an event message if a trigger rule is fulfilled. If the server is able to satisfy the request it MUST return a success response. If the server is unable to fulfil the request, then the server MUST return an error response. - If an error occurs during the subscription period, the server SHOULD return an error notification.
+ If an error occurs during the subscription period, the server SHOULD return an error event.Arguments, of which path and filter are mandatory:
Success response:
Purpose: Termination of the subscription period started by a previous subscribe request.
If the server is able to satisfy the request it MUST return a success response, - and it MUST stop issuing notifications associated to the subscription handle. + and it MUST stop issuing event messages associated to the subscription handle. If the server is unable to fulfil the request, then the server MUST return an error response.
Arguments, of which subscriptionId is mandatory:
Purpose: Asynchronous client notification according to the subscribe request trigger rules.
-The server MUST issue a notification message when a triggering rule associated with the subscription is met. - If the server cannot fulfill the triggering rules it MUST issue an error notification and terminate the subscription. +
Purpose: Asynchronous client event message according to the subscribe request trigger rules.
+The server MUST issue an event message when a triggering rule associated with the subscription is met. + If the server cannot fulfill the triggering rules it MUST issue an error event message and terminate the subscription.
Arguments:
The server MUST inform a client about errors ocurring in interactions between the two, whether it is in a synchronous - error response, or an asynchronous error notification as a result of a previous subscribe. The error message has three arguments, - of which subscriptionId is mandatory only for error notifications. + error response, or an asynchronous error event message as a result of a previous subscribe. The error message has three arguments, + of which subscriptionId is mandatory only for error event messages.
Arguments:
One logical "boundary operator" evaluates the current signal value in relation to the boundary.
- If evaluated to true, the server issues a notification message containing the signal value to the subscribing client.
+ If evaluated to true, the server issues an event message containing the signal value to the subscribing client.
The boundary operator MUST be one of the values shown in the footer (**).
Examples
{"boundary-op":"gt", "boundary": "5"} // x > 5
@@ -679,7 +679,7 @@
Two boundaries with respective boundary operators are evaluated relative to the current signal value. The logical outcome of the two evaluations are applied as input to a logical AND/OR operation. - If evaluated to true, the server issues a notification message containing the signal value to the subscribing client. + If evaluated to true, the server issues an event message containing the signal value to the subscribing client. Besides the mandatory "boundary-op", and "boundary" key-value pairs in each JSON object, the first object may contain a "combination-op" key value pair, which then MUST have either the value "AND", or the value "OR". If omitted, the result of the two boundary evaluations is per default applied to an AND operation. @@ -892,18 +892,18 @@
A subscription request must always contain a filter operation that describes the trigger event that leads to - that the server dispatches an asynchronous notification message. + that the server dispatches an asynchronous event message. For the filter types "range" or "change", the triggering is dependent on the signal value. When the request addresses multiple signals, the triggering condition shall only be evaluated on one of the signals, which is the first signal in the value array of paths. The first path in the array must therefore not contain wildcards to address multiple signals. In this case one of the path addresses in the wildcard expression must be selected as the first array element, which can then be followed by the wildcard expression. - The duplicate reference to one signal that this leads to shall be resolved by the server to a singleton in the notifications. + The duplicate reference to one signal that this leads to shall be resolved by the server to a singleton in the event messages.
If more than one WebSocket connection is established between a client application and the server then each connection MUST be managed independently. For example, subscriptions created using a particular - WebSocket connection shall only trigger notifications via that connection and the client + WebSocket connection shall only trigger event messages via that connection and the client MUST use that WebSocket connection to unsubscribe.
@@ -1021,26 +1021,26 @@
The client may send a subscribeRequest message
to request a subscription to one or more signals,
- thereby requesting the server to repeatedly return subscription notification messages, as specified by
+ thereby requesting the server to repeatedly return subscription event messages, as specified by
the filter request described in the [[viss2-core]].
The server MAY reduce the number of
- subcriptionNotification
+ subcriptionEvent
messages sent to the client in order to reduce processing demands.
If the server is able to satisfy the request it SHALL return a
subscribeSuccessResponse message.
If an error occurs e.g. because the client is not authorized to read the requested value, the server SHALL return a
subscribeErrorResponse message.
If an error occurs during the subscription session, the server shall return an
- subscriptionErrorNotification message.
+ subscriptionErrorEvent message.
The subscription variants are, as described in the [[viss2-core]] document:
Object Name | Attribute | Type | Required |
---|---|---|---|
subscriptionNotification | action | Action | Yes |
subscriptionEvent | action | Action | Yes |
subscriptionId | string | Yes | |
data | object/array | Yes | |
Object Name | Attribute | Type | Required |
subscriptionErrorNotification | action | Action | Yes |
subscriptionErrorEvent | action | Action | Yes |
subscriptionId | string | Yes | |
error | Error | Yes | |
ts | string | Yes |