org.axonframework.axonserver.connector

Class AxonServerConfiguration.FlowControlConfiguration

java.lang.Object

org.axonframework.axonserver.connector.AxonServerConfiguration.FlowControlConfiguration

Enclosing class:

AxonServerConfiguration

public static class AxonServerConfiguration.FlowControlConfiguration
extends Object

Configuration class for Flow Control of specific message types.

Since:

4.3

Author:

Gerlo Hesselink

Constructor Summary

Constructors

Constructor and Description
FlowControlConfiguration(Integer permits, Integer nrOfNewPermits, Integer newPermitsThreshold) Construct a AxonServerConfiguration.FlowControlConfiguration.

Method Summary

Modifier and Type	Method and Description
Integer	getInitialNrOfPermits() Deprecated. In favor of getPermits().
Integer	getNewPermitsThreshold() The threshold at which the application sends new permits to server.
Integer	getNrOfNewPermits() Additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.
Integer	getPermits() The initial number of permits send for message streams (events, commands, queries).
void	setInitialNrOfPermits(Integer initialNrOfPermits) Deprecated. In favor of setPermits(Integer).
void	setNewPermitsThreshold(Integer newPermitsThreshold) Sets the threshold at which the application sends new permits to server.
void	setNrOfNewPermits(Integer nrOfNewPermits) Sets the additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.
void	setPermits(Integer permits) Sets the initial number of permits send for message streams (events, commands, queries).

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowControlConfiguration

public FlowControlConfiguration(Integer permits,
                                Integer nrOfNewPermits,
                                Integer newPermitsThreshold)

Construct a AxonServerConfiguration.FlowControlConfiguration.

Parameters:

permits - Initial nr of new permits.

nrOfNewPermits - Additional number of permits when application is ready for message.

newPermitsThreshold - Threshold at which application sends new permits to server.

Method Detail

getInitialNrOfPermits

@Deprecated
public Integer getInitialNrOfPermits()

Deprecated. In favor of getPermits().

setInitialNrOfPermits

@Deprecated
public void setInitialNrOfPermits(Integer initialNrOfPermits)

Deprecated. In favor of setPermits(Integer).

getPermits

public Integer getPermits()

The initial number of permits send for message streams (events, commands, queries). Defaults to 5000 permits.

Returns:

The initial number of permits send for message streams (events, commands, queries).

setPermits

public void setPermits(Integer permits)

Sets the initial number of permits send for message streams (events, commands, queries). Defaults to 5000 permits.

Parameters:

permits - The initial number of permits send for message streams (events, commands, queries).

getNrOfNewPermits

public Integer getNrOfNewPermits()

Additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.

A value of null, 0, and negative values will have the client request the number of permits required to get from the "new-permits-threshold" to "initial-nr-of-permits".

Returns:

The additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.

setNrOfNewPermits

public void setNrOfNewPermits(Integer nrOfNewPermits)

Sets the additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.

A value of null, 0, and negative values will have the client request the number of permits required to get from the "new-permits-threshold" to "initial-nr-of-permits".

Parameters:

nrOfNewPermits - The additional number of permits send for message streams (events, commands, queries) when application is ready for more messages.

getNewPermitsThreshold

public Integer getNewPermitsThreshold()

The threshold at which the application sends new permits to server.

A value of null, 0, and negative values will have the threshold set to 50% of the initial number of permits.

Returns:

The threshold at which the application sends new permits to server.

setNewPermitsThreshold

public void setNewPermitsThreshold(Integer newPermitsThreshold)

Sets the threshold at which the application sends new permits to server.

A value of null, 0, and negative values will have the threshold set to 50% of the initial number of permits.

Parameters:

newPermitsThreshold - The threshold at which the application sends new permits to server.