com.solace.messaging.config

Interface PublisherBackPressureConfiguration

All Known Subinterfaces:

DirectMessagePublisherBuilder, MessagePublisherBuilder, PersistentMessagePublisherBuilder

@ProviderType
public interface PublisherBackPressureConfiguration

An interface for the configuration of back-pressure features for a message publisher.

All onBackPressure methods are mutually-exclusive and must be called once only.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
PublisherBackPressureConfiguration	onBackPressureElastic() The configuration for back-pressure with an elastic, unlimited capacity buffer.
PublisherBackPressureConfiguration	onBackPressureReject(int bufferCapacity) The configuration for back-pressure with a specified number of buffered messages.
PublisherBackPressureConfiguration	onBackPressureWait(int bufferCapacity) The configuration for back-pressure with specified number of buffered messages.

Method Detail

onBackPressureElastic

PublisherBackPressureConfiguration onBackPressureElastic()

The configuration for back-pressure with an elastic, unlimited capacity buffer. This configuration is recommended for microservices that run in a managed environment which can detect crashes and restart those microservices. Usage of this strategy for applications can lead to out-of-memory situations.

Returns:

an instance of itself

Since:

1.0

onBackPressureReject

PublisherBackPressureConfiguration onBackPressureReject(int bufferCapacity)

The configuration for back-pressure with a specified number of buffered messages. Usage of this configuration means that attempts to publish are rejected with a PubSubPlusClientException.PublisherOverflowException exception when the publishing capabilities of the API are exceeded.

Parameters:

bufferCapacity - the maximum number of messages that can be buffered before the strategy fails and messages can no longer be sent over the wire. Once this number is exceeded, the publishing of new messages is no longer possible and exceptions are thrown until the buffer has free capacity; value > 0 is expected.

Returns:

an instance of itself

Since:

1.0

onBackPressureWait

PublisherBackPressureConfiguration onBackPressureWait(int bufferCapacity)

The configuration for back-pressure with specified number of buffered messages. Usage of this configuration means that attempts to publish beyond the specified bufferCapacity causes the publisher thread to pause.

Parameters:

bufferCapacity - the maximum number of messages that can be buffered before the publishing thread is paused

Returns:

an instance of itself

Since:

1.0