A B C D E F G H I J L M N P Q R S T U V W X

A

AbstractBlockingCommand<T> - Class in net.sf.xenqtt.message

Implementation of BlockingCommand that provides a simple extension point for command implementations.

AbstractBlockingCommand() - Constructor for class net.sf.xenqtt.message.AbstractBlockingCommand

ack() - Method in class net.sf.xenqtt.client.PublishMessage

Sends an acknowledgment to the broker for this message unless PublishMessage.getQoS() is QoS.AT_MOST_ONCE in which case this does nothing.

addCredentials(String, String) - Method in class net.sf.xenqtt.mockbroker.MockBroker

Adds the specified credentials for authentication by ConnectMessages.

AppContext - Class in net.sf.xenqtt

Contains the application context for a Xenqtt application

AppContext() - Constructor for class net.sf.xenqtt.AppContext

Create a new instance of this class.

AppContext(List<String>, Map<String, String>) - Constructor for class net.sf.xenqtt.AppContext

Create a new instance of this class.

AppContext(List<String>, Map<String, String>, CountDownLatch) - Constructor for class net.sf.xenqtt.AppContext

Create a new instance of this class.

applicationDone() - Method in class net.sf.xenqtt.AppContext

Invoke if your application has finished its work and no longer needs to run.

AsyncClientFactory - Interface in net.sf.xenqtt.client

Used to create multiple "sibling" async clients that share an Executor, broker URI, etc.

AsyncClientListener - Interface in net.sf.xenqtt.client

Implement this interface to use the AsyncMqttClient.

AsyncMqttClient - Class in net.sf.xenqtt.client

An MqttClient that handles interactions with the MQTT broker in an asynchronous fashion.

AsyncMqttClient(String, AsyncClientListener, int) - Constructor for class net.sf.xenqtt.client.AsyncMqttClient

Constructs an instance of this class using an Executor owned by this class with the default config.

AsyncMqttClient(String, AsyncClientListener, int, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.AsyncMqttClient

Constructs an instance of this class using an Executor owned by this class with a custom config.

AsyncMqttClient(String, AsyncClientListener, Executor) - Constructor for class net.sf.xenqtt.client.AsyncMqttClient

Constructs an instance of this class using a user provided Executor with the default config.

AsyncMqttClient(String, AsyncClientListener, Executor, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.AsyncMqttClient

Constructs an instance of this class using a user provided Executor with a custom config.

attachChannel(MqttChannelRef, MessageHandler) - Method in interface net.sf.xenqtt.message.ChannelManager

Attaches the specified channel to this manager's control.

attachChannel(MqttChannelRef, MessageHandler) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

await() - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

await(long, TimeUnit) - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

await() - Method in interface net.sf.xenqtt.message.BlockingCommand

Waits indefinitely for the command to complete.

await(long, TimeUnit) - Method in interface net.sf.xenqtt.message.BlockingCommand

Waits for the specified amount of time for the command to complete

B

BlockingCommand<T> - Interface in net.sf.xenqtt.message

Command that allows the calling thread to block until the command is completed.

BlockingTcpEchoClient - Class in net.sf.xenqtt.test

This client sends data to a TCP echo server using blocking IO.

BlockingTcpEchoServer - Class in net.sf.xenqtt.test

Server that uses blocking IO to accept new connections and echo any data received back to the sender.

BrokerEvent - Class in net.sf.xenqtt.mockbroker

An event that hqppened on the broker (message sent, message received, etc)

BrokerEventType - Enum in net.sf.xenqtt.mockbroker

Type of event for BrokerEvent.

byteBufferToHex(ByteBuffer) - Static method in class net.sf.xenqtt.message.MqttMessage

bytesToHex(byte[]) - Static method in class net.sf.xenqtt.message.MqttMessage

C

cancel() - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

cancel() - Method in interface net.sf.xenqtt.message.BlockingCommand

Cancels the command causes BlockingCommand.await() or BlockingCommand.await(long, TimeUnit) to throw an MqttCommandCancelledException.This should only be called by the same thread that calls #execute().

cancelBlockingCommands(MqttChannelRef) - Method in interface net.sf.xenqtt.message.ChannelManager

Cancels all blocking commands for the specified channel.

cancelBlockingCommands(MqttChannelRef) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

cancelBlockingCommands() - Method in interface net.sf.xenqtt.message.MqttChannel

Cancels all blocking commands.

channelAttached(MqttChannel) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when an MQTT channel is attached to a channel manager.

channelClosed(MqttChannel, Throwable) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when an MQTT channel is formally closed.

channelClosed(Client, Throwable) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

channelDetached(MqttChannel) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when an MQTT channel is detached from a channel manager.

ChannelManager - Interface in net.sf.xenqtt.message

Specifies a type that manages zero or more channels that communicate via the MQTT protocol.

ChannelManagerImpl - Class in net.sf.xenqtt.message

Uses a single thread and non-blocking NIO to manage one or more MqttChannels.

ChannelManagerImpl(long) - Constructor for class net.sf.xenqtt.message.ChannelManagerImpl

Use this constructor for the asynchronous API

ChannelManagerImpl(long, int) - Constructor for class net.sf.xenqtt.message.ChannelManagerImpl

Use this constructor for the synchronous API

channelOpened(MqttChannel) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a MQTT channel is opened.

channelOpened(Client) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

clearEvents() - Method in class net.sf.xenqtt.mockbroker.MockBroker

Removes all broker events

Client - Class in net.sf.xenqtt.mockbroker

Info on a client connected to the mock broker

ClientFactory - Interface in net.sf.xenqtt.client

Base interface for SyncClientFactory and AsyncClientFactory.

clone() - Method in class net.sf.xenqtt.client.FixedReconnectionStrategy

clone() - Method in class net.sf.xenqtt.client.MqttClientConfig

clone() - Method in class net.sf.xenqtt.client.NullReconnectStrategy

clone() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

clone() - Method in interface net.sf.xenqtt.client.ReconnectionStrategy

close() - Method in interface net.sf.xenqtt.client.MqttClient

Closes this client without doing a clean disconnect.

close(MqttChannelRef) - Method in interface net.sf.xenqtt.message.ChannelManager

Closes the specified channel.

close(MqttChannelRef, Throwable) - Method in interface net.sf.xenqtt.message.ChannelManager

Closes the specified channel and sends cause to the MessageHandler.channelClosed(MqttChannel, Throwable) callback.

close(MqttChannelRef) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

close(MqttChannelRef, Throwable) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

close() - Method in interface net.sf.xenqtt.message.MqttChannel

Closes the underlying channels, sockets, etc

close(Throwable) - Method in interface net.sf.xenqtt.message.MqttChannel

Closes the underlying channels, sockets, etc and sends cause to the MessageHandler.channelClosed(MqttChannel, Throwable) callback.

close() - Method in class net.sf.xenqtt.mockbroker.Client

Closes the connection to this client

complete() - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

complete() - Method in interface net.sf.xenqtt.message.BlockingCommand

Called when the command is complete.

ConfigurableThreadFactory - Class in net.sf.xenqtt

A ThreadFactory implementation that allows for configurable threads to be produced.

ConfigurableThreadFactory(String, boolean) - Constructor for class net.sf.xenqtt.ConfigurableThreadFactory

Create a new instance of this class.

connAck(MqttChannel, ConnAckMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a ConnAckMessage is received through the specified channel

ConnAckMessage - Class in net.sf.xenqtt.message

The CONNACK message is the message sent by the server in response to a CONNECT request from a client.

ConnAckMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.ConnAckMessage

Used to construct a received message.

ConnAckMessage(ConnectReturnCode) - Constructor for class net.sf.xenqtt.message.ConnAckMessage

Used to construct a message for sending

connect(String, boolean, String, String, String, String, QoS, boolean) - Method in interface net.sf.xenqtt.client.MqttClient

Connects this client to the broker with credentials and a WillMessage.

connect(String, boolean) - Method in interface net.sf.xenqtt.client.MqttClient

Connects this client to the broker with no credentials and no Will Message.

connect(String, boolean, String, String) - Method in interface net.sf.xenqtt.client.MqttClient

Connects this client to the broker with credentials but no Will Message.

connect(String, boolean, String, String, QoS, boolean) - Method in interface net.sf.xenqtt.client.MqttClient

Connects this client to the broker with a Will Message but no credentials.

connect(MqttChannel, ConnectMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a ConnectMessage is received through the specified channel

connect(Client, ConnectMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

connected(MqttClient, ConnectReturnCode) - Method in interface net.sf.xenqtt.client.AsyncClientListener

Called after the client has received a connect acknowledgment from the broker.

connectionClosed(MqttClient, String, String) - Method in interface net.sf.xenqtt.client.MqttClientDebugListener

Called when a connection is closed.

connectionEstablished() - Method in class net.sf.xenqtt.client.FixedReconnectionStrategy

connectionEstablished() - Method in class net.sf.xenqtt.client.NullReconnectStrategy

connectionEstablished() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

connectionEstablished() - Method in interface net.sf.xenqtt.client.ReconnectionStrategy

Called by an MqttClient instance when a connection to the broker is established.

connectionLost(MqttClient, Throwable) - Method in class net.sf.xenqtt.client.FixedReconnectionStrategy

connectionLost(MqttClient, Throwable) - Method in class net.sf.xenqtt.client.NullReconnectStrategy

connectionLost(MqttClient, Throwable) - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

connectionLost(MqttClient, Throwable) - Method in interface net.sf.xenqtt.client.ReconnectionStrategy

Called by an MqttClient each time the connection to the broker is lost other than by an intentional disconnect.

connectionOpened(MqttClient, String, String) - Method in interface net.sf.xenqtt.client.MqttClientDebugListener

Called when a connection is established.

ConnectMessage - Class in net.sf.xenqtt.message

The MQTT connect message.

ConnectMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.ConnectMessage

Create a new instance of this class.

ConnectMessage(String, boolean, int) - Constructor for class net.sf.xenqtt.message.ConnectMessage

Create an instance with no credentials and no will message.

ConnectMessage(String, boolean, int, String, String) - Constructor for class net.sf.xenqtt.message.ConnectMessage

Create an instance with credentials and no will message.

ConnectMessage(String, boolean, int, String, String, QoS, boolean) - Constructor for class net.sf.xenqtt.message.ConnectMessage

Create an instance with no credentials and a will message.

ConnectMessage(String, boolean, int, String, String, String, String, QoS, boolean) - Constructor for class net.sf.xenqtt.message.ConnectMessage

Create an instance with credentials and a will message.

ConnectReturnCode - Enum in net.sf.xenqtt.message

The code returned in the ConnAckMessage.

D

debug(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

debug(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

debug(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the DEBUG log level, if possible.

DEBUG_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

debugEnabled - Variable in class net.sf.xenqtt.LoggingLevels

DEFAULT_LOGGING_LEVELS - Static variable in class net.sf.xenqtt.LoggingLevels

deregister() - Method in interface net.sf.xenqtt.message.MqttChannel

Deregisters this channel.

detachChannel(MqttChannelRef) - Method in interface net.sf.xenqtt.message.ChannelManager

Detaches the specified channel from this manager's control.

detachChannel(MqttChannelRef) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

disconnect() - Method in interface net.sf.xenqtt.client.MqttClient

Disconnects this client from the broker.

disconnect(MqttChannel, DisconnectMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a DisconnectMessage is received through the specified channel

disconnect(Client, DisconnectMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

disconnected(MqttClient, Throwable, boolean) - Method in interface net.sf.xenqtt.client.MqttClientListener

Called when the connection to the broker is lost either unintentionally or because the client requested the disconnect.

DisconnectMessage - Class in net.sf.xenqtt.message

The DISCONNECT message is sent from the client to the server to indicate that it is about to close its TCP/IP connection.

DisconnectMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.DisconnectMessage

Used to construct a received message.

DisconnectMessage() - Constructor for class net.sf.xenqtt.message.DisconnectMessage

Used to construct a message for sending

doExecute(long) - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

Extensions implement this method to execute the command.

E

equals(Object) - Method in class net.sf.xenqtt.client.Subscription

equals(Object) - Method in class net.sf.xenqtt.message.MqttMessage

error(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

error(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

error(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the ERROR log level, if possible.

error(Throwable, String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the ERROR log level, if possible.

ERROR_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

errorEnabled - Variable in class net.sf.xenqtt.LoggingLevels

execute(long) - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

execute(long) - Method in interface net.sf.xenqtt.message.BlockingCommand

Executes the command.

F

fatal(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

fatal(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

fatal(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the FATAL log level.

fatal(Throwable, String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the FATAL log level.

FATAL_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

fatalEnabled - Variable in class net.sf.xenqtt.LoggingLevels

finishConnect() - Method in interface net.sf.xenqtt.message.MqttChannel

Finishes a connection.

FixedReconnectionStrategy - Class in net.sf.xenqtt.client

A ReconnectStrategy implementation that attempts to reconnect a fixed intervals up to a maximum number of reconnection attempts.

FixedReconnectionStrategy(long, int) - Constructor for class net.sf.xenqtt.client.FixedReconnectionStrategy

Create a new instance of this class.

flags() - Method in class net.sf.xenqtt.LoggingLevels

format(LogRecord) - Method in class net.sf.xenqtt.XenqttLogFormatter

G

getArgAsBoolean(String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a boolean.

getArgAsBoolean(String, boolean) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a boolean.

getArgAsDouble(String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a double.

getArgAsDouble(String, double) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a double.

getArgAsInt(String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as an int.

getArgAsInt(String, int) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as an int.

getArgAsLong(String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a long.

getArgAsLong(String, long) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a long.

getArgAsString(String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a string.

getArgAsString(String, String) - Method in class net.sf.xenqtt.AppContext

Get an argument value interpreted as a string.

getAverage() - Method in interface net.sf.xenqtt.client.LatencyStat

getAverageAckLatencyMillis() - Method in interface net.sf.xenqtt.client.MessageStats

getBaseReconnectMillis() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

getBlockingTimeoutSeconds() - Method in class net.sf.xenqtt.client.MqttClientConfig

getClient() - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

getClientDebugListener() - Method in class net.sf.xenqtt.client.MqttClientConfig

getClientId() - Method in class net.sf.xenqtt.message.ConnectMessage

The Client Identifier (Client ID) is between 1 and 23 characters long, and uniquely identifies the client to the server.

getClientId() - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

getClientId() - Method in class net.sf.xenqtt.mockbroker.Client

getConnectTimeoutMillis() - Method in class net.sf.xenqtt.client.MqttClientConfig

getConnectTimeoutSeconds() - Method in class net.sf.xenqtt.client.MqttClientConfig

getCount() - Method in interface net.sf.xenqtt.client.LatencyStat

getCurrentRetry() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

getDirectoryHostingRunningXenqttJar() - Static method in class net.sf.xenqtt.XenqttUtil

getDuplicateMessagesReceived() - Method in interface net.sf.xenqtt.client.MessageStats

getEvents() - Method in class net.sf.xenqtt.mockbroker.MockBroker

getEvents(String) - Method in class net.sf.xenqtt.mockbroker.MockBroker

getEventType() - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

getGrantedQoses() - Method in class net.sf.xenqtt.message.SubAckMessage

Granted QoS levels.

getGrantedSubscriptions() - Method in exception net.sf.xenqtt.MqttQosNotGrantedException

getKeepAliveSeconds() - Method in class net.sf.xenqtt.client.MqttClientConfig

getKeepAliveSeconds() - Method in class net.sf.xenqtt.message.ConnectMessage

The Keep Alive timer, measured in seconds, defines the maximum time interval between messages received from a client.

getLocalAddress() - Method in interface net.sf.xenqtt.message.MqttChannel

getMax() - Method in interface net.sf.xenqtt.client.LatencyStat

getMaxAckLatencyMillis() - Method in interface net.sf.xenqtt.client.MessageStats

getMaxNumberOfReconnects() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

getMaxReconnectMillis() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

getMessage() - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

getMessageId() - Method in class net.sf.xenqtt.message.IdentifiableMqttMessage

The message identifier is present in the variable header of the following MQTT messages: PUBLISH, PUBACK, PUBREC, PUBREL, PUBCOMP, SUBSCRIBE, SUBACK, UNSUBSCRIBE, UNSUBACK.

getMessageId() - Method in class net.sf.xenqtt.message.PubMessage

getMessageId() - Method in class net.sf.xenqtt.message.SubAckMessage

The Message Identifier (Message ID) for the SUBSCRIBE message that is being acknowledged.

getMessageId() - Method in class net.sf.xenqtt.message.SubscribeMessage

getMessageId() - Method in class net.sf.xenqtt.message.UnsubscribeMessage

getMessageResendIntervalSeconds() - Method in class net.sf.xenqtt.client.MqttClientConfig

getMessagesInFlight() - Method in interface net.sf.xenqtt.client.MessageStats

getMessagesQueuedToSend() - Method in interface net.sf.xenqtt.client.MessageStats

getMessagesReceived() - Method in interface net.sf.xenqtt.client.MessageStats

getMessagesResent() - Method in interface net.sf.xenqtt.client.MessageStats

getMessagesSent() - Method in interface net.sf.xenqtt.client.MessageStats

getMessageType() - Method in class net.sf.xenqtt.message.MqttMessage

The type of message

getMin() - Method in interface net.sf.xenqtt.client.LatencyStat

getMinAckLatencyMillis() - Method in interface net.sf.xenqtt.client.MessageStats

getPassword() - Method in class net.sf.xenqtt.message.ConnectMessage

If the Password flag is set, this is the next UTF-encoded string.

getPayload() - Method in class net.sf.xenqtt.client.PublishMessage

getPayload() - Method in class net.sf.xenqtt.message.PubMessage

Contains the data for publishing.

getPayloadString() - Method in class net.sf.xenqtt.client.PublishMessage

getPort() - Method in class net.sf.xenqtt.SimpleBroker

getProgressiveFactor() - Method in class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

getProtocolName() - Method in class net.sf.xenqtt.message.ConnectMessage

String that represents the protocol name MQIsdp, capitalized as shown.

getProtocolVersion() - Method in class net.sf.xenqtt.message.ConnectMessage

The revision level of the protocol used by the client.

getProxyURI() - Method in class net.sf.xenqtt.proxy.ProxyApplication

getQoS() - Method in class net.sf.xenqtt.client.PublishMessage

getQos() - Method in class net.sf.xenqtt.client.Subscription

getQoS() - Method in class net.sf.xenqtt.message.MqttMessage

The level of assurance for delivery of an IdentifiableMqttMessage.

getQoSLevel() - Method in class net.sf.xenqtt.message.MqttMessage

The raw integer value for the level of assurance for delivery of a PUBLISH message.

getReceivedTimestamp() - Method in class net.sf.xenqtt.client.PublishMessage

getReceivedTimestamp() - Method in class net.sf.xenqtt.message.MqttMessage

getReconnectionStrategy() - Method in class net.sf.xenqtt.client.MqttClientConfig

getRemainingLength() - Method in class net.sf.xenqtt.message.MqttMessage

Represents the number of bytes remaining within the current message, including data in the variable header and the payload.

getRemoteAddress() - Method in interface net.sf.xenqtt.message.MqttChannel

getRequestedQoSes() - Method in class net.sf.xenqtt.message.SubscribeMessage

The requested QoS's for the topics subscribed to.

getReturnCode() - Method in class net.sf.xenqtt.message.ConnAckMessage

getRootCause() - Method in error net.sf.xenqtt.MqttInvocationError

getRootCause() - Method in exception net.sf.xenqtt.MqttInvocationException

getStats(boolean) - Method in interface net.sf.xenqtt.client.ClientFactory

getStats(boolean) - Method in interface net.sf.xenqtt.client.MqttClient

getStats(boolean) - Method in class net.sf.xenqtt.client.MqttClientFactory

getStats(boolean) - Method in interface net.sf.xenqtt.message.ChannelManager

Request the current snapshot of statistics that are available from this channel manager.

getStats(boolean) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

getTopic() - Method in class net.sf.xenqtt.client.PublishMessage

getTopic() - Method in class net.sf.xenqtt.client.Subscription

getTopicName() - Method in class net.sf.xenqtt.message.PubMessage

This must not contain Topic wildcard characters.

getTopics() - Method in class net.sf.xenqtt.message.SubscribeMessage

The topics to subscribe to.

getTopics() - Method in class net.sf.xenqtt.message.UnsubscribeMessage

The topics to unsubscribe from.

getUnsentMessages(MqttChannelRef) - Method in interface net.sf.xenqtt.message.ChannelManager

getUnsentMessages(MqttChannelRef) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

getUnsentMessages() - Method in interface net.sf.xenqtt.message.MqttChannel

getURI() - Method in class net.sf.xenqtt.SimpleBroker

getUsageText() - Method in class net.sf.xenqtt.mockbroker.MockBrokerApplication

getUsageText() - Method in class net.sf.xenqtt.proxy.ProxyApplication

getUsageText() - Method in interface net.sf.xenqtt.XenqttApplication

Get usage text to display to the user.

getUserName() - Method in class net.sf.xenqtt.message.ConnectMessage

The user name identifies the name of the user who is connecting, which can be used for authentication.

getWillMessage() - Method in class net.sf.xenqtt.message.ConnectMessage

The Will Message defines the content of the message that is published to the Will Topic if the client is unexpectedly disconnected.

getWillQoS() - Method in class net.sf.xenqtt.message.ConnectMessage

getWillQoSLevel() - Method in class net.sf.xenqtt.message.ConnectMessage

getWillTopic() - Method in class net.sf.xenqtt.message.ConnectMessage

The Will Message is published to the Will Topic.

GlamBroker - Class in net.sf.xenqtt.examples

Fires up a mock broker that specializes in routing data of the 'Glam' variety.

GlamBroker() - Constructor for class net.sf.xenqtt.examples.GlamBroker

GlamEventReportingBroker - Class in net.sf.xenqtt.examples

Fires up a mock broker that specializes in routing data of the 'Glam' variety.

GlamEventReportingBroker() - Constructor for class net.sf.xenqtt.examples.GlamEventReportingBroker

GlamNoCountryBroker - Class in net.sf.xenqtt.examples

Fires up a mock broker that specializes in routing data of the 'Glam' variety.

GlamNoCountryBroker() - Constructor for class net.sf.xenqtt.examples.GlamNoCountryBroker

H

hashCode() - Method in class net.sf.xenqtt.client.Subscription

houseKeeping(long) - Method in interface net.sf.xenqtt.message.MqttChannel

Performs housekeeping: message resends, ping requests, etc

I

IdentifiableMqttMessage - Class in net.sf.xenqtt.message

Adds the message ID property to MqttMessage.

IdentifiableMqttMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.IdentifiableMqttMessage

IdentifiableMqttMessage(MessageType, int) - Constructor for class net.sf.xenqtt.message.IdentifiableMqttMessage

IdentifiableMqttMessage(MessageType, boolean, QoS, boolean, int) - Constructor for class net.sf.xenqtt.message.IdentifiableMqttMessage

inFlightMessageCount() - Method in interface net.sf.xenqtt.message.MqttChannel

info(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

info(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

info(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the INFO log level, if possible.

INFO_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

infoEnabled - Variable in class net.sf.xenqtt.LoggingLevels

init() - Method in interface net.sf.xenqtt.message.ChannelManager

Starts this channel manager.

init() - Method in class net.sf.xenqtt.message.ChannelManagerImpl

init() - Method in class net.sf.xenqtt.mockbroker.MockBroker

Starts the mock broker

init(MessageHandler, String) - Method in class net.sf.xenqtt.SimpleBroker

Starts the broker.

isAck() - Method in class net.sf.xenqtt.message.MqttMessage

isAckable() - Method in class net.sf.xenqtt.message.MqttMessage

isBlank(String) - Static method in class net.sf.xenqtt.XenqttUtil

Determine if a particular string is blank.

isCleanSession() - Method in class net.sf.xenqtt.message.ConnectMessage

If not set, then the server must store the subscriptions of the client after it disconnects.

isClosed() - Method in interface net.sf.xenqtt.client.MqttClient

isConnected() - Method in interface net.sf.xenqtt.message.MqttChannel

Tells whether or not this channel is connected.

isConnectionPending() - Method in interface net.sf.xenqtt.message.MqttChannel

Tells whether or not a connection operation is in progress on this channel.

isDuplicate() - Method in class net.sf.xenqtt.client.PublishMessage

isDuplicate() - Method in class net.sf.xenqtt.message.MqttMessage

This flag is set when the client or server attempts to re-deliver a PUBLISH, PUBREL, SUBSCRIBE or UNSUBSCRIBE message.

isEmpty() - Method in class net.sf.xenqtt.AppContext

isFlagSpecified(String) - Method in class net.sf.xenqtt.AppContext

Determine if a particular flag was specified.

isLoggable(int) - Method in class net.sf.xenqtt.LoggingLevels

Determine if an event is loggable.

isNull(String) - Static method in class net.sf.xenqtt.XenqttUtil

Determine if a particular string is null.

isOpen() - Method in interface net.sf.xenqtt.message.MqttChannel

Tells whether or not this channel is open.

isPasswordFlag() - Method in class net.sf.xenqtt.message.ConnectMessage

isRetain() - Method in class net.sf.xenqtt.client.PublishMessage

If the Retain flag is set (1), the server should hold on to the message after it has been delivered to the current subscribers.

isRetain() - Method in class net.sf.xenqtt.message.MqttMessage

This flag is only used on PUBLISH messages.

isRunning() - Method in interface net.sf.xenqtt.message.ChannelManager

isRunning() - Method in class net.sf.xenqtt.message.ChannelManagerImpl

isUserNameFlag() - Method in class net.sf.xenqtt.message.ConnectMessage

isWillMessageFlag() - Method in class net.sf.xenqtt.message.ConnectMessage

isWillRetain() - Method in class net.sf.xenqtt.message.ConnectMessage

The retain value of the Will message.

J

JavaLoggingDelegate - Class in net.sf.xenqtt

A LoggingDelegate that logs messages and related data to a log file called xenqtt.log that is created and rolled in the directory where the xenqtt.jar file is being executed.

JavaLoggingDelegate() - Constructor for class net.sf.xenqtt.JavaLoggingDelegate

L

LatencyStat - Interface in net.sf.xenqtt.client

Specifies a type that provides latency-based statistics for disparate Xenqtt operations.

Log - Class in net.sf.xenqtt

Provides disparate logging methods for use within xenqtt.

LoggingLevels - Class in net.sf.xenqtt

Exposes the disparate log levels that are currently enabled for Xenqtt.

LoggingLevels(boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for class net.sf.xenqtt.LoggingLevels

Create a new instance of this class.

LoggingLevels(int) - Constructor for class net.sf.xenqtt.LoggingLevels

Create a new instance of this class.

lookup(int) - Static method in enum net.sf.xenqtt.message.ConnectReturnCode

lookup(int) - Static method in enum net.sf.xenqtt.message.MessageType

lookup(int) - Static method in enum net.sf.xenqtt.message.QoS

M

main(String...) - Static method in class net.sf.xenqtt.examples.GlamBroker

main(String...) - Static method in class net.sf.xenqtt.examples.GlamEventReportingBroker

main(String...) - Static method in class net.sf.xenqtt.examples.GlamNoCountryBroker

main(String...) - Static method in class net.sf.xenqtt.examples.MusicProducer

main(String...) - Static method in class net.sf.xenqtt.examples.MusicProducerAsync

main(String...) - Static method in class net.sf.xenqtt.examples.MusicSubscriber

main(String...) - Static method in class net.sf.xenqtt.examples.MusicSubscriberAsync

main(String[]) - Static method in class net.sf.xenqtt.test.BlockingTcpEchoClient

main(String[]) - Static method in class net.sf.xenqtt.test.BlockingTcpEchoServer

main(String[]) - Static method in class net.sf.xenqtt.test.NonBlockingTcpEchoClient

main(String[]) - Static method in class net.sf.xenqtt.test.NonBlockingTcpEchoServer

main(String...) - Static method in class net.sf.xenqtt.Xenqtt

The entry point into Xenqtt.

manager - Variable in class net.sf.xenqtt.SimpleBroker

ChannelManager all new broker channels are added to.

MessageHandler - Interface in net.sf.xenqtt.message

Handles received MqttMessages.

messageReceived(MqttClient, String, String, MqttMessage) - Method in interface net.sf.xenqtt.client.MqttClientDebugListener

Called when a message is received

messageSent(MqttClient, String, String, MqttMessage) - Method in interface net.sf.xenqtt.client.MqttClientDebugListener

Called when a message is sent

messageSent(MqttChannel, MqttMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a message is sent from the client

MessageStats - Interface in net.sf.xenqtt.client

Statistics for the MQTT client

MessageType - Enum in net.sf.xenqtt.message

MQTT Message types.

MockBroker - Class in net.sf.xenqtt.mockbroker

Mock MQTT broker used to test MQTT clients and applications.

MockBroker() - Constructor for class net.sf.xenqtt.mockbroker.MockBroker

Creates a broker with the following config: no MockBrokerHandler 15 second message resend interval Any available port.

MockBroker(MockBrokerHandler) - Constructor for class net.sf.xenqtt.mockbroker.MockBroker

Creates a broker with the specified handler and the following config: 15 second message resend interval Any available port.

MockBroker(MockBrokerHandler, long, int, boolean, boolean, int) - Constructor for class net.sf.xenqtt.mockbroker.MockBroker

Create a new instance of this class.

MockBrokerApplication - Class in net.sf.xenqtt.mockbroker

Runs the MockBroker as a xenqtt command line application

MockBrokerApplication() - Constructor for class net.sf.xenqtt.mockbroker.MockBrokerApplication

MockBrokerHandler - Class in net.sf.xenqtt.mockbroker

This class does nothing by default.

MockBrokerHandler() - Constructor for class net.sf.xenqtt.mockbroker.MockBrokerHandler

MqttBrokerChannel - Class in net.sf.xenqtt.message

An MqttChannel to use for the client side of the connection.

MqttBrokerChannel(SocketChannel, MessageHandler, Selector, long, MutableMessageStats) - Constructor for class net.sf.xenqtt.message.MqttBrokerChannel

MqttChannel - Interface in net.sf.xenqtt.message

Sends and receives MqttMessages over a channel.

MqttChannelRef - Interface in net.sf.xenqtt.message

Each object of this type references exactly one MQTT channel.

MqttClient - Interface in net.sf.xenqtt.client

A client to an MQTT broker.

MqttClientChannel - Class in net.sf.xenqtt.message

An MqttChannel to use for the client side of the connection.

MqttClientChannel(String, int, MessageHandler, Selector, long, BlockingCommand<?>, MutableMessageStats) - Constructor for class net.sf.xenqtt.message.MqttClientChannel

Starts an asynchronous connection to the specified host and port.

MqttClientConfig - Class in net.sf.xenqtt.client

Use this class to configure the MqttClient implementations and the MqttClientFactory.

MqttClientConfig() - Constructor for class net.sf.xenqtt.client.MqttClientConfig

MqttClientDebugListener - Interface in net.sf.xenqtt.client

Allows you to see low level events from within an MqttClient.

MqttClientFactory - Class in net.sf.xenqtt.client

Used to create multiple "sibling" clients that share an Executor, broker URI, etc.

MqttClientFactory(String, int, boolean) - Constructor for class net.sf.xenqtt.client.MqttClientFactory

Constructs an object to create synchronous or asynchronous clients using an Executor owned by this class with the default config.

MqttClientFactory(String, Executor, boolean) - Constructor for class net.sf.xenqtt.client.MqttClientFactory

Constructs an object to create synchronous or asynchronous clients using a user provided Executor with the default config.

MqttClientFactory(String, int, boolean, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.MqttClientFactory

Constructs an object to create synchronous or asynchronous clients using an Executor owned by this class with a custom config.

MqttClientFactory(String, Executor, boolean, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.MqttClientFactory

Constructs an object to create synchronous or asynchronous clients using a user provided Executor with a custom config.

MqttClientListener - Interface in net.sf.xenqtt.client

Implement this interface to use SyncMqttClient.

MqttCommandCancelledException - Exception in net.sf.xenqtt

Thrown when a BlockingCommand is cancelled.

MqttCommandCancelledException() - Constructor for exception net.sf.xenqtt.MqttCommandCancelledException

Constructs a new instance with null as its detail message.

MqttCommandCancelledException(String) - Constructor for exception net.sf.xenqtt.MqttCommandCancelledException

Constructs a new instance with the specified detail message.

MqttCommandCancelledException(String, Throwable) - Constructor for exception net.sf.xenqtt.MqttCommandCancelledException

Constructs a new instance with the specified detail message and cause.

MqttException - Exception in net.sf.xenqtt

General mqtt exception used by this library.

MqttException() - Constructor for exception net.sf.xenqtt.MqttException

Constructs a new mqtt exception with null as its detail message.

MqttException(String, Throwable) - Constructor for exception net.sf.xenqtt.MqttException

Constructs a new mqtt exception with the specified detail message and cause.

MqttException(String) - Constructor for exception net.sf.xenqtt.MqttException

Constructs a new mqtt exception with the specified detail message.

MqttException(Throwable) - Constructor for exception net.sf.xenqtt.MqttException

Constructs a new mqtt exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

MqttInterruptedException - Exception in net.sf.xenqtt

This is a wrapper for InterruptedException.

MqttInterruptedException(InterruptedException) - Constructor for exception net.sf.xenqtt.MqttInterruptedException

Create a new instance of this class.

MqttInvalidTopicNameException - Exception in net.sf.xenqtt

Thrown when an invalid topic name is used

MqttInvalidTopicNameException(String) - Constructor for exception net.sf.xenqtt.MqttInvalidTopicNameException

Create a new instance of this class.

MqttInvocationError - Error in net.sf.xenqtt

Thrown when an Error occurs during the processing of a command.

MqttInvocationError(String, Error) - Constructor for error net.sf.xenqtt.MqttInvocationError

Create a new instance of this class.

MqttInvocationException - Exception in net.sf.xenqtt

Thrown when an Exception occurs during the processing of a command.

MqttInvocationException(String, Exception) - Constructor for exception net.sf.xenqtt.MqttInvocationException

Create a new instance of this class.

MqttMessage - Class in net.sf.xenqtt.message

This is a generic MQTT message.

MqttMessage(MqttMessage) - Constructor for class net.sf.xenqtt.message.MqttMessage

Creates a copy of the copyFrom message.

MqttQosNotGrantedException - Exception in net.sf.xenqtt

Thrown by synchronous MqttClient.subscribe(java.util.List) and MqttClient.subscribe(Subscription[]) methods when the QoS granted for a subscription request does not match the QoS requested.

MqttQosNotGrantedException(Subscription[]) - Constructor for exception net.sf.xenqtt.MqttQosNotGrantedException

Create a new instance of this class.

MqttTimeoutException - Exception in net.sf.xenqtt

Thrown when a timeout occurs in xenqtt.

MqttTimeoutException() - Constructor for exception net.sf.xenqtt.MqttTimeoutException

Constructs a new mqtt exception with null as its detail message.

MqttTimeoutException(String) - Constructor for exception net.sf.xenqtt.MqttTimeoutException

Constructs a new mqtt exception with the specified detail message.

MusicProducer - Class in net.sf.xenqtt.examples

Produces hit music from days gone by.

MusicProducer() - Constructor for class net.sf.xenqtt.examples.MusicProducer

MusicProducerAsync - Class in net.sf.xenqtt.examples

Produces hit music from days gone by.

MusicProducerAsync() - Constructor for class net.sf.xenqtt.examples.MusicProducerAsync

MusicSubscriber - Class in net.sf.xenqtt.examples

Builds music catalogs from years gone by.

MusicSubscriber() - Constructor for class net.sf.xenqtt.examples.MusicSubscriber

MusicSubscriberAsync - Class in net.sf.xenqtt.examples

Builds music catalogs from years gone by.

MusicSubscriberAsync() - Constructor for class net.sf.xenqtt.examples.MusicSubscriberAsync

N

net.sf.xenqtt - package net.sf.xenqtt

net.sf.xenqtt.client - package net.sf.xenqtt.client

net.sf.xenqtt.examples - package net.sf.xenqtt.examples

net.sf.xenqtt.message - package net.sf.xenqtt.message

net.sf.xenqtt.mockbroker - package net.sf.xenqtt.mockbroker

net.sf.xenqtt.proxy - package net.sf.xenqtt.proxy

net.sf.xenqtt.test - package net.sf.xenqtt.test

newAsyncClient(AsyncClientListener) - Method in interface net.sf.xenqtt.client.AsyncClientFactory

Creates an asynchronous client.

newAsyncClient(AsyncClientListener) - Method in class net.sf.xenqtt.client.MqttClientFactory

newBrokerChannel(SocketChannel, MessageHandler) - Method in interface net.sf.xenqtt.message.ChannelManager

Create a new broker side MqttChannelRef for use in exchanging data using the MQTT protocol.

newBrokerChannel(SocketChannel, MessageHandler) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

newClientChannel(String, MessageHandler) - Method in interface net.sf.xenqtt.message.ChannelManager

Create a new client side MqttChannelRef for use in exchanging data using the MQTT protocol.

newClientChannel(URI, MessageHandler) - Method in interface net.sf.xenqtt.message.ChannelManager

Create a new client side MqttChannelRef for use in exchanging data using the MQTT protocol.

newClientChannel(String, int, MessageHandler) - Method in interface net.sf.xenqtt.message.ChannelManager

Create a new client side MqttChannelRef for use in exchanging data using the MQTT protocol.

newClientChannel(String, MessageHandler) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

newClientChannel(URI, MessageHandler) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

newClientChannel(String, int, MessageHandler) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

newSynchronousClient(MqttClientListener) - Method in class net.sf.xenqtt.client.MqttClientFactory

newSynchronousClient(MqttClientListener) - Method in interface net.sf.xenqtt.client.SyncClientFactory

Creates a synchronous client.

newThread(Runnable) - Method in class net.sf.xenqtt.ConfigurableThreadFactory

NonBlockingTcpEchoClient - Class in net.sf.xenqtt.test

This client sends data to a TCP echo server using blocking IO.

NonBlockingTcpEchoServer - Class in net.sf.xenqtt.test

Server that uses non-blocking IO to accept new connections and echo any data received back to the sender.

NULL_LISTENER - Static variable in interface net.sf.xenqtt.client.AsyncClientListener

Use this listener when you want to ignore all client events including received messages.

NULL_LISTENER - Static variable in interface net.sf.xenqtt.client.MqttClientListener

Use this listener when you want to ignore all client events including received messages.

NullReconnectStrategy - Class in net.sf.xenqtt.client

Reconnect strategy that does 0 reconnect attempts.

NullReconnectStrategy() - Constructor for class net.sf.xenqtt.client.NullReconnectStrategy

P

PingReqMessage - Class in net.sf.xenqtt.message

The PINGREQ message is an "are you alive?" message that is sent from a connected client to the server.

PingReqMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PingReqMessage

Used to construct a received message.

PingReqMessage() - Constructor for class net.sf.xenqtt.message.PingReqMessage

Used to construct a message for sending

PingRespMessage - Class in net.sf.xenqtt.message

A PINGRESP message is the response sent by a server to a PINGREQ message and means "yes I am alive".

PingRespMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PingRespMessage

Used to construct a received message.

PingRespMessage() - Constructor for class net.sf.xenqtt.message.PingRespMessage

Used to construct a message for sending

printStackTrace(PrintStream) - Method in error net.sf.xenqtt.MqttInvocationError

printStackTrace(PrintStream) - Method in exception net.sf.xenqtt.MqttInvocationException

ProgressiveReconnectionStrategy - Class in net.sf.xenqtt.client

A ReconnectionStrategy implementation that allows for progressive reconnection attempts to the broker.

ProgressiveReconnectionStrategy(long, int, int, long) - Constructor for class net.sf.xenqtt.client.ProgressiveReconnectionStrategy

Create a new instance of this class.

ProxyApplication - Class in net.sf.xenqtt.proxy

A XenqttApplication is that acts as an MQTT proxy to allow a cluster of servers to act as a single MQTT proxy.

ProxyApplication() - Constructor for class net.sf.xenqtt.proxy.ProxyApplication

pubAck(MqttChannel, PubAckMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a PubAckMessage is received through the specified channel

pubAck(Client, PubAckMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

PubAckMessage - Class in net.sf.xenqtt.message

A PUBACK message is the response to a PUBLISH message with QoS level 1.

PubAckMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PubAckMessage

Used to construct a received message.

PubAckMessage(int) - Constructor for class net.sf.xenqtt.message.PubAckMessage

Used to construct a message for sending

pubComp(MqttChannel, PubCompMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a PubCompMessage is received through the specified channel

pubComp(Client, PubCompMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

PubCompMessage - Class in net.sf.xenqtt.message

This message is either the response from the server to a PUBREL message from a publisher, or the response from a subscriber to a PUBREL message from the server.

PubCompMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PubCompMessage

Used to construct a received message.

PubCompMessage(int) - Constructor for class net.sf.xenqtt.message.PubCompMessage

Used to construct a message for sending

publish(PublishMessage) - Method in interface net.sf.xenqtt.client.MqttClient

Publishes a message.

publish(MqttChannel, PubMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a PubMessage is received through the specified channel

publish(Client, PubMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

published(MqttClient, PublishMessage) - Method in interface net.sf.xenqtt.client.AsyncClientListener

Called when the protocol to send a client publish message to the broker is complete.

PublishMessage - Class in net.sf.xenqtt.client

Message published either by the client to a topic or published to the client from subscribed topic.

PublishMessage(String, QoS, byte[], boolean) - Constructor for class net.sf.xenqtt.client.PublishMessage

Creates a binary message.

PublishMessage(String, QoS, byte[]) - Constructor for class net.sf.xenqtt.client.PublishMessage

Creates a binary message with retain set to false.

PublishMessage(String, QoS, String) - Constructor for class net.sf.xenqtt.client.PublishMessage

Creates a message with a string as the payload with retain set to false.

PublishMessage(String, QoS, String, boolean) - Constructor for class net.sf.xenqtt.client.PublishMessage

Creates a message with a string as the payload.

publishReceived(MqttClient, PublishMessage) - Method in interface net.sf.xenqtt.client.MqttClientListener

Called when a published message is received from the broker.

PubMessage - Class in net.sf.xenqtt.message

A PUBLISH message is sent by a client to a server for distribution to interested subscribers.

PubMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.PubMessage

Used to construct a received message.

PubMessage(QoS, boolean, String, int, byte[]) - Constructor for class net.sf.xenqtt.message.PubMessage

Used to construct a message for sending

pubRec(MqttChannel, PubRecMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a PubRecMessage is received through the specified channel

pubRec(Client, PubRecMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

PubRecMessage - Class in net.sf.xenqtt.message

A PUBREC message is the response to a PUBLISH message with QoS level 2.

PubRecMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PubRecMessage

Used to construct a received message.

PubRecMessage(int) - Constructor for class net.sf.xenqtt.message.PubRecMessage

Used to construct a message for sending

pubRel(MqttChannel, PubRelMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a PubRelMessage is received through the specified channel

pubRel(Client, PubRelMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

PubRelMessage - Class in net.sf.xenqtt.message

A PUBREL message is the response either from a publisher to a PUBREC message from the server, or from the server to a PUBREC message from a subscriber.

PubRelMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.PubRelMessage

Used to construct a received message.

PubRelMessage(int) - Constructor for class net.sf.xenqtt.message.PubRelMessage

Used to construct a message for sending

Q

QoS - Enum in net.sf.xenqtt.message

QoS is the quality of service which determines the assurance of message delivery.

quickSplit(String, char) - Static method in class net.sf.xenqtt.XenqttUtil

Split a string using a single delimiter.

R

read(long) - Method in interface net.sf.xenqtt.message.MqttChannel

Reads data.

ReconnectionStrategy - Interface in net.sf.xenqtt.client

Implementations are strategies used by MqttClient implementation to reconnect to the broker if the connection is lost.

register(Selector, MessageHandler) - Method in interface net.sf.xenqtt.message.MqttChannel

Registers this channel with the specified selector.

removeEvents(Collection<BrokerEvent>) - Method in class net.sf.xenqtt.mockbroker.MockBroker

Removes the specified broker events.

S

send(MqttChannelRef, MqttMessage) - Method in interface net.sf.xenqtt.message.ChannelManager

Send a message over a specified channel.

send(MqttChannelRef, MqttMessage) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

send(MqttMessage) - Method in interface net.sf.xenqtt.message.MqttChannel

Sends the specified message asynchronously.

send(MqttMessage, BlockingCommand<MqttMessage>) - Method in interface net.sf.xenqtt.message.MqttChannel

Sends the specified message asynchronously.

send(MqttMessage) - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

Sends the message to the client associated with this event

send(MqttMessage) - Method in class net.sf.xenqtt.mockbroker.Client

Sends the message to this client

sendQueueDepth() - Method in interface net.sf.xenqtt.message.MqttChannel

setBlockingTimeoutSeconds(int) - Method in class net.sf.xenqtt.client.MqttClientConfig

setClientDebugListener(MqttClientDebugListener) - Method in class net.sf.xenqtt.client.MqttClientConfig

setConnectTimeoutSeconds(int) - Method in class net.sf.xenqtt.client.MqttClientConfig

setDuplicateFlag() - Method in class net.sf.xenqtt.message.MqttMessage

Sets the duplicate flag on this message.

setFailureCause(Throwable) - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

setFailureCause(Throwable) - Method in interface net.sf.xenqtt.message.BlockingCommand

Sets the cause if the command fails.

setKeepAliveSeconds(int) - Method in class net.sf.xenqtt.client.MqttClientConfig

setMessageId(int) - Method in class net.sf.xenqtt.message.IdentifiableMqttMessage

Sets the message ID

setMessageId(int) - Method in class net.sf.xenqtt.message.PubMessage

setMessageId(int) - Method in class net.sf.xenqtt.message.SubAckMessage

setMessageId(int) - Method in class net.sf.xenqtt.message.SubscribeMessage

setMessageId(int) - Method in class net.sf.xenqtt.message.UnsubscribeMessage

setMessageResendIntervalSeconds(int) - Method in class net.sf.xenqtt.client.MqttClientConfig

setReconnectionStrategy(ReconnectionStrategy) - Method in class net.sf.xenqtt.client.MqttClientConfig

setResult(T) - Method in class net.sf.xenqtt.message.AbstractBlockingCommand

setResult(T) - Method in interface net.sf.xenqtt.message.BlockingCommand

Sets the result of this command.

setReturnCode(ConnectReturnCode) - Method in class net.sf.xenqtt.message.ConnAckMessage

Sets the return code

shutdown() - Method in interface net.sf.xenqtt.client.ClientFactory

Stops this factory.

shutdown() - Method in class net.sf.xenqtt.client.MqttClientFactory

shutdown() - Method in interface net.sf.xenqtt.message.ChannelManager

Stops this channel manager.

shutdown() - Method in class net.sf.xenqtt.message.ChannelManagerImpl

shutdown(long) - Method in class net.sf.xenqtt.SimpleBroker

Shuts down the broker.

SimpleBroker - Class in net.sf.xenqtt

Simple broker implementation.

SimpleBroker(long, int) - Constructor for class net.sf.xenqtt.SimpleBroker

start(AppContext) - Method in class net.sf.xenqtt.mockbroker.MockBrokerApplication

start(AppContext) - Method in class net.sf.xenqtt.proxy.ProxyApplication

start() - Method in class net.sf.xenqtt.test.XenqttTestClient

Start the test client.

start(AppContext) - Method in interface net.sf.xenqtt.XenqttApplication

Start the application.

stop() - Method in class net.sf.xenqtt.mockbroker.MockBrokerApplication

stop() - Method in class net.sf.xenqtt.proxy.ProxyApplication

stop() - Method in class net.sf.xenqtt.test.XenqttTestClient

Stop the test client.

stop() - Method in interface net.sf.xenqtt.XenqttApplication

Stop the application.

subAck(MqttChannel, SubAckMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a SubAckMessage is received through the specified channel

SubAckMessage - Class in net.sf.xenqtt.message

A SUBACK message is sent by the server to the client to confirm receipt of a SUBSCRIBE message.

SubAckMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.SubAckMessage

Used to construct a received message.

SubAckMessage(int, QoS[]) - Constructor for class net.sf.xenqtt.message.SubAckMessage

Used to construct a message for sending

subscribe(Subscription[]) - Method in interface net.sf.xenqtt.client.MqttClient

Subscribes to topics.

subscribe(List<Subscription>) - Method in interface net.sf.xenqtt.client.MqttClient

Subscribes to topics.

subscribe(MqttChannel, SubscribeMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a SubscribeMessage is received through the specified channel

subscribe(Client, SubscribeMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

subscribed(MqttClient, Subscription[], Subscription[], boolean) - Method in interface net.sf.xenqtt.client.AsyncClientListener

Called when the client receives a subscribe acknowledgment from the broker.

SubscribeMessage - Class in net.sf.xenqtt.message

The SUBSCRIBE message allows a client to register an interest in one or more topic names with the server.

SubscribeMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.SubscribeMessage

Used to construct a received message.

SubscribeMessage(int, String[], QoS[]) - Constructor for class net.sf.xenqtt.message.SubscribeMessage

Used to construct a message for sending

Subscription - Class in net.sf.xenqtt.client

An MQTT topic subscription

Subscription(String, QoS) - Constructor for class net.sf.xenqtt.client.Subscription

SyncClientFactory - Interface in net.sf.xenqtt.client

Used to create multiple "sibling" synchronous clients that share an Executor, broker URI, etc.

SyncMqttClient - Class in net.sf.xenqtt.client

An MqttClient that interacts with an MQTT broker in a synchronous fashion.

SyncMqttClient(String, MqttClientListener, int) - Constructor for class net.sf.xenqtt.client.SyncMqttClient

Constructs an instance of this class using an Executor owned by this class with the default config.

SyncMqttClient(String, MqttClientListener, int, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.SyncMqttClient

Constructs an instance of this class using an Executor owned by this class with a custom config.

SyncMqttClient(String, MqttClientListener, Executor) - Constructor for class net.sf.xenqtt.client.SyncMqttClient

Constructs an instance of this class using a user provided Executor with the default config.

SyncMqttClient(String, MqttClientListener, Executor, MqttClientConfig) - Constructor for class net.sf.xenqtt.client.SyncMqttClient

Constructs an instance of this class using a user provided Executor with a custom config.

T

TestClientConfiguration - Class in net.sf.xenqtt.test

Stores the configuration for the Xenqtt test client.

TestClientConfiguration(AppContext) - Constructor for class net.sf.xenqtt.test.TestClientConfiguration

toString() - Method in class net.sf.xenqtt.client.PublishMessage

toString() - Method in class net.sf.xenqtt.client.Subscription

toString() - Method in class net.sf.xenqtt.message.MqttMessage

toString() - Method in class net.sf.xenqtt.mockbroker.BrokerEvent

trace(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

trace(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

trace(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the TRACE log level, if possible.

TRACE_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

traceEnabled - Variable in class net.sf.xenqtt.LoggingLevels

transfer(MqttChannelRef, MqttChannelRef) - Method in interface net.sf.xenqtt.message.ChannelManager

Transfers unsent messages from oldChannel to newChannel and changes oldChannel such that any messages sent to it will actually go to newChannel.

transfer(MqttChannelRef, MqttChannelRef) - Method in class net.sf.xenqtt.message.ChannelManagerImpl

U

unexpectedMessage(Client, MqttMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

Called when an unexpected message is received.

unsubAck(MqttChannel, UnsubAckMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a UnsubAckMessage is received through the specified channel

UnsubAckMessage - Class in net.sf.xenqtt.message

The UNSUBACK message is sent by the server to the client to confirm receipt of an UNSUBSCRIBE message.

UnsubAckMessage(ByteBuffer, long) - Constructor for class net.sf.xenqtt.message.UnsubAckMessage

Used to construct a received message.

UnsubAckMessage(int) - Constructor for class net.sf.xenqtt.message.UnsubAckMessage

Used to construct a message for sending

unsubscribe(String[]) - Method in interface net.sf.xenqtt.client.MqttClient

Unsubscribes from topics.

unsubscribe(List<String>) - Method in interface net.sf.xenqtt.client.MqttClient

Unsubscribes from topics.

unsubscribe(MqttChannel, UnsubscribeMessage) - Method in interface net.sf.xenqtt.message.MessageHandler

Called when a UnsubscribeMessage is received through the specified channel

unsubscribe(Client, UnsubscribeMessage) - Method in class net.sf.xenqtt.mockbroker.MockBrokerHandler

unsubscribed(MqttClient, String[]) - Method in interface net.sf.xenqtt.client.AsyncClientListener

Called when an unsubscribe acknowledgment is received from the broker.

UnsubscribeMessage - Class in net.sf.xenqtt.message

An UNSUBSCRIBE message is sent by the client to the server to unsubscribe from named topics.

UnsubscribeMessage(ByteBuffer, int, long) - Constructor for class net.sf.xenqtt.message.UnsubscribeMessage

Used to construct a received message.

UnsubscribeMessage(int, String[]) - Constructor for class net.sf.xenqtt.message.UnsubscribeMessage

Used to construct a message for sending

V

validateGreaterThan(String, T, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a number is greater than a defined maximum.

validateGreaterThanOrEqualTo(String, T, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a number is greater than or equal to a defined maximum.

validateInRange(String, T, T, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a number falls within a specific range.

validateLessThan(String, T, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a number is less than a defined maximum.

validateLessThanOrEqualTo(String, T, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a number is less than or equal to a defined maximum.

validateNotEmpty(String, String) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that a string is not empty.

validateNotEmpty(String, T[]) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that an arbitrary array of objects of type T is not empty.

validateNotEmpty(String, Collection<T>) - Static method in class net.sf.xenqtt.XenqttUtil

Validate that an arbitrary collection of objects of type T is not empty.

validateNotNull(String, T) - Static method in class net.sf.xenqtt.XenqttUtil

Validates that an object is not null.

value() - Method in enum net.sf.xenqtt.message.ConnectReturnCode

value() - Method in enum net.sf.xenqtt.message.MessageType

value() - Method in enum net.sf.xenqtt.message.QoS

valueOf(String) - Static method in enum net.sf.xenqtt.message.ConnectReturnCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sf.xenqtt.message.MessageType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sf.xenqtt.message.QoS

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sf.xenqtt.mockbroker.BrokerEventType

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.sf.xenqtt.message.ConnectReturnCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.sf.xenqtt.message.MessageType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.sf.xenqtt.message.QoS

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum net.sf.xenqtt.mockbroker.BrokerEventType

Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

warn(Throwable, String) - Method in class net.sf.xenqtt.JavaLoggingDelegate

warn(String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the WARN log level, if possible.

warn(Throwable, String, Object...) - Static method in class net.sf.xenqtt.Log

Log a message at the WARN log level, if possible.

WARN_FLAG - Static variable in class net.sf.xenqtt.LoggingLevels

warnEnabled - Variable in class net.sf.xenqtt.LoggingLevels

wereAllFlagsInterrogated() - Method in class net.sf.xenqtt.AppContext

Determine if each of the flags that was specified by the user was interrogated by the application.

write(long) - Method in interface net.sf.xenqtt.message.MqttChannel

Writes as much data as possible.

X

Xenqtt - Class in net.sf.xenqtt

The entry point into the application when either the proxy or the gateway are run.

Xenqtt() - Constructor for class net.sf.xenqtt.Xenqtt

XenqttApplication - Interface in net.sf.xenqtt

Specifies a type that implements a Xenqtt application.

XenqttLogFormatter - Class in net.sf.xenqtt

A Formatter implementation that logs log records to a single line in the log file.

XenqttLogFormatter() - Constructor for class net.sf.xenqtt.XenqttLogFormatter

XenqttTestClient - Class in net.sf.xenqtt.test

A test client that facilitates load and validation testing of the Xenqtt MQTT client.

XenqttTestClient(AppContext) - Constructor for class net.sf.xenqtt.test.XenqttTestClient

Create a new instance of this class.

XenqttUtil - Class in net.sf.xenqtt

Provides disparate utility methods useful across the Xenqtt application ecosystem.

A B C D E F G H I J L M N P Q R S T U V W X