KafkaProducer | @vertx/kafka-client

Vert.x Kafka producer.

The {@link WriteStream#write} provides global control over writing a record.

Type parameters

Hierarchy

KafkaProducer

Implements

Index

Methods

abortTransaction

abortTransaction(): PromiseLike<void>
abortTransaction(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:931
Aborts the ongoing transaction. See abortTransaction

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:936
Aborts the ongoing transaction. See abortTransaction

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns KafkaProducer<K, V>

beginTransaction

beginTransaction(): PromiseLike<void>
beginTransaction(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:911
Starts a new kafka transaction. See {@link KafkaProducer#beginTransaction}

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:916
Starts a new kafka transaction. See {@link KafkaProducer#beginTransaction}

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns KafkaProducer<K, V>

close

close(): PromiseLike<void>
close(completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
close(timeout: number): PromiseLike<void>
close(timeout: number, completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:977
Close the producer

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:982
Close the producer

Parameters
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:987
Close the producer

Parameters
- timeout: number
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:992
Close the producer

Parameters
- timeout: number
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

commitTransaction

commitTransaction(): PromiseLike<void>
commitTransaction(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:921
Commits the ongoing transaction. See {@link KafkaProducer#commitTransaction}

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:926
Commits the ongoing transaction. See {@link KafkaProducer#commitTransaction}

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns KafkaProducer<K, V>

drainHandler

drainHandler(handler: ((res: void) => void) | Handler<void> | null | undefined): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:942
Parameters
- handler: ((res: void) => void) | Handler<void> | null | undefined
Returns KafkaProducer<K, V>

end

end(): PromiseLike<void>
end(arg0: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
end(data: KafkaProducerRecord<K, V>): PromiseLike<void>
end(data: KafkaProducerRecord<K, V>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:846
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:848
Parameters
- arg0: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:850
Parameters
- data: KafkaProducerRecord<K, V>
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:852
Parameters
- data: KafkaProducerRecord<K, V>
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

exceptionHandler

exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:938
Parameters
- handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined
Returns KafkaProducer<K, V>

flush

flush(): PromiseLike<void>
flush(completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:967
Invoking this method makes all buffered records immediately available to write

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:972
Invoking this method makes all buffered records immediately available to write

Parameters
- completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns KafkaProducer<K, V>

initTransactions

initTransactions(): PromiseLike<void>
initTransactions(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:901
Initializes the underlying kafka transactional producer. See {@link KafkaProducer#initTransactions} ()}

Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:906
Initializes the underlying kafka transactional producer. See {@link KafkaProducer#initTransactions} ()}

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns KafkaProducer<K, V>

partitionsFor

partitionsFor(topic: string): PromiseLike<PartitionInfo>
partitionsFor(topic: string, handler: ((res: AsyncResult<PartitionInfo>) => void) | Handler<AsyncResult<PartitionInfo>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:957
Get the partition metadata for the give topic.

Parameters
- topic: string
Returns PromiseLike<PartitionInfo>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:962
Get the partition metadata for the give topic.

Parameters
- topic: string
- handler: ((res: AsyncResult<PartitionInfo>) => void) | Handler<AsyncResult<PartitionInfo>>
Returns KafkaProducer<K, V>

send

send(record: KafkaProducerRecord<K, V>): PromiseLike<RecordMetadata>
send(record: KafkaProducerRecord<K, V>, handler: ((res: AsyncResult<RecordMetadata>) => void) | Handler<AsyncResult<RecordMetadata>>): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:947
Asynchronously write a record to a topic

Parameters
- record: KafkaProducerRecord<K, V>
Returns PromiseLike<RecordMetadata>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:952
Asynchronously write a record to a topic

Parameters
- record: KafkaProducerRecord<K, V>
- handler: ((res: AsyncResult<RecordMetadata>) => void) | Handler<AsyncResult<RecordMetadata>>
Returns KafkaProducer<K, V>

setWriteQueueMaxSize

setWriteQueueMaxSize(i: number): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:940
Parameters
- i: number
Returns KafkaProducer<K, V>

write

write(arg0: KafkaProducerRecord<K, V>): PromiseLike<void>
write(arg0: KafkaProducerRecord<K, V>, arg1: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:842
Parameters
- arg0: KafkaProducerRecord<K, V>
Returns PromiseLike<void>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:844
Parameters
- arg0: KafkaProducerRecord<K, V>
- arg1: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

writeQueueFull

writeQueueFull(): boolean

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:854
Returns boolean

Static create

create<K, V>(vertx: Vertx, config: {}): KafkaProducer<K, V>
create<K, V>(vertx: Vertx, config: {}, keyType: any, valueType: any): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:891
Create a new KafkaProducer instance

Type parameters
- K
- V
Parameters
- vertx: Vertx
- config: {}
  - [key: string]: string
Returns KafkaProducer<K, V>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:896
Create a new KafkaProducer instance

Type parameters
- K
- V
Parameters
- vertx: Vertx
- config: {}
  - [key: string]: string
- keyType: any
- valueType: any
Returns KafkaProducer<K, V>

Static createShared

createShared<K, V>(vertx: Vertx, name: string, config: {}): KafkaProducer<K, V>
createShared<K, V>(vertx: Vertx, name: string, options: KafkaClientOptions): KafkaProducer<K, V>
createShared<K, V>(vertx: Vertx, name: string, config: {}, keyType: any, valueType: any): KafkaProducer<K, V>
createShared<K, V>(vertx: Vertx, name: string, options: KafkaClientOptions, keyType: any, valueType: any): KafkaProducer<K, V>

- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:862
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.

Type parameters
- K
- V
Parameters
- vertx: Vertx
- name: string
- config: {}
  - [key: string]: string
Returns KafkaProducer<K, V>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:870
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.

Type parameters
- K
- V
Parameters
- vertx: Vertx
- name: string
- options: KafkaClientOptions
Returns KafkaProducer<K, V>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:878
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.

Type parameters
- K
- V
Parameters
- vertx: Vertx
- name: string
- config: {}
  - [key: string]: string
- keyType: any
- valueType: any
Returns KafkaProducer<K, V>
- Defined in io.vertx/vertx-kafka-client/target/npm/index.d.ts:886
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.

Type parameters
- K
- V
Parameters
- vertx: Vertx
- name: string
- options: KafkaClientOptions
- keyType: any
- valueType: any
Returns KafkaProducer<K, V>

Type parameters

K

V

Hierarchy

Implements

Index

Methods

Methods

abortTransaction

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns KafkaProducer<K, V>

beginTransaction

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns KafkaProducer<K, V>

close

Returns PromiseLike<void>

Parameters

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters

timeout: number

Returns PromiseLike<void>

Parameters

timeout: number

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

commitTransaction

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns KafkaProducer<K, V>

drainHandler

Parameters

handler: ((res: void) => void) | Handler<void> | null | undefined

Returns KafkaProducer<K, V>

end

Returns PromiseLike<void>

Parameters

arg0: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters

data: KafkaProducerRecord<K, V>

Returns PromiseLike<void>

Parameters

data: KafkaProducerRecord<K, V>

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

exceptionHandler

Parameters

handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined

Returns KafkaProducer<K, V>

flush

Returns PromiseLike<void>

Parameters

completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns KafkaProducer<K, V>

initTransactions

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns KafkaProducer<K, V>

partitionsFor

Parameters

topic: string

Returns PromiseLike<PartitionInfo>

Parameters

topic: string

handler: ((res: AsyncResult<PartitionInfo>) => void) | Handler<AsyncResult<PartitionInfo>>

Returns KafkaProducer<K, V>

send

Parameters

record: KafkaProducerRecord<K, V>

Returns PromiseLike<RecordMetadata>

Parameters

record: KafkaProducerRecord<K, V>

handler: ((res: AsyncResult<RecordMetadata>) => void) | Handler<AsyncResult<RecordMetadata>>