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 and Description
KafkaWriteStream<K,V>	asStream()
void	close() Close the producer
void	close(Handler<AsyncResult<Void>> completionHandler) Close the producer
void	close(long timeout, Handler<AsyncResult<Void>> completionHandler) Close the producer
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, 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, 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>	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, 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
KafkaProducer<K,V>	drainHandler(Handler<Void> handler)
void	end()
void	end(KafkaProducerRecord<K,V> kafkaProducerRecord)
KafkaProducer<K,V>	exceptionHandler(Handler<Throwable> handler)
KafkaProducer<K,V>	flush(Handler<Void> completionHandler) Invoking this method makes all buffered records immediately available to write
KafkaProducer<K,V>	partitionsFor(String topic, Handler<AsyncResult<List<PartitionInfo>>> handler) Get the partition metadata for the give topic.
KafkaProducer<K,V>	setWriteQueueMaxSize(int i)
org.apache.kafka.clients.producer.Producer<K,V>	unwrap()
KafkaProducer<K,V>	write(KafkaProducerRecord<K,V> kafkaProducerRecord)
KafkaProducer<K,V>	write(KafkaProducerRecord<K,V> record, Handler<AsyncResult<RecordMetadata>> handler) Asynchronously write a record to a topic
boolean	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

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

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,
                                             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

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,
                                             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

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

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,
                                       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,
                                       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,
                                       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

exceptionHandler

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

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<KafkaProducerRecord<K,V>>

write

KafkaProducer<K,V> write(KafkaProducerRecord<K,V> kafkaProducerRecord)

Specified by:

write in interface WriteStream<KafkaProducerRecord<K,V>>

end

void end()

Specified by:

end in interface WriteStream<KafkaProducerRecord<K,V>>

end

void end(KafkaProducerRecord<K,V> kafkaProducerRecord)

Specified by:

end in interface WriteStream<KafkaProducerRecord<K,V>>

setWriteQueueMaxSize

KafkaProducer<K,V> setWriteQueueMaxSize(int i)

Specified by:

setWriteQueueMaxSize in interface WriteStream<KafkaProducerRecord<K,V>>

writeQueueFull

boolean writeQueueFull()

Specified by:

writeQueueFull in interface WriteStream<KafkaProducerRecord<K,V>>

drainHandler

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

Specified by:

drainHandler in interface WriteStream<KafkaProducerRecord<K,V>>

write

KafkaProducer<K,V> write(KafkaProducerRecord<K,V> record,
                         Handler<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,
                                 Handler<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

flush

KafkaProducer<K,V> flush(Handler<Void> completionHandler)

Invoking this method makes all buffered records immediately available to write

Parameters:

completionHandler - handler called on operation completed

Returns:

current KafkaProducer instance

close

void close()

Close the producer

close

void close(Handler<AsyncResult<Void>> completionHandler)

Close the producer

Parameters:

completionHandler - handler called on operation completed

close

void close(long timeout,
           Handler<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