reactor.kafka.sender

Class SenderOptions<K,V>

java.lang.Object

reactor.kafka.sender.SenderOptions<K,V>

public class SenderOptions<K,V>
extends Object

Configuration properties for reactive Kafka Sender and its underlying Kafka Producer.

Method Summary

Modifier and Type	Method and Description
Duration	closeTimeout() Returns the timeout for graceful shutdown of this sender.
SenderOptions<K,V>	closeTimeout(Duration timeout) Configures the timeout for graceful shutdown of this sender.
static <K,V> SenderOptions<K,V>	create() Creates a sender options instance with default properties.
static <K,V> SenderOptions<K,V>	create(Map<String,Object> configProperties) Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.
static <K,V> SenderOptions<K,V>	create(Properties configProperties) Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.
int	maxInFlight() Returns the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.
SenderOptions<K,V>	maxInFlight(int maxInFlight) Configures the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.
Map<String,Object>	producerProperties() Returns the configuration properties for the underlying Kafka Producer.
Object	producerProperty(String name) Returns the Kafka Producer configuration property value for the specified option name.
SenderOptions<K,V>	producerProperty(String name, Object value) Sets Kafka Producer configuration property to the specified value.
Scheduler	scheduler() Returns the scheduler used for publishing send results.
SenderOptions<K,V>	scheduler(Scheduler scheduler) Sets the scheduler used for publishing send results.
SenderOptions<K,V>	toImmutable() Returns a new immutable instance with the configuration properties of this instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static <K,V> SenderOptions<K,V> create()

Creates a sender options instance with default properties.

Returns:

new instance of sender options

create

public static <K,V> SenderOptions<K,V> create(Map<String,Object> configProperties)

Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.

Returns:

new instance of sender options

create

public static <K,V> SenderOptions<K,V> create(Properties configProperties)

Creates a sender options instance with the specified config overrides for the underlying Kafka Producer.

Returns:

new instance of sender options

producerProperties

public Map<String,Object> producerProperties()

Returns the configuration properties for the underlying Kafka Producer.

Returns:

configuration options for Kafka producer

producerProperty

public Object producerProperty(String name)

Returns the Kafka Producer configuration property value for the specified option name.

Returns:

Kafka producer configuration option value

producerProperty

public SenderOptions<K,V> producerProperty(String name,
                                           Object value)

Sets Kafka Producer configuration property to the specified value.

Returns:

sender options with updated Kafka producer option

scheduler

public Scheduler scheduler()

Returns the scheduler used for publishing send results.

Returns:

response scheduler

scheduler

public SenderOptions<K,V> scheduler(Scheduler scheduler)

Sets the scheduler used for publishing send results.

Returns:

sender options with updated response scheduler

maxInFlight

public int maxInFlight()

Returns the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending.

Returns:

maximum number of in-flight records

maxInFlight

public SenderOptions<K,V> maxInFlight(int maxInFlight)

Configures the maximum number of in-flight records that are fetched from the outbound record publisher while acknowledgements are pending. This limit must be configured along with ProducerConfig.BUFFER_MEMORY_CONFIG to control memory usage and to avoid blocking the reactive pipeline.

Returns:

sender options with new in-flight limit

closeTimeout

public Duration closeTimeout()

Returns the timeout for graceful shutdown of this sender.

Returns:

close timeout duration

closeTimeout

public SenderOptions<K,V> closeTimeout(Duration timeout)

Configures the timeout for graceful shutdown of this sender.

Returns:

sender options with updated close timeout

toImmutable

public SenderOptions<K,V> toImmutable()

Returns a new immutable instance with the configuration properties of this instance.

Returns:

new immutable instance of sender options