noccy/mercureact
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Mercure Specification

Chris 2024-03-10 11:49:11 +00:00
parent 7f5535a970
commit 1a8f5b3a6b
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Mercure-Specification.md

@ -19,34 +19,41 @@ NOT**, **SHOULD**, **SHOULD NOT**, **RECOMMENDED**, **MAY**, and
**OPTIONAL**, when they appear in this document, are to be interpreted **OPTIONAL**, when they appear in this document, are to be interpreted
as described in [(RFC2119)](https://tools.ietf.org/html/rfc2119). as described in [(RFC2119)](https://tools.ietf.org/html/rfc2119).
- Topic: The unit to which one can subscribe to changes. The topic Topic
: The unit to which one can subscribe to changes. The topic
**SHOULD** be identified by an IRI **SHOULD** be identified by an IRI
[(RFC3987)](https://tools.ietf.org/html/rfc3987). Using an HTTPS [(RFC3987)](https://tools.ietf.org/html/rfc3987). Using an HTTPS
[(RFC7230)](https://tools.ietf.org/html/rfc7230) or HTTP [(RFC7230)](https://tools.ietf.org/html/rfc7230) or HTTP
[(RFC7230)](https://tools.ietf.org/html/rfc7230) URI [(RFC7230)](https://tools.ietf.org/html/rfc7230) URI
[(RFC3986)](https://tools.ietf.org/html/rfc3986) is **RECOMMENDED**. [(RFC3986)](https://tools.ietf.org/html/rfc3986) is **RECOMMENDED**.
- Update: The message containing the updated version of the topic. An Update
: The message containing the updated version of the topic. An
update can be marked as private, consequently, it must be dispatched update can be marked as private, consequently, it must be dispatched
only to subscribers allowed to receive it. only to subscribers allowed to receive it.
- Topic selector: An expression matching one or several topics. Topic selector
: An expression matching one or several topics.
- Publisher: An owner of a topic. Notifies the hub when the topic feed Publisher
: An owner of a topic. Notifies the hub when the topic feed
has been updated. As in almost all pubsub systems, the publisher is has been updated. As in almost all pubsub systems, the publisher is
unaware of the subscribers, if any. Other pubsub systems might call unaware of the subscribers, if any. Other pubsub systems might call
the publisher the "source". Typically a site or a web API, but can the publisher the "source". Typically a site or a web API, but can
also be a web browser. also be a web browser.
- Subscriber: A client application that subscribes to real-time Subscriber
: A client application that subscribes to real-time
updates of topics using topic selectors. Typically a web or a mobile updates of topics using topic selectors. Typically a web or a mobile
application, but can also be a server. application, but can also be a server.
- Subscription: A topic selector used by a subscriber to receive Subscription
: A topic selector used by a subscriber to receive
updates. A single subscriber can have several subscriptions, when it updates. A single subscriber can have several subscriptions, when it
provides several topic selectors. provides several topic selectors.
- Hub: A server that handles subscription requests and distributes the Hub
: A server that handles subscription requests and distributes the
content to subscribers when the corresponding topics have been content to subscribers when the corresponding topics have been
updated. Any hub **MAY** implement its own policies on who can use updated. Any hub **MAY** implement its own policies on who can use
it. it.