Module subspace_farmer::cluster::nats_client

NATS client

NatsClient provided here is a wrapper around [Client] that provides convenient methods using domain-specific traits.

Before reading code, make sure to familiarize yourself with NATS documentation, especially with subjects and Core NATS features.

Abstractions provided here cover a few use cases:

• request/response (for example piece request)
• request/stream of responses (for example a stream of plotted sectors of the farmer)
• notifications (typically targeting a particular instance of an app) and corresponding subscriptions (for example solution notification)
• broadcasts and corresponding subscriptions (for example slot info broadcast)

Structs

• NatsClient
  NATS client wrapper that can be used to interact with other Subspace-specific clients
• StreamRequest
  Generic stream request that expects a stream of responses.
• StreamResponseSubscriber
  Wrapper around subscription that transforms GenericStreamResponses<Response> messages into a normal Response stream.
• SubscriberWrapper
  Subscriber wrapper that decodes messages automatically and skips messages that can’t be decoded

Enums

• GenericStreamResponses
  Messages sent in response to StreamRequest.
• StreamRequestError
  Stream request error

Traits

• GenericBroadcast
  Generic broadcast message.
• GenericNotification
  Generic one-off notification
• GenericRequest
  Generic request with associated response.
• GenericStreamRequest
  Generic stream request where response is streamed using NatsClient::stream_response.