Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions docs-gen/content/service_rule_set/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,11 @@ A microservice may have a significant temporal duration from it is started and u
It may therefore be desireable that the state of the microservice can be observed,
as e. g. it may be the case that an ongoing microservice execution does not allow new microservice actuations to be started.

Service response or event messages shall therefore contain a parameter called Status, an enum with the following definition:
```
enum {
ONGOING = 1 // in execution of latest call
SUCCESSFUL = 0 // terminated successfully in latest call
FAILED = -1 // terminated due to failure in latest call
}
```
Service response or event messages shall therefore contain a parameter called Status,
which shall support at least the following states:
- ONGOING: in execution of latest call
- SUCCESSFUL: terminated successfully in latest call
- FAILED: terminated due to failure in latest call

The rules for how a microservice shall update the state value follows below:

Expand Down
10 changes: 9 additions & 1 deletion docs-gen/content/service_rule_set/procedure.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "procedure node"
title: "Procedure node"
weight: 30
---

Expand All @@ -12,6 +12,14 @@ For more information, see the [Common Rule Set: Mandatory Metadata](/hierarchica

Besides the mandatory metadata mentioned above, the following optional metadata may be used
- Comment
- NativeRate
- TimeToLive

The NativeRate shall be an integer that indicates the typical duration in milliseconds between two subsequent microservice event messages.
If set to zero then the service terminates instantaneously.

The TimeToLive indicates a maximum time in milliseconds that the server shall allow a service to execute.
When it is exceeded the server may terminate the service and issue a final event message with the Status set to FAILED.

For more information, please see the [Common Rule Set: Optional Metadata](/hierarchical_information_model/common_rule_set/basics#optional-metadata).

Expand Down
Loading