Packages

case class ConsumerOps[F[_], K, V](consumer: ConsumerApi[F, K, V]) extends Product with Serializable

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerOps
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ConsumerOps(consumer: ConsumerApi[F, K, V])

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 assign(topic: String, offsets: Map[TopicPartition, Long])(implicit F: Monad[F]): F[Unit]
  6. def assign(topics: List[String], offsets: Map[TopicPartition, Long], seekTo: SeekTo = SeekToBeginning)(implicit F: Monad[F]): F[Unit]
  7. def assignmentLastOffsets(commitMarkerAdjustment: Boolean = false)(implicit F: Monad[F]): F[Map[TopicPartition, Long]]
  8. def assignmentPositions(implicit F: Monad[F]): F[Map[TopicPartition, Long]]
  9. def assignmentPositionsAtLeast(offsets: Map[TopicPartition, Long])(implicit F: Monad[F]): F[Boolean]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def closeAndRecoverConcurrentModificationWithWakeup(timeout: FiniteDuration)(implicit F: ApplicativeError[F, Throwable]): F[Unit]
  12. def closeAndRecoverConcurrentModificationWithWakeup(implicit F: ApplicativeError[F, Throwable]): F[Unit]
  13. def commitSink: Pipe[F, Map[TopicPartition, OffsetAndMetadata], Unit]

    Returns a sink that synchronously commits received offsets.

  14. val consumer: ConsumerApi[F, K, V]
  15. def createCaughtUpSignal(commitMarkerAdjustment: Boolean = false)(implicit F: ConcurrentEffect[F]): F[(Signal[F, Boolean], (ConsumerRecord[K, V]) => F[Unit])]
  16. def createCaughtUpSignal(lastOffsets: Map[TopicPartition, Long])(implicit F: Concurrent[F]): F[(Signal[F, Boolean], (ConsumerRecord[K, V]) => F[Unit])]
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def lastOffsets(partitions: Iterable[TopicPartition], commitMarkerAdjustment: Boolean = false)(implicit F: Functor[F]): F[Map[TopicPartition, Long]]
  22. def log[G[_]](implicit arg0: Sync[G]): SelfAwareStructuredLogger[[_]G[_]]
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def partitionsFor(topics: List[String])(implicit F: Applicative[F]): F[List[PartitionInfo]]
  27. def pollAndRecoverWakeupWithClose(timeout: FiniteDuration)(implicit F: ApplicativeError[F, Throwable]): F[ConsumerRecords[K, V]]
  28. def pollAndRecoverWakeupWithNone(timeout: FiniteDuration)(implicit F: ApplicativeError[F, Throwable]): F[Option[ConsumerRecords[K, V]]]
  29. def positions[G[_]](partitions: G[TopicPartition])(implicit arg0: Traverse[G], F: Applicative[F]): F[G[(TopicPartition, Long)]]
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. def readProcessCommit[A](pollTimeout: FiniteDuration)(process: (ConsumerRecord[K, V]) => F[A])(implicit F: ApplicativeError[F, Throwable]): Stream[F, A]

    Returns a stream that processes records using the specified function, committing offsets for successfully processed records.

    Returns a stream that processes records using the specified function, committing offsets for successfully processed records. If the processing function returns a failure, the stream will halt with that failure, and the record's offset will not be committed. This is still at-least-once processing, but records for which the function returns success (and offset commit succeeds) will not be reprocessed after a subsequent failure; only records for which the function returns failure, or offset commits fail, will be reprocessed. In some use cases this pattern is more appropriate than just using auto-offset-commits, since it will not commit offsets for failed records when the consumer is closed, and will likely result in less reprocessing after a failure. The consumer must be configured to disable offset auto-commits.

  32. def recordStream(pollTimeout: FiniteDuration): Stream[F, ConsumerRecord[K, V]]

    Calls poll repeatedly, producing a chunk for each received collection of records.

  33. def recordsStream(pollTimeout: FiniteDuration): Stream[F, ConsumerRecords[K, V]]

    Calls poll repeatedly, each stream element is the entire collection of received records.

  34. def recordsThroughAssignmentLastOffsets(timeout: FiniteDuration, commitMarkerAdjustment: Boolean = false)(implicit F: MonadError[F, Throwable]): Stream[F, ConsumerRecords[K, V]]
  35. def recordsThroughAssignmentLastOffsetsOrZeros(pollTimeout: FiniteDuration, maxZeroCount: Int, commitMarkerAdjustment: Boolean = false)(implicit F: MonadError[F, Throwable]): Stream[F, ConsumerRecords[K, V]]
  36. def recordsThroughOffsets(finalOffsets: Map[TopicPartition, Long], timeout: FiniteDuration)(implicit F: MonadError[F, Throwable]): Stream[F, ConsumerRecords[K, V]]

    Polls for and returns records until reading at least up to the specified final offsets.

    Polls for and returns records until reading at least up to the specified final offsets. After the returned stream halts, records will have been returned at least up to, and possibly after, the specified final offsets. The stream will not halt until reaching (at least) the specified offsets. The consumer is not modified, other then calling poll. The consumer should be assigned/subscribed, and seeked to appropriate initial positions, before calling this function. After this stream halts, the consumer may still be used. The next records polled will follow all of the records returned by this stream. One common use of this stream is to initially "catch up" to the last offsets of all assigned topic partitions during program initialization, before doing other things.

  37. def recordsThroughOffsetsOrZeros(finalOffsets: Map[TopicPartition, Long], pollTimeout: FiniteDuration, maxZeroCount: Int)(implicit F: MonadError[F, Throwable]): Stream[F, ConsumerRecords[K, V]]
  38. def subscribe(topics: String*): F[Unit]
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped