Control

com.sksamuel.pulsar4s.akka.streams.Control
@DoNotInherit
trait Control

Provides operations for controlling the Pulsar Akka streams sources.

This trait is not meant to be inherited by external code.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def complete()(implicit ec: ExecutionContext): Future[Done]

Complete the source but leave the Pulsar consumer open to receive any unacked messages.

Complete the source but leave the Pulsar consumer open to receive any unacked messages.

Attributes

Returns

a future completed with Done when the stream is completed.

def shutdown()(implicit ec: ExecutionContext): Future[Done]

Shut down the Pulsar consumer, and shut down the Source if it is not already shut down.

Shut down the Pulsar consumer, and shut down the Source if it is not already shut down.

Attributes

Returns

a future completed with Done when the source is shut down and the consumer is closed.

def stats: ConsumerStats

Get stats for the Pulsar consumer backing the Source.

Get stats for the Pulsar consumer backing the Source.

Attributes

Concrete methods

def drainAndShutdown[S](streamCompletion: Future[S])(implicit ec: ExecutionContext): Future[S]

Stop producing messages from the Source, wait for stream completion and shut down the consumer Source so that all consumed messages reach the end of the stream. Failures in stream completion will be propagated.

Stop producing messages from the Source, wait for stream completion and shut down the consumer Source so that all consumed messages reach the end of the stream. Failures in stream completion will be propagated.

Attributes

Deprecated methods

def stop(): Unit

Complete the source but leave the Pulsar consumer open to receive any unacked messages.

Complete the source but leave the Pulsar consumer open to receive any unacked messages.

Attributes

Deprecated
true