Skip to content

Commit

Permalink
Merge pull request #81 from bbc/in-flight-activation
Browse files Browse the repository at this point in the history
Add text around in-flight activations and bulk mode de-duplication
  • Loading branch information
andrewbonney authored Jun 12, 2019
2 parents 638c3a0 + ad52d4d commit 640b7ee
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/4.0. Behaviour.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,20 @@ This is important to ensure that connection management clients do not cache the

In environments where multiple clients may be operating against a single Connection Management API, it is possible that staging of parameters may result in conflicts. There is intentionally no mechanism to prevent this in the API, however clients should examine the results of HTTP PATCH operations which will return the full complement of current settings, allowing the client to confirm that only the changes it had requested have been made.

## In-Progress Activations

When an implementation is in the process of activating a new set of transport parameters, concurrent requests to the API from other clients may result in unexpected results. In order to minimise these cases, implementations are recommended to adopt the following practice:

While an activation is in progress, concurrent GET requests to the `/active` resource SHOULD reflect the current state of the Sender or Receiver as accurately as possible at the instant of the request.

If an API implementation receives a new PATCH request to the `/staged` resource while an activation is in progress it SHOULD block the request until the previous activation is complete. Any GET requests to `/staged` during this time MAY also be blocked until the activation is complete.

## 'Salvo' Operation

Where a server implementation supports concurrent application of settings changes to underlying Senders and Receivers, it may choose to perform 'bulk' resource operations in a parallel fashion internally. This is an implementation decision and is not a requirement of this specification.

If a 'bulk' request includes multiple sets of parameters for the same Sender or Receiver ID the behaviour is defined by the implementation. In order to maximise interoperability clients are encouraged not to include the same Sender or Receiver ID multiple times in the same 'bulk' request.

# Scheduled Activations

IS-05 provides a mechanism whereby the activation of staged transport parameters can be performed at a particular TAI time, or after a given interval.
Expand Down

0 comments on commit 640b7ee

Please sign in to comment.