Trait/Object

com.lightbend.lagom.scaladsl.api.broker

Subscriber

Related Docs: object Subscriber | package broker

Permalink

trait Subscriber[Payload] extends AnyRef

A Subscriber for consuming messages from a message broker.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Subscriber
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def atLeastOnce(flow: Flow[Payload, Done, _]): Future[Done]

    Permalink

    Applies the passed flow to the messages processed by this subscriber.

    Applies the passed flow to the messages processed by this subscriber. Messages are delivered to the passed flow at least once.

    If a failure occurs (e.g., an exception is thrown), the stream may be automatically restarted starting with the message that caused the failure.

    Whether the stream is automatically restarted depends on the Lagom message broker implementation in use. If the Kafka Lagom message broker module is being used, then by default the stream is automatically restarted when a failure occurs.

    The flow may pull more elements from upstream but it must emit exactly one Done message for each message that it receives. It must also emit them in the same order that the messages were received. This means that the flow must not filter or collect a subset of the messages, instead it must split the messages into separate streams and map those that would have been dropped to Done.

    flow

    The flow to apply to each received message.

    returns

    A Future that will be completed if the flow completes.

  2. abstract def atMostOnceSource: Source[Payload, _]

    Permalink

    Returns a stream of messages with at most once delivery semantic.

    Returns a stream of messages with at most once delivery semantic.

    If a failure occurs (e.g., an exception is thrown), the user is responsible of deciding how to recover from it (e.g., restarting the stream, aborting, ...).

  3. abstract def withGroupId(groupId: String): Subscriber[Payload]

    Permalink

    Returns a copy of this subscriber with the passed group id.

    Returns a copy of this subscriber with the passed group id.

    groupId

    The group id to assign to this subscriber.

    returns

    A copy of this subscriber with the passed group id.

  4. abstract def withMetadata: Subscriber[Message[Payload]]

    Permalink

    Returns this subscriber, but message payloads are wrapped in Message instances to allow accessing any metadata associated with the message.

    Returns this subscriber, but message payloads are wrapped in Message instances to allow accessing any metadata associated with the message.

    returns

    A copy of this subscriber.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped