tijos.framework.networkcenter.mqtt

Class MqttConnectOptions

java.lang.Object

tijos.framework.networkcenter.mqtt.MqttConnectOptions

public class MqttConnectOptions
extends Object

Holds the set of options that control how the client connects to a server.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MQTT_VERSION_3_1_1 Mqtt Version 3.1.1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getConnectionTimeout() Returns the connection timeout value.
int	getKeepAliveInterval() Returns the "keep alive" interval.
byte[]	getLWTPayload()
int	getLWTQos()
boolean	getLWTRetained()
String	getLWTTopic()
int	getMaxInflight() Returns the "max inflight".
int	getMqttVersion() Returns the MQTT version.
String	getPassword() Returns the password to use for the connection.
String	getUserName() Returns the user name to use for the connection.
boolean	isAutomaticReconnect() Returns whether the client will automatically attempt to reconnect to the server if the connection is lost
boolean	isCleanSession() Returns whether the client and server should remember state for the client across reconnects.
void	setAutomaticReconnect(boolean automaticReconnect) Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.
void	setCleanSession(boolean cleanSession) Sets whether the client and server should remember state across restarts and reconnects.
void	setConnectionTimeout(int connectionTimeout) Sets the connection timeout value.
void	setKeepAliveInterval(int keepAliveInterval) Sets the "keep alive" interval.
void	setMaxInflight(int maxInflight) Sets the "max inflight".
void	setPassword(String password) Sets the password to use for the connection.
void	setUserName(String userName) Sets the user name to use for the connection.
void	setWill(String topic, byte[] payload, int qos, boolean retained) Sets the "Last Will and Testament" (LWT) for the connection.
String	toString()
static int	validateURI(String srvURI) Validate a URI

Methods inherited from class java.lang.Object

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

Field Detail

MQTT_VERSION_3_1_1

public static final int MQTT_VERSION_3_1_1

Mqtt Version 3.1.1

See Also:

Constant Field Values

Constructor Detail

MqttConnectOptions

public MqttConnectOptions()

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

• The keepalive interval is 60 seconds
• Clean Session is true
• The message delivery retry interval is 15 seconds
• The connection timeout period is 30 seconds
• No Will message is set
• A standard SocketFactory is used

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

Method Detail

getConnectionTimeout

public int getConnectionTimeout()

Returns the connection timeout value.

Returns:

the connection timeout value.

See Also:

setConnectionTimeout(int)

getKeepAliveInterval

public int getKeepAliveInterval()

Returns the "keep alive" interval.

Returns:

the keep alive interval.

See Also:

setKeepAliveInterval(int)

getLWTPayload

public byte[] getLWTPayload()

getLWTQos

public int getLWTQos()

getLWTRetained

public boolean getLWTRetained()

getLWTTopic

public String getLWTTopic()

getMaxInflight

public int getMaxInflight()

Returns the "max inflight". The max inflight limits to how many messages we can send without receiving acknowledgments.

Returns:

the max inflight

See Also:

setMaxInflight(int)

getMqttVersion

public int getMqttVersion()

Returns the MQTT version.

Returns:

the MQTT version.

getPassword

public String getPassword()

Returns the password to use for the connection.

Returns:

the password to use for the connection.

getUserName

public String getUserName()

Returns the user name to use for the connection.

Returns:

the user name to use for the connection.

isAutomaticReconnect

public boolean isAutomaticReconnect()

Returns whether the client will automatically attempt to reconnect to the server if the connection is lost

Returns:

the automatic reconnection flag.

isCleanSession

public boolean isCleanSession()

Returns whether the client and server should remember state for the client across reconnects.

Returns:

the clean session flag

setAutomaticReconnect

public void setAutomaticReconnect(boolean automaticReconnect)

Sets whether the client will automatically attempt to reconnect to the server if the connection is lost.

• If set to false, the client will not attempt to automatically reconnect to the server in the event that the connection is lost.
• If set to true, in the event that the connection is lost, the client will attempt to reconnect to the server. It will initially wait 1 second before it attempts to reconnect, for every failed reconnect attempt, the delay will double until it is at 2 minutes at which point the delay will stay at 2 minutes.

Parameters:

automaticReconnect - If set to True, Automatic Reconnect will be enabled

setCleanSession

public void setCleanSession(boolean cleanSession)

Sets whether the client and server should remember state across restarts and reconnects.

• If set to false both the client and server will maintain state across restarts of the client, the server and the connection. As state is maintained:
  • Message delivery will be reliable meeting the specified QOS even if the client, server or connection are restarted.
  • The server will treat a subscription as durable.
• If set to true the client and server will not maintain state across restarts of the client, the server or the connection. This means
  • Message delivery to the specified QOS cannot be maintained if the client, server or connection are restarted
  • The server will treat a subscription as non-durable

Parameters:

cleanSession - Set to True to enable cleanSession

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Sets the connection timeout value. This value, measured in seconds, defines the maximum time interval the client will wait for the network connection to the MQTT server to be established. The default timeout is 30 seconds. A value of 0 disables timeout processing meaning the client will wait until the network connection is made successfully or fails.

Parameters:

connectionTimeout - the timeout value, measured in seconds. It must be >0;

setKeepAliveInterval

public void setKeepAliveInterval(int keepAliveInterval)
                          throws IllegalArgumentException

Sets the "keep alive" interval. This value, measured in seconds, defines the maximum time interval between messages sent or received. It enables the client to detect if the server is no longer available, without having to wait for the TCP/IP timeout. The client will ensure that at least one message travels across the network within each keep alive period. In the absence of a data-related message during the time period, the client sends a very small "ping" message, which the server will acknowledge. A value of 0 disables keepalive processing in the client.

The default value is 60 seconds

Parameters:

keepAliveInterval - the interval, measured in seconds, must be >= 0.

Throws:

IllegalArgumentException - if the keepAliveInterval was invalid

setMaxInflight

public void setMaxInflight(int maxInflight)

Sets the "max inflight". please increase this value in a high traffic environment.

The default value is 10

Parameters:

maxInflight - the number of maxInfligt messages

setPassword

public void setPassword(String password)

Sets the password to use for the connection.

Parameters:

password - A Char Array of the password

setUserName

public void setUserName(String userName)

Sets the user name to use for the connection.

Parameters:

userName - The Username as a String

Throws:

IllegalArgumentException - if the user name is blank or only contains whitespace characters.

setWill

public void setWill(String topic,
                    byte[] payload,
                    int qos,
                    boolean retained)

Sets the "Last Will and Testament" (LWT) for the connection. In the event that this client unexpectedly loses its connection to the server, the server will publish a message to itself using the supplied details.

Parameters:

topic - the topic to publish to.

payload - the byte payload for the message.

qos - the quality of service to publish the message at (0, 1 or 2).

retained - whether or not the message should be retained.

toString

public String toString()

Overrides:

toString in class Object

validateURI

public static int validateURI(String srvURI)

Validate a URI

Parameters:

srvURI - The Server URI

Returns:

the URI type