Skip to main content

Crate arminius_lib_federation_output_service_messages

Crate arminius_lib_federation_output_service_messages 

Source
Expand description

Commands answered by the federation output service.

§arminius-lib-federation-output-service-messages

The inbound message bus API of the federation output service.

A message is defined in the arminius-lib-{service}-messages crate of the service that handles it.

§Subject layout

federation-output-service.commands.<name>.v1    request-reply, this service answers

The service-prefixed, two-segment federation-output-service.commands. namespace is load bearing, not cosmetic.

Two streams whose subjects overlap cannot coexist in one NATS account, so a command subject must not share a prefix with any other stream. Naming a command federation.output.discover_server_keys would infer the filter federation.output.>, which swallows this service’s existing federation.output.* stream and fails at startup with subjects overlap with an existing stream.

Modules§

command 🔒
Commands the federation output service handles.
error 🔒
The error half of every federation output command reply.

Structs§

ClaimOneTimeKeysCommand
Claim one-time keys from a remote homeserver.
DiscoverServerKeysCommand
Fetch a remote homeserver’s signing keys.
ErrorResponse
An error response relayed from a remote homeserver.
FetchUserKeysCommand
Fetch identity keys from a remote homeserver.
GetProfileCommand
Fetch a user’s profile from their homeserver.
MakeJoinCommand
Ask a remote homeserver for a join event template.
MakeJoinReply
A remote homeserver’s answer to a make_join request.
RetrieveEventCommand
Retrieve a single event from a remote homeserver.
SendInviteCommand
Invite a remote user into a local room.
SendJoinCommand
Submit a signed join event to a remote homeserver.

Enums§

MiscRequestError
Why a federation output command could not be fulfilled.

Constants§

COMMAND_SUBJECT_FILTER
The JetStream stream filter every command in this crate resolves to.