fs2-kafka
3.0.0
API
Generated with
fs2-kafka/fs2.kafka.consumer/KafkaSubscription

KafkaSubscription

fs2.kafka.consumer.KafkaSubscription
trait KafkaSubscription[F[_]]

Attributes

Source:
KafkaSubscription.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class KafkaConsumer[F, K, V]

Members list

Concise view

Value members

Abstract methods

def subscribe[G[_] : Reducible](topics: G[String]): F[Unit]

Subscribes the consumer to the specified topics. Note that you have to use one of the subscribe functions to subscribe to one or more topics before using any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Subscribes the consumer to the specified topics. Note that you have to use one of the subscribe functions to subscribe to one or more topics before using any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Attributes

topics

the topics to which the consumer should subscribe

Source:
KafkaSubscription.scala
def subscribe(regex: Regex): F[Unit]

Subscribes the consumer to the topics matching the specified Regex. Note that you have to use one of the subscribe functions before you can use any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Subscribes the consumer to the topics matching the specified Regex. Note that you have to use one of the subscribe functions before you can use any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Attributes

regex

the regex to which matching topics should be subscribed

Source:
KafkaSubscription.scala
def unsubscribe: F[Unit]

Unsubscribes the consumer from all topics and partitions assigned by subscribe or assign.

Unsubscribes the consumer from all topics and partitions assigned by subscribe or assign.

Attributes

Source:
KafkaSubscription.scala

Concrete methods

def subscribeTo(firstTopic: String, remainingTopics: String*): F[Unit]

Subscribes the consumer to the specified topics. Note that you have to use one of the subscribe functions to subscribe to one or more topics before using any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Subscribes the consumer to the specified topics. Note that you have to use one of the subscribe functions to subscribe to one or more topics before using any of the provided Streams, or a NotSubscribedException will be raised in the Streams.

Attributes

Source:
KafkaSubscription.scala
Generated with