com.hivemq.spi.services.configuration

Interface MqttConfigurationService

public interface MqttConfigurationService

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

Since:

3.0

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
int	maxClientIdLength()
long	maxQueuedMessages()
int	messageTimeToLive()
long	noConnectIdleTimeoutMillis()
int	offlineClientSessionTimeToLive()
int	retainedMessageTimeToLive()
int	retryInterval()
void	setMaxClientIdLength(int maxClientIdLength)
void	setMaxQueuedMessages(long maxQueuedMessages)
void	setMessageTimeToLive(int messageTimeToLive)
void	setNoConnectIdleTimeoutMillis(long noConnectPacketIdleTimeoutMillis)
void	setOfflineClientSessionTimeToLive(int offlineClientSessionTimeToLive)
void	setRetainedMessageTimeToLive(int retainedMessageTimeToLive)
void	setRetryInterval(int retryInterval)

Method Detail

maxClientIdLength

int maxClientIdLength()

Returns:

the global maximum allowed client identifier length

retryInterval

int retryInterval()

Returns:

the global retry interval in seconds for resending unacknowledged MQTT packets

maxQueuedMessages

long maxQueuedMessages()

Returns:

the global maximum in-flight queued messages per client

noConnectIdleTimeoutMillis

long noConnectIdleTimeoutMillis()

Returns:

the global maximum timeout for idle TCP connections of clients which didn't send a CONNECT message.

offlineClientSessionTimeToLive

int offlineClientSessionTimeToLive()

Returns:

the default time to live for client sessions. The time to live applies to offline clients.

messageTimeToLive

int messageTimeToLive()

Returns:

the default time to live for publish messages.

retainedMessageTimeToLive

int retainedMessageTimeToLive()

Returns:

the default time to live for retained messages.

setMaxClientIdLength

void setMaxClientIdLength(int maxClientIdLength)

setRetryInterval

void setRetryInterval(int retryInterval)

setMaxQueuedMessages

void setMaxQueuedMessages(long maxQueuedMessages)

setNoConnectIdleTimeoutMillis

void setNoConnectIdleTimeoutMillis(long noConnectPacketIdleTimeoutMillis)

setOfflineClientSessionTimeToLive

void setOfflineClientSessionTimeToLive(int offlineClientSessionTimeToLive)

setMessageTimeToLive

void setMessageTimeToLive(int messageTimeToLive)

setRetainedMessageTimeToLive

void setRetainedMessageTimeToLive(int retainedMessageTimeToLive)