-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Martin <github@diemattels.at>
- Loading branch information
Showing
3 changed files
with
19 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,14 @@ | ||
# Clientlog service | ||
# Clientlog Service | ||
|
||
The `clientlog` service is responsible for composing machine readable notifications for clients | ||
The `clientlog` service is responsible for composing machine readable notifications for clients. Clients are apps and web interfaces. | ||
|
||
## The `...log` service ecosystem | ||
## The Log Service Ecosystem | ||
|
||
`...log` services (`userlog`, `clientlog`) are responsible for composing notifications for a certain audience. | ||
- `userlog` service translates and adjust messages to be human readable | ||
- `clientlog` service composes machine readable messages so clients can act without needing to query the server | ||
- `sse` service is only responsible for sending these messages. It does not care about their form or language | ||
Log services like the `userlog`, `clientlog` and `sse` are responsible for composing notifications for a certain audience. | ||
- The `userlog` service translates and adjusts messages to be human readable. | ||
- The `clientlog` service composes machine readable messages, so clients can act without the need to query the server. | ||
- The `sse` service is only responsible for sending these messages. It does not care about their form or language. | ||
|
||
## `clientlog` events | ||
## Clientlog Events | ||
|
||
The messages the `clientlog` service sends are meant to be used by clients, not by users. The client might for example be informed that a file is finished postprocessing, so it can make the file available to the user without needing to make another call to the server. | ||
The messages the `clientlog` service sends are intended for the use by clients, not by users. The client might for example be informed that a file has finished post-processing. With that, the client can make the file available to the user without additional server queries. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters