Package io.camunda.zeebe.transport.stream.api

Interface ClientStreamService<M extends BufferWriter>

Type Parameters:

M - the type of the streaming metadata

All Superinterfaces:

AsyncClosable

All Known Implementing Classes:

ClientStreamServiceImpl

public interface ClientStreamService<M extends BufferWriter>
extends AsyncClosable

Manages an instance of ClientStreamer. Intended to be the main entry point when setting up the client side for remote streams, primarily via TransportFactory.createRemoteStreamClient(ClusterCommunicationService, ClientStreamMetrics).

Method Summary

Modifier and Type	Method	Description
void	onServerJoined(MemberId memberId)	A callback to be invoked when a new streaming server is added.
void	onServerRemoved(MemberId memberId)	A callback to be invoked when a new streaming server is removed.
ActorFuture<Void>	start(ActorSchedulingService schedulingService)	Starts the service, optionally with the given actor scheduling service.
ClientStreamer<M>	streamer()	Returns the managed ClientStreamer associated with this service.
ActorFuture<Optional<ClientStream<M>>>	streamFor(ClientStreamId id)	Returns the ClientStream associated with this ID
ActorFuture<Collection<ClientStream<M>>>	streams()	Returns all registered client streams.

Methods inherited from interface io.camunda.zeebe.scheduler.AsyncClosable

closeAsync

Method Details

start

ActorFuture<Void> start(ActorSchedulingService schedulingService)

Starts the service, optionally with the given actor scheduling service. Assumes the scheduling service is already running.

onServerJoined

void onServerJoined(MemberId memberId)

A callback to be invoked when a new streaming server is added. Implementations should be idempotent.

onServerRemoved

void onServerRemoved(MemberId memberId)

A callback to be invoked when a new streaming server is removed. Implementations should be idempotent.

streamer

ClientStreamer<M> streamer()

Returns the managed ClientStreamer associated with this service.

streamFor

ActorFuture<Optional<ClientStream<M>>> streamFor(ClientStreamId id)

Returns the ClientStream associated with this ID

streams

ActorFuture<Collection<ClientStream<M>>> streams()

Returns all registered client streams.