Package io.vertx.kafka.client.producer

Interface KafkaProducer<K,V>

All Superinterfaces:

StreamBase, WriteStream<KafkaProducerRecord<K,V>>

public interface KafkaProducer<K,V>
extends WriteStream<KafkaProducerRecord<K,V>>

Vert.x Kafka producer.

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

Method Summary

Modifier and Type	Method	Description
Future<Void>	abortTransaction()	Aborts the ongoing transaction.
KafkaWriteStream<K,V>	asStream()
Future<Void>	beginTransaction()	Starts a new kafka transaction.
Future<Void>	close()	Close the producer
Future<Void>	close(long timeout)	Close the producer
Future<Void>	commitTransaction()	Commits the ongoing transaction.
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, Map<String,String> config)	Create a new KafkaProducer instance
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, Map<String,String> config, Class<K> keyType, Class<V> valueType)	Create a new KafkaProducer instance
static <K,V> KafkaProducer<K,V>	create(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
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, Properties config)	Create a new KafkaProducer instance
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, Properties config, Class<K> keyType, Class<V> valueType)	Create a new KafkaProducer instance
static <K,V> KafkaProducer<K,V>	create(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
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, org.apache.kafka.clients.producer.Producer<K,V> producer)	Create a new KafkaProducer instance from a native Producer.
static <K,V> KafkaProducer<K,V>	create(Vertx vertx, org.apache.kafka.clients.producer.Producer<K,V> producer, KafkaClientOptions options)	Create a new KafkaProducer instance from a native Producer.
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
static <K,V> KafkaProducer<K,V>	createShared(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
KafkaProducer<K,V>	drainHandler(Handler<Void> handler)
KafkaProducer<K,V>	exceptionHandler(Handler<Throwable> handler)
Future<Void>	flush()	Invoking this method makes all buffered records immediately available to write
Future<Void>	initTransactions()	Initializes the underlying kafka transactional producer.
Future<List<PartitionInfo>>	partitionsFor(String topic)	Get the partition metadata for the give topic.
Future<RecordMetadata>	send(KafkaProducerRecord<K,V> record)	Asynchronously write a record to a topic
KafkaProducer<K,V>	setWriteQueueMaxSize(int i)
org.apache.kafka.clients.producer.Producer<K,V>	unwrap()

Methods inherited from interface io.vertx.core.streams.WriteStream

end, end, write, writeQueueFull

Method Detail

createShared

static <K,V> KafkaProducer<K,V> createShared(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(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(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(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(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(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(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(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(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(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(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(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(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(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(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(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(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

Future<Void> initTransactions()

Initializes the underlying kafka transactional producer. See initTransactions() ()}

Returns:

a future notified with the result

beginTransaction

Future<Void> beginTransaction()

Starts a new kafka transaction. See beginTransaction()

Returns:

a future notified with the result

commitTransaction

Future<Void> commitTransaction()

Commits the ongoing transaction. See commitTransaction()

Returns:

a future notified with the result

abortTransaction

Future<Void> abortTransaction()

Aborts the ongoing transaction. See KafkaProducer.abortTransaction()

Returns:

a future notified with the result

exceptionHandler

KafkaProducer<K,V> exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<K>

setWriteQueueMaxSize

KafkaProducer<K,V> setWriteQueueMaxSize(int i)

Specified by:

setWriteQueueMaxSize in interface WriteStream<K>

drainHandler

KafkaProducer<K,V> drainHandler(Handler<Void> handler)

Specified by:

drainHandler in interface WriteStream<K>

send

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

partitionsFor

Future<List<PartitionInfo>> partitionsFor(String topic)

Get the partition metadata for the give topic.

Parameters:

topic - topic partition for which getting partitions info

Returns:

a future notified with the result

flush

Future<Void> flush()

Invoking this method makes all buffered records immediately available to write

Returns:

a future notified with the result

close

Future<Void> close()

Close the producer

Returns:

a Future completed with the operation result

close

Future<Void> close(long timeout)

Close the producer

Returns:

a future notified with the result

asStream

KafkaWriteStream<K,V> asStream()

Returns:

underlying KafkaWriteStream instance

unwrap

org.apache.kafka.clients.producer.Producer<K,V> unwrap()

Returns:

the underlying producer