Package io.hekate.messaging

Class MessagingBackPressureConfig

java.lang.Object

io.hekate.messaging.MessagingBackPressureConfig

public class MessagingBackPressureConfig
extends Object

Back pressure configuration of a MessagingChannel.

See Also:

MessagingConfigBase.setBackPressure(MessagingBackPressureConfig)

Constructor Summary

Constructors

Constructor	Description
MessagingBackPressureConfig()	Constructs a new instance.
MessagingBackPressureConfig(MessagingBackPressureConfig src)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
int	getInHighWatermark()	Returns the high watermark of inbound (receiving) queue size (see setOutHighWatermark(int)).
int	getInLowWatermark()	Returns the low watermark of inbound (receiving) queue size (see setInLowWatermark(int)).
int	getOutHighWatermark()	Returns the high watermark of outbound (sending) queue size (see setOutHighWatermark(int)).
int	getOutLowWatermark()	Returns the low watermark of outbound (sending) queue size (see setOutLowWatermark(int)).
MessagingOverflowPolicy	getOutOverflowPolicy()	Returns the policy that should be applied when MessagingChannel's outbound (sending) queue size exceeds the limit (see setOutOverflowPolicy(MessagingOverflowPolicy)).
void	setInHighWatermark(int inHighWatermark)	Sets the high watermark of inbound (receiving) queue size.
void	setInLowWatermark(int inLowWatermark)	Sets the low watermark of inbound (receiving) queue size.
void	setOutHighWatermark(int outHighWatermark)	Sets the high watermark of outbound (sending) queue size.
void	setOutLowWatermark(int outLowWatermark)	Sets the low watermark of outbound (sending) queue size.
void	setOutOverflowPolicy(MessagingOverflowPolicy outOverflowPolicy)	Sets the policy that should be applied when MessagingChannel's outbound (sending) queue size exceeds the limit.
String	toString()
MessagingBackPressureConfig	withInHighWatermark(int inHighWatermark)	Fluent-style version of setInHighWatermark(int).
MessagingBackPressureConfig	withInLowWatermark(int inLowWatermark)	Fluent-style version of setInLowWatermark(int).
MessagingBackPressureConfig	withOutHighWatermark(int outHighWatermark)	Fluent-style version of setOutHighWatermark(int).
MessagingBackPressureConfig	withOutLowWatermark(int outLowWatermark)	Fluent-style version of setOutLowWatermark(int).
MessagingBackPressureConfig	withOutOverflowPolicy(MessagingOverflowPolicy outOverflow)	Fluent-style version of setOutOverflowPolicy(MessagingOverflowPolicy).

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagingBackPressureConfig

public MessagingBackPressureConfig()

Constructs a new instance.

MessagingBackPressureConfig

public MessagingBackPressureConfig(MessagingBackPressureConfig src)

Copy constructor.

Parameters:

src - Copy from.

Method Detail

getInLowWatermark

public int getInLowWatermark()

Returns the low watermark of inbound (receiving) queue size (see setInLowWatermark(int)).

Returns:

Low watermark of inbound queue size.

setInLowWatermark

public void setInLowWatermark(int inLowWatermark)

Sets the low watermark of inbound (receiving) queue size.

Value of this parameter must be less than the value of setInHighWatermark(int) parameter.

Parameters:

inLowWatermark - Low watermark of inbound queue size.

See Also:

setInHighWatermark(int)

withInLowWatermark

public MessagingBackPressureConfig withInLowWatermark(int inLowWatermark)

Fluent-style version of setInLowWatermark(int).

Parameters:

inLowWatermark - Low watermark of inbound queue size.

Returns:

This instance.

getInHighWatermark

public int getInHighWatermark()

Returns the high watermark of inbound (receiving) queue size (see setOutHighWatermark(int)).

Returns:

High watermark of inbound queue size.

setInHighWatermark

public void setInHighWatermark(int inHighWatermark)

Sets the high watermark of inbound (receiving) queue size.

If value of this parameter is less than or equals to zero (default) then back pressure will not be applied to inbound message queue.

Parameters:

inHighWatermark - High watermark of inbound queue size.

See Also:

setInLowWatermark(int)

withInHighWatermark

public MessagingBackPressureConfig withInHighWatermark(int inHighWatermark)

Fluent-style version of setInHighWatermark(int).

Parameters:

inHighWatermark - High watermark of inbound queue size.

Returns:

This instance.

getOutLowWatermark

public int getOutLowWatermark()

Returns the low watermark of outbound (sending) queue size (see setOutLowWatermark(int)).

Returns:

Low watermark of outbound queue size.

setOutLowWatermark

public void setOutLowWatermark(int outLowWatermark)

Sets the low watermark of outbound (sending) queue size.

This parameter is mandatory only if setOutOverflowPolicy(MessagingOverflowPolicy) is set to any other value besides MessagingOverflowPolicy.IGNORE. Value of this parameter must be less than the value of setOutHighWatermark(int) parameter.

Parameters:

outLowWatermark - Low watermark of outbound queue size.

See Also:

setOutHighWatermark(int), setOutOverflowPolicy(MessagingOverflowPolicy)

withOutLowWatermark

public MessagingBackPressureConfig withOutLowWatermark(int outLowWatermark)

Fluent-style version of setOutLowWatermark(int).

Parameters:

outLowWatermark - Low watermark of outbound queue size.

Returns:

This instance.

getOutHighWatermark

public int getOutHighWatermark()

Returns the high watermark of outbound (sending) queue size (see setOutHighWatermark(int)).

Returns:

High watermark of outbound queue size.

setOutHighWatermark

public void setOutHighWatermark(int outHighWatermark)

Sets the high watermark of outbound (sending) queue size.

This parameter is mandatory only if setOutOverflowPolicy(MessagingOverflowPolicy) is set to any other value besides MessagingOverflowPolicy.IGNORE.

Parameters:

outHighWatermark - High watermark of outbound queue size.

See Also:

setOutLowWatermark(int), setOutOverflowPolicy(MessagingOverflowPolicy)

withOutHighWatermark

public MessagingBackPressureConfig withOutHighWatermark(int outHighWatermark)

Fluent-style version of setOutHighWatermark(int).

Parameters:

outHighWatermark - High watermark of outbound queue size.

Returns:

This instance.

getOutOverflowPolicy

public MessagingOverflowPolicy getOutOverflowPolicy()

Returns the policy that should be applied when MessagingChannel's outbound (sending) queue size exceeds the limit (see setOutOverflowPolicy(MessagingOverflowPolicy)).

Returns:

Policy.

setOutOverflowPolicy

public void setOutOverflowPolicy(MessagingOverflowPolicy outOverflowPolicy)

Sets the policy that should be applied when MessagingChannel's outbound (sending) queue size exceeds the limit.

Default value of this parameter is MessagingOverflowPolicy.IGNORE. If any other value is specified then setOutHighWatermark(int) must be set to a value that is greater than zero.

Parameters:

outOverflowPolicy - Policy.

withOutOverflowPolicy

public MessagingBackPressureConfig withOutOverflowPolicy(MessagingOverflowPolicy outOverflow)

Fluent-style version of setOutOverflowPolicy(MessagingOverflowPolicy).

Parameters:

outOverflow - Policy.

Returns:

This instance.

toString

public String toString()

Overrides:

toString in class Object