Package io.awspring.cloud.sqs.listener.backpressure

Class FullBatchBackPressureHandler

java.lang.Object

io.awspring.cloud.sqs.listener.backpressure.FullBatchBackPressureHandler

All Implemented Interfaces:

BackPressureHandler, BatchAwareBackPressureHandler, IdentifiableContainerComponent

public class FullBatchBackPressureHandler
extends Object
implements BatchAwareBackPressureHandler, IdentifiableContainerComponent

Non-blocking BackPressureHandler implementation that ensures the exact batch size is requested.

If the amount of permits being requested is not equal to the batch size, permits will be limited to 0. For this limiting mechanism to work, the FullBatchBackPressureHandler must be used in combination with another BackPressureHandler and be the last one in the chain of the CompositeBackPressureHandler

This handler builds on the original SemaphoreBackPressureHandler, separating specific responsibilities into a more modular form and enabling composition with other handlers as part of an extensible backpressure strategy.

Since:

4.0.0

Author:

Loïc Rouchon, Tomaz Fernandes

See Also:

• PollingMessageSource
• CompositeBackPressureHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FullBatchBackPressureHandler.Builder

Nested classes/interfaces inherited from interface io.awspring.cloud.sqs.listener.backpressure.BackPressureHandler

BackPressureHandler.ReleaseReason

Method Summary

Modifier and Type	Method	Description
static FullBatchBackPressureHandler.Builder	builder()
boolean	drain(Duration timeout)	Attempts to acquire all permits up to the specified timeout.
String	getId()	Get the component id.
void	release(int amount, BackPressureHandler.ReleaseReason reason)	Releases the specified amount of permits for processed messages.
int	request(int amount)	Requests a number of permits.
int	requestBatch()	Request a batch of permits.
void	setId(String id)	Set the component id.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.awspring.cloud.sqs.listener.backpressure.BackPressureHandler

release

Methods inherited from interface io.awspring.cloud.sqs.listener.backpressure.BatchAwareBackPressureHandler

getBatchSize, releaseBatch

Method Details

builder

public static FullBatchBackPressureHandler.Builder builder()

setId

public void setId(String id)

Description copied from interface: IdentifiableContainerComponent

Set the component id.

Specified by:

setId in interface IdentifiableContainerComponent

Parameters:

id - the id.

getId

public String getId()

Description copied from interface: IdentifiableContainerComponent

Get the component id.

Specified by:

getId in interface IdentifiableContainerComponent

Returns:

the id.

requestBatch

public int requestBatch()
                 throws InterruptedException

Description copied from interface: BatchAwareBackPressureHandler

Request a batch of permits.

Specified by:

requestBatch in interface BatchAwareBackPressureHandler

Returns:

the number of permits acquired.

Throws:

InterruptedException - if the Thread is interrupted while waiting for permits.

request

public int request(int amount)
            throws InterruptedException

Description copied from interface: BackPressureHandler

Requests a number of permits. Each obtained permit allows the MessageSource to retrieve one message.

Specified by:

request in interface BackPressureHandler

Parameters:

amount - the amount of permits to request.

Returns:

the amount of permits obtained.

Throws:

InterruptedException - if the Thread is interrupted while waiting for permits.

release

public void release(int amount,
 BackPressureHandler.ReleaseReason reason)

Description copied from interface: BackPressureHandler

Releases the specified amount of permits for processed messages. Each message that has been processed should release one permit, whether processing was successful or not.

This method can be called in the following use cases:

• BackPressureHandler.ReleaseReason.LIMITED: all/some permits were not used because another BackPressureHandler has a lower permits limit and the difference in permits needs to be returned.
• BackPressureHandler.ReleaseReason.NONE_FETCHED: none of the permits were actually used because no messages were retrieved from SQS. Permits need to be returned.
• BackPressureHandler.ReleaseReason.PARTIAL_FETCH: some of the permits were used (some messages were retrieved from SQS). The unused ones need to be returned. The amount to be returned might be 0, in which case it means all the permits will be used as the same number of messages were fetched from SQS.
• BackPressureHandler.ReleaseReason.PROCESSED: a message processing finished, successfully or not.

Specified by:

release in interface BackPressureHandler

Specified by:

release in interface BatchAwareBackPressureHandler

Parameters:

amount - the amount of permits to release.

reason - the reason why the permits were released.

drain

public boolean drain(Duration timeout)

Description copied from interface: BackPressureHandler

Attempts to acquire all permits up to the specified timeout. If successful, means all permits were returned and thus no activity is left in the MessageSource.

Specified by:

drain in interface BackPressureHandler

Parameters:

timeout - the maximum amount of time to wait for all permits to be released.

Returns:

whether all permits were acquired.