org.eclipse.paho.client.mqttv3

Class DisconnectedBufferOptions

java.lang.Object

org.eclipse.paho.client.mqttv3.DisconnectedBufferOptions

public class DisconnectedBufferOptions
extends java.lang.Object

Holds the set of options that govern the behaviour of Offline (or Disconnected) buffering of messages

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DELETE_OLDEST_MESSAGES_DEFAULT
static boolean	DISCONNECTED_BUFFER_ENABLED_DEFAULT
static int	DISCONNECTED_BUFFER_SIZE_DEFAULT The default size of the disconnected buffer
static boolean	PERSIST_DISCONNECTED_BUFFER_DEFAULT

Constructor Summary

Constructors

Constructor and Description
DisconnectedBufferOptions() Constructs a new DisconnectedBufferOptions object using the default values.

Method Summary

Modifier and Type	Method and Description
int	getBufferSize()
boolean	isBufferEnabled()
boolean	isDeleteOldestMessages()
boolean	isPersistBuffer()
void	setBufferEnabled(boolean bufferEnabled)
void	setBufferSize(int bufferSize)
void	setDeleteOldestMessages(boolean deleteOldestMessages)
void	setPersistBuffer(boolean persistBuffer)

Methods inherited from class java.lang.Object

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

Field Detail

DISCONNECTED_BUFFER_SIZE_DEFAULT

public static final int DISCONNECTED_BUFFER_SIZE_DEFAULT

The default size of the disconnected buffer

See Also:

Constant Field Values

DISCONNECTED_BUFFER_ENABLED_DEFAULT

public static final boolean DISCONNECTED_BUFFER_ENABLED_DEFAULT

See Also:

Constant Field Values

PERSIST_DISCONNECTED_BUFFER_DEFAULT

public static final boolean PERSIST_DISCONNECTED_BUFFER_DEFAULT

See Also:

Constant Field Values

DELETE_OLDEST_MESSAGES_DEFAULT

public static final boolean DELETE_OLDEST_MESSAGES_DEFAULT

See Also:

Constant Field Values

Constructor Detail

DisconnectedBufferOptions

public DisconnectedBufferOptions()

Constructs a new DisconnectedBufferOptions object using the default values. The defaults are:

• The disconnected buffer is disabled
• The buffer holds 5000 messages
• The buffer is not persisted
• Once the buffer is full, old messages are not deleted

More information about these values can be found in the setter methods.

Method Detail

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int bufferSize)

isBufferEnabled

public boolean isBufferEnabled()

setBufferEnabled

public void setBufferEnabled(boolean bufferEnabled)

isPersistBuffer

public boolean isPersistBuffer()

setPersistBuffer

public void setPersistBuffer(boolean persistBuffer)

isDeleteOldestMessages

public boolean isDeleteOldestMessages()

setDeleteOldestMessages

public void setDeleteOldestMessages(boolean deleteOldestMessages)