Packages

class KCLConsumerFS2[F[_]] extends AnyRef

Wrapper offering for the KCL via an fs2.Stream

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. val commitRecords: Pipe[F, CommittableRecord[F], CommittableRecord[F]]

    A Pipe definition that users can leverage to commit the records after they have completed processing.

    A Pipe definition that users can leverage to commit the records after they have completed processing.

    returns

    Pipe for committing records.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  15. def stream(): Resource[F, Stream[F, CommittableRecord[F]]]

    Runs a KCL Consumer as an fs2.Stream

    Runs a KCL Consumer as an fs2.Stream

    returns

    fs2.Stream that manages the lifecycle of the KCL Consumer

  16. def streamWithDeferredListener(stateToCompleteOn: WorkerState = WorkerState.STARTED): Resource[F, StreamAndDeferred[F]]

    Runs a KCL Consumer in the background as a Resource.

    Runs a KCL Consumer in the background as a Resource. This exposes the WorkerState which can be used as a means to determine if the KCL Consumer is running. A common use case for this is to service healthcheck endpoints when running these in an orchestration service (e.g. Kubernetes or AWS ECS) or running tests that require the consumer to be up before an assertion is checked.

    Unlike streamWithRefListener, this method uses a Deferred instance. This is useful when you only need to react when the KCL has reached a specific state 1 time (e.g. wait to produce to a stream until the consumer is started)

    stateToCompleteOn

    WorkerState to expect when completing the Deferred. Default is STARTED.

    returns

    Resource containing an fs2.Stream and Deferred

  17. def streamWithRefListener(): Resource[F, StreamAndRef[F]]

    Runs a KCL Consumer as an fs2.Stream.

    Runs a KCL Consumer as an fs2.Stream. This exposes the WorkerState which can be used as a means to determine if the KCL Consumer is running. A common use case for this is to service healthcheck endpoints when running these in an orchestration service (e.g. Kubernetes or AWS ECS) or running tests that require the consumer to be up before an assertion is checked.

    returns

    Resource containing an fs2.Stream and Deferred

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped