Module api

Source

Modules§

net

Structs§

ApiVersionSet
Set of api versions for each component (core + modules)
DynGlobalApi
DynModuleApi
FederationError
An API request error when calling an entire federation
FederationStatus
The status of a server, including how it views its peers
GlobalFederationApiWithCache
IGlobalFederationApi wrapping some T: IRawFederationApi and adding a tiny bit of caching.
GuardianConfigBackup
Archive of all the guardian config files that can be used to recover a lost guardian node.
PeerStatus
ReconnectClientConnections
ReconnectFederationApi
StatusResponse
WebsocketConnector

Enums§

ApiMethod
JsonRpcClientError
Error type.
OutputOutcomeError
P2PConnectionStatus
PeerError
An API request error when calling a single federation peer

Constants§

VERSION_THAT_INTRODUCED_GET_SESSION_STATUS
VERSION_THAT_INTRODUCED_GET_SESSION_STATUS_V2

Traits§

FederationApiExt
An extension trait allowing to making federation-wide API call on top IRawFederationApi.
GlobalFederationApiWithCacheExt
Convenience extension trait used for wrapping IRawFederationApi in a GlobalFederationApiWithCache
IClientConnection
IClientConnector
Allows to connect to peers. Connections are request based and should be authenticated and encrypted for production deployments.
IGlobalFederationApi
The API for the global (non-module) endpoints
IModuleFederationApi
Trait marker for the module (non-global) endpoints
IRawFederationApi
An API (module or global) that can query a federation

Functions§

deserialize_outcome

Type Aliases§

DynClientConnection
DynClientConnector
FederationResult
JsonRpcResult
OutputOutcomeResult
PeerResult
SerdeOutputOutcome