Package io.vertx.kafka.client.producer

Interface KafkaProducer<K,V>

All Superinterfaces:
io.vertx.core.streams.StreamBase, io.vertx.core.streams.WriteStream<KafkaProducerRecord<K,V>>
public interface KafkaProducer<K,V> extends io.vertx.core.streams.WriteStream<KafkaProducerRecord<K,V>>
Vert.x Kafka producer.

The WriteStream.write(Object) provides global control over writing a record.

  • Method Details

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Properties config)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Map<String,String> config)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, KafkaClientOptions options)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      options - Kafka producer options
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Map<String,String> config, org.apache.kafka.common.serialization.Serializer<K> keySerializer, org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      keySerializer - key serializer
      valueSerializer - value serializer
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Map<String,String> config, Class<K> keyType, Class<V> valueType)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      keyType - class type for the key serialization
      valueType - class type for the value serialization
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Properties config, org.apache.kafka.common.serialization.Serializer<K> keySerializer, org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      keySerializer - key serializer
      valueSerializer - value serializer
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, Properties config, Class<K> keyType, Class<V> valueType)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      config - Kafka producer configuration
      keyType - class type for the key serialization
      valueType - class type for the value serialization
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, KafkaClientOptions options, org.apache.kafka.common.serialization.Serializer<K> keySerializer, org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      options - Kafka producer options
      keySerializer - key serializer
      valueSerializer - value serializer
      Returns:
      an instance of the KafkaProducer

    • createShared

      static <K, V> KafkaProducer<K,V> createShared(io.vertx.core.Vertx vertx, String name, KafkaClientOptions options, Class<K> keyType, Class<V> valueType)
      Get or create a KafkaProducer instance which shares its stream with any other KafkaProducer created with the same name

      When close has been called for each shared producer the resources will be released. Calling end closes all shared producers.

      Parameters:
      vertx - Vert.x instance to use
      name - the producer name to identify it
      options - Kafka producer options
      keyType - class type for the key serialization
      valueType - class type for the value serialization
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, org.apache.kafka.clients.producer.Producer<K,V> producer)
      Create a new KafkaProducer instance from a native Producer.
      Parameters:
      vertx - Vert.x instance to use
      producer - the Kafka producer to wrap
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, org.apache.kafka.clients.producer.Producer<K,V> producer, KafkaClientOptions options)
      Create a new KafkaProducer instance from a native Producer.
      Parameters:
      vertx - Vert.x instance to use
      producer - the Kafka producer to wrap
      options - options used only for tracing settings
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Map<String,String> config)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Map<String,String> config, org.apache.kafka.common.serialization.Serializer<K> keySerializer, org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      keySerializer - key serializer
      valueSerializer - value serializer
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Map<String,String> config, Class<K> keyType, Class<V> valueType)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      keyType - class type for the key serialization
      valueType - class type for the value serialization
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Properties config)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Properties config, org.apache.kafka.common.serialization.Serializer<K> keySerializer, org.apache.kafka.common.serialization.Serializer<V> valueSerializer)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      keySerializer - key serializer
      valueSerializer - value serializer
      Returns:
      an instance of the KafkaProducer

    • create

      static <K, V> KafkaProducer<K,V> create(io.vertx.core.Vertx vertx, Properties config, Class<K> keyType, Class<V> valueType)
      Create a new KafkaProducer instance
      Parameters:
      vertx - Vert.x instance to use
      config - Kafka producer configuration
      keyType - class type for the key serialization
      valueType - class type for the value serialization
      Returns:
      an instance of the KafkaProducer

    • initTransactions

      KafkaProducer<K,V> initTransactions(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
      Initializes the underlying kafka transactional producer. See initTransactions() ()}
      Parameters:
      handler - handler called on operation completed
      Returns:
      current KafkaWriteStream instance

    • initTransactions

      io.vertx.core.Future<Void> initTransactions()
      Like initTransactions(Handler) but with a future of the result

    • beginTransaction

      KafkaProducer<K,V> beginTransaction(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
      Starts a new kafka transaction. See beginTransaction()
      Parameters:
      handler - handler called on operation completed
      Returns:
      current KafkaWriteStream instance

    • beginTransaction

      io.vertx.core.Future<Void> beginTransaction()
      Like beginTransaction(Handler) but with a future of the result

    • commitTransaction

      KafkaProducer<K,V> commitTransaction(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
      Commits the ongoing transaction. See commitTransaction()
      Parameters:
      handler - handler called on operation completed
      Returns:
      current KafkaWriteStream instance

    • commitTransaction

      io.vertx.core.Future<Void> commitTransaction()
      Like commitTransaction(Handler) but with a future of the result

    • abortTransaction

      KafkaProducer<K,V> abortTransaction(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> handler)
      Aborts the ongoing transaction. See KafkaProducer.abortTransaction()
      Parameters:
      handler - handler called on operation completed
      Returns:
      current KafkaWriteStream instance

    • abortTransaction

      io.vertx.core.Future<Void> abortTransaction()
      Like abortTransaction(Handler) but with a future of the result

    • exceptionHandler

      KafkaProducer<K,V> exceptionHandler(io.vertx.core.Handler<Throwable> handler)
      Specified by:
      exceptionHandler in interface io.vertx.core.streams.StreamBase
      Specified by:
      exceptionHandler in interface io.vertx.core.streams.WriteStream<K>

    • setWriteQueueMaxSize

      KafkaProducer<K,V> setWriteQueueMaxSize(int i)
      Specified by:
      setWriteQueueMaxSize in interface io.vertx.core.streams.WriteStream<K>

    • drainHandler

      KafkaProducer<K,V> drainHandler(io.vertx.core.Handler<Void> handler)
      Specified by:
      drainHandler in interface io.vertx.core.streams.WriteStream<K>

    • send

      io.vertx.core.Future<RecordMetadata> send(KafkaProducerRecord<K,V> record)
      Asynchronously write a record to a topic
      Parameters:
      record - record to write
      Returns:
      a Future completed with the record metadata

    • send

      KafkaProducer<K,V> send(KafkaProducerRecord<K,V> record, io.vertx.core.Handler<io.vertx.core.AsyncResult<RecordMetadata>> handler)
      Asynchronously write a record to a topic
      Parameters:
      record - record to write
      handler - handler called on operation completed
      Returns:
      current KafkaWriteStream instance

    • partitionsFor

      KafkaProducer<K,V> partitionsFor(String topic, io.vertx.core.Handler<io.vertx.core.AsyncResult<List<PartitionInfo>>> handler)
      Get the partition metadata for the give topic.
      Parameters:
      topic - topic partition for which getting partitions info
      handler - handler called on operation completed
      Returns:
      current KafkaProducer instance

    • partitionsFor

      io.vertx.core.Future<List<PartitionInfo>> partitionsFor(String topic)
      Like partitionsFor(String, Handler) but returns a Future of the asynchronous result

    • flush

      KafkaProducer<K,V> flush(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> completionHandler)
      Invoking this method makes all buffered records immediately available to write
      Parameters:
      completionHandler - handler called on operation completed
      Returns:
      current KafkaProducer instance

    • flush

      io.vertx.core.Future<Void> flush()
      Like flush(Handler) but returns a Future of the asynchronous result

    • close

      io.vertx.core.Future<Void> close()
      Close the producer
      Returns:
      a Future completed with the operation result

    • close

      void close(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> completionHandler)
      Close the producer
      Parameters:
      completionHandler - handler called on operation completed

    • close

      io.vertx.core.Future<Void> close(long timeout)
      Like close(long, Handler) but returns a Future of the asynchronous result

    • close

      void close(long timeout, io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> completionHandler)
      Close the producer
      Parameters:
      timeout - timeout to wait for closing
      completionHandler - handler called on operation completed

    • asStream

      KafkaWriteStream<K,V> asStream()
      Returns:
      underlying KafkaWriteStream instance

    • unwrap

      org.apache.kafka.clients.producer.Producer<K,V> unwrap()
      Returns:
      the underlying producer