Package io.camunda.zeebe.transport.stream.impl

Class ClientStreamServiceImpl<M extends BufferWriter>

java.lang.Object

io.camunda.zeebe.scheduler.Actor

io.camunda.zeebe.transport.stream.impl.ClientStreamServiceImpl<M>

All Implemented Interfaces:

AsyncClosable, ConcurrencyControl, ClientStreamer<M>, ClientStreamService<M>, CloseableSilently, AutoCloseable, Executor

public final class ClientStreamServiceImpl<M extends BufferWriter>
extends Actor
implements ClientStreamer<M>, ClientStreamService<M>

Implementation for both ClientStreamer and ClientStreamService.

TODO: In the future we may want to split this into more than implementation, where the streamer receives an execution context, and the service manages it.

Nested Class Summary

Nested classes/interfaces inherited from class io.camunda.zeebe.scheduler.Actor

Actor.ActorBuilder

Field Summary

Fields inherited from class io.camunda.zeebe.scheduler.Actor

actor, ACTOR_PROP_NAME, ACTOR_PROP_PARTITION_ID

Constructor Summary

Constructors

Constructor	Description
ClientStreamServiceImpl(ClusterCommunicationService communicationService, ClientStreamMetrics metrics)

Method Summary

Modifier and Type	Method	Description
ActorFuture<ClientStreamId>	add(org.agrona.DirectBuffer streamType, M metadata, ClientStreamConsumer clientStreamConsumer)	Registers a client and opens a stream for the given streamType and associated Metadata with all available servers.
protected void	onActorCloseRequested()
protected void	onActorStarted()
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>	remove(ClientStreamId streamId)	Removes a stream that is added via ClientStreamer.add(DirectBuffer, BufferWriter, ClientStreamConsumer).
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 class io.camunda.zeebe.scheduler.Actor

buildActorName, call, close, closeAsync, createContext, getContext, getName, handleFailure, isActorClosed, newActor, onActorClosed, onActorClosing, onActorFailed, onActorStarting, run, runOnCompletion, runOnCompletion, schedule, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

closeAsync

Methods inherited from interface io.camunda.zeebe.util.CloseableSilently

close

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

createCompletedFuture, createFuture, execute

Constructor Details

ClientStreamServiceImpl

public ClientStreamServiceImpl(ClusterCommunicationService communicationService,
 ClientStreamMetrics metrics)

Method Details

onActorStarted

protected void onActorStarted()

Overrides:

onActorStarted in class Actor

onActorCloseRequested

protected void onActorCloseRequested()

Overrides:

onActorCloseRequested in class Actor

add

public ActorFuture<ClientStreamId> add(org.agrona.DirectBuffer streamType,
 M metadata,
 ClientStreamConsumer clientStreamConsumer)

Description copied from interface: ClientStreamer

Registers a client and opens a stream for the given streamType and associated Metadata with all available servers. The stream is also opened for servers that are not currently reachable, but available later.

NOTE: The stream to a server can be added asynchronously. So there might be a delay until the consumer receives the first data.

Specified by:

add in interface ClientStreamer<M extends BufferWriter>

Parameters:

streamType - type of the stream

metadata - metadata associated with the stream

clientStreamConsumer - consumer which process data received from the server

Returns:

a unique id of the stream

remove

public ActorFuture<Void> remove(ClientStreamId streamId)

Description copied from interface: ClientStreamer

Removes a stream that is added via ClientStreamer.add(DirectBuffer, BufferWriter, ClientStreamConsumer). After the returned future is completed, the ClientStreamConsumer will not receive any more data.

Specified by:

remove in interface ClientStreamer<M extends BufferWriter>

Parameters:

streamId - unique id of the stream

Returns:

a future which will be completed after the stream is removed

start

public ActorFuture<Void> start(ActorSchedulingService schedulingService)

Description copied from interface: ClientStreamService

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

Specified by:

start in interface ClientStreamService<M extends BufferWriter>

onServerJoined

public void onServerJoined(MemberId memberId)

Description copied from interface: ClientStreamService

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

Specified by:

onServerJoined in interface ClientStreamService<M extends BufferWriter>

onServerRemoved

public void onServerRemoved(MemberId memberId)

Description copied from interface: ClientStreamService

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

Specified by:

onServerRemoved in interface ClientStreamService<M extends BufferWriter>

streamer

public ClientStreamer<M> streamer()

Description copied from interface: ClientStreamService

Returns the managed ClientStreamer associated with this service.

Specified by:

streamer in interface ClientStreamService<M extends BufferWriter>

streamFor

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

Description copied from interface: ClientStreamService

Returns the ClientStream associated with this ID

Specified by:

streamFor in interface ClientStreamService<M extends BufferWriter>

streams

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

Description copied from interface: ClientStreamService

Returns all registered client streams.

Specified by:

streams in interface ClientStreamService<M extends BufferWriter>