io.axual.client.config

Class BaseProducerConfig<K,V>

java.lang.Object

io.axual.client.config.BaseProducerConfig<K,V>

Type Parameters:

K - the type of the key that will be produced. A compatible key serializer must be provided to serialize the objects

V - the type of the value that will be produced. A compatible value serializer must be provided to serialize the objects

Direct Known Subclasses:

BaseAvroProducerConfig, ProducerConfig

public class BaseProducerConfig<K,V>
extends java.lang.Object

This is the base for all AxualClient Producer configurations. It contains the settings all producers have in common. Extend this class when defining a new Producer type. A Builder pattern is used for initialization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseProducerConfig.Builder<K,V,T extends BaseProducerConfig.Builder<K,V,T>> The Builder is used to set the configuration options.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_SIZE
static long	DEFAULT_LINGER_MS
static ProxyChain	DEFAULT_PROXY_CHAIN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseProducerConfig(BaseProducerConfig.Builder<K,V,?> builder) Instantiates a new Base producer config.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getBatchSize() Returns the maximum size in bytes of the batch of messages to produce before sending.
DeliveryStrategy	getDeliveryStrategy() Returns the delivery strategy the producer should implement.
java.lang.Object	getKeySerializer() Returns the configured serializer used for key serialization.
long	getLingerMs() Returns the time to wait after a batch has been created before sending.
int	getMessageBufferSize() Returns the maximum size of the message buffer used by the worker.
int	getMessageBufferWaitTimeout() Returns the maximum amount of time in milliseconds to wait for room in the message buffer.
OrderingStrategy	getOrderingStrategy() Returns the ordering strategy the producer should implement.
ProxyChain	getProxyChain() Returns the chain of producer proxies this producer uses.
java.lang.Object	getValueSerializer() Returns the configured serializer used for value serialization.
boolean	isBlocking() This indicates if the produce call is blocked when the messageBuffer is full

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROXY_CHAIN

public static final ProxyChain DEFAULT_PROXY_CHAIN

DEFAULT_LINGER_MS

public static final long DEFAULT_LINGER_MS

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

Constructor Detail

BaseProducerConfig

protected BaseProducerConfig(BaseProducerConfig.Builder<K,V,?> builder)

Instantiates a new Base producer config.

Parameters:

builder - the builder containing the configuration values

Method Detail

getDeliveryStrategy

public DeliveryStrategy getDeliveryStrategy()

Returns the delivery strategy the producer should implement. See DeliveryStrategy for the available strategies.

Returns:

the delivery strategy configured in this object

getOrderingStrategy

public OrderingStrategy getOrderingStrategy()

Returns the ordering strategy the producer should implement. See OrderingStrategy for the available strategies.

Returns:

the ordering strategy configured in this object

isBlocking

public boolean isBlocking()

This indicates if the produce call is blocked when the messageBuffer is full

Returns:

true if blocking

getMessageBufferSize

public int getMessageBufferSize()

Returns the maximum size of the message buffer used by the worker.

Returns:

the maximum size of the message buffer

getMessageBufferWaitTimeout

public int getMessageBufferWaitTimeout()

Returns the maximum amount of time in milliseconds to wait for room in the message buffer.

Returns:

the message buffer wait timeout

getKeySerializer

public java.lang.Object getKeySerializer()

Returns the configured serializer used for key serialization. The class must implement Serializer

Returns:

the the name of the class used for key serialization

getValueSerializer

public java.lang.Object getValueSerializer()

Returns the configured serializer used for value serialization. The class must implement Serializer

Returns:

the the name of the class used for value serialization

getBatchSize

public java.lang.Integer getBatchSize()

Returns the maximum size in bytes of the batch of messages to produce before sending. When the batch size has been reached, or when the linger time has been exceeded, the messages will be send. The linger time getLingerMs() also plays a role in the batching of messages

Returns:

the maximum batch size

getLingerMs

public long getLingerMs()

Returns the time to wait after a batch has been created before sending. When the batch size has been reached, or when the linger time has been exceeded, the messages will be send. The linger time getBatchSize() also plays a role in the batching of messages

Returns:

the time to wait before sending the batch

getProxyChain

public ProxyChain getProxyChain()

Returns the chain of producer proxies this producer uses.

Returns:

the proxy chain used to configure this producer.