Declares headers set by the platform when sending a message.

Clients are allowed to read platform-defined headers from a message.

Enumeration Members

AppSymbolicName: "ɵAPP_SYMBOLIC_NAME"

Identifies the sending application of a message. This header is set by the platform when publishing a message or intent.

ClientId: "ɵCLIENT_ID"

Identifies the sending client instance of a message. This header is set by the platform when publishing a message or intent.

MessageId: "ɵMESSAGE_ID"

Unique identity of the message. This header is set by the platform when publishing a message or intent.

Method: "ɵMETHOD"

Use this header to set the request method to indicate the desired action to be performed for a given resource.

RequestMethods

ReplyTo: "ɵREPLY_TO"

Destination to which to send a response to this message. This header is set by the platform when sending a request.

Status: "ɵSTATUS"

Use this header to set the response status code to indicate whether a request has been successfully completed. See ResponseStatusCodes for available status codes. Other codes are also allowed.

Status codes are primarily used in request-reply communication. In request-response communication, by default, the requestor’s Observable never completes. However, the replier can include the response status code in the reply’s headers, allowing to control the lifecycle of the requestor’s Observable.

For example, the status code 250 allows completing the requestor’s Observable after emitted the reply, or the status code 500 to error the Observable.

Note that the platform evaluates status codes only in request-response communication. They are ignored when observing topics or intents in pub/sub communication but can still be used; however, they must be handled by the application, e.g., by using the throwOnErrorStatus SCION RxJS operator.

ResponseStatusCodes

Timestamp: "ɵTIMESTAMP"

The time the message was sent. This header is set by the platform when publishing a message or intent.

Version: "ɵVERSION"

The version of the client.