com.hivemq.spi.services.configuration

Interface ThrottlingConfigurationService

public interface ThrottlingConfigurationService

A Configuration service which allows to get information about the current throttling configuration and allows to change the global throttling configuration of HiveMQ at runtime.

Since:

3.0

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
long	incomingLimit()
void	incomingLimitChanged(ValueChangedCallback<Long> callback) Adds a callback which gets called when the incoming bandwidth limit changes at runtime
long	maxConnections() Returns the maximum allowed connections.
void	maxConnectionsChanged(ValueChangedCallback<Long> callback) Adds a callback which gets called when the maximum concurrent connections changes at runtime
int	maxMessageSize()
void	maxMessageSizeChanged(ValueChangedCallback<Integer> callback) Adds a callback which gets called when the maximum message size changes at runtime
long	outgoingLimit()
void	outgoingLimitChanged(ValueChangedCallback<Long> callback) Adds a callback which gets called when the outgoing bandwidth limit changes at runtime
int	pluginServiceRateLimit()
void	pluginServiceRateLimitChanged(ValueChangedCallback<Integer> callback) Adds a callback which gets called when the plugin service call rate limit changes at runtime
void	setIncomingLimit(long incomingLimit) Changes the incoming bandwidth limit at runtime
void	setMaxConnections(long maxConnections) Changes the maximum concurrent connections at runtime.
void	setMaxMessageSize(int maxMessageSize) Changes the maximum allowed MQTT message size at runtime
void	setOutgoingLimit(long outgoingLimit) Changes the outgoing bandwidth limit at runtime
void	setPluginServiceRateLimit(int pluginServiceRateLimit) Changes the plugin service call rate limit per second at runtime

Method Detail

maxConnections

long maxConnections()

Returns the maximum allowed connections.

This method only returns the configuration of maximum concurrent MQTT connections, not the value your HiveMQ license is limited to.

Returns:

the maximum allowed connections.

maxMessageSize

int maxMessageSize()

Returns:

the maximum allowed MQTT message size in bytes

outgoingLimit

long outgoingLimit()

Returns:

the outgoing bandwidth limit in bytes

incomingLimit

long incomingLimit()

Returns:

the incoming bandwidth limit in bytes

pluginServiceRateLimit

int pluginServiceRateLimit()

Returns:

the plugin service call rate limit per second

setMaxConnections

void setMaxConnections(long maxConnections)

Changes the maximum concurrent connections at runtime.

Parameters:

maxConnections - the maximum concurrent MQTT connections

setMaxMessageSize

void setMaxMessageSize(int maxMessageSize)

Changes the maximum allowed MQTT message size at runtime

Parameters:

maxMessageSize - the maximum allowed MQTT message size in bytes

setOutgoingLimit

void setOutgoingLimit(long outgoingLimit)

Changes the outgoing bandwidth limit at runtime

Parameters:

outgoingLimit - the outgoing bandwidth limit in bytes

setIncomingLimit

void setIncomingLimit(long incomingLimit)

Changes the incoming bandwidth limit at runtime

Parameters:

incomingLimit - the incoming bandwidth limit in bytes

setPluginServiceRateLimit

void setPluginServiceRateLimit(int pluginServiceRateLimit)

Changes the plugin service call rate limit per second at runtime

Parameters:

pluginServiceRateLimit - the plugin service call rate limit per second

maxConnectionsChanged

void maxConnectionsChanged(ValueChangedCallback<Long> callback)

Adds a callback which gets called when the maximum concurrent connections changes at runtime

Parameters:

callback - the ValueChangedCallback

maxMessageSizeChanged

void maxMessageSizeChanged(ValueChangedCallback<Integer> callback)

Adds a callback which gets called when the maximum message size changes at runtime

Parameters:

callback - the ValueChangedCallback

outgoingLimitChanged

void outgoingLimitChanged(ValueChangedCallback<Long> callback)

Adds a callback which gets called when the outgoing bandwidth limit changes at runtime

Parameters:

callback - the ValueChangedCallback

incomingLimitChanged

void incomingLimitChanged(ValueChangedCallback<Long> callback)

Adds a callback which gets called when the incoming bandwidth limit changes at runtime

Parameters:

callback - the ValueChangedCallback

pluginServiceRateLimitChanged

void pluginServiceRateLimitChanged(ValueChangedCallback<Integer> callback)

Adds a callback which gets called when the plugin service call rate limit changes at runtime

Parameters:

callback - the ValueChangedCallback