Package com.plccom.mqtt.client
Public API surface for the PLCcom MQTT client.
This package contains the supported client-facing types for connecting to MQTT 3.1.1 and MQTT 5.0 brokers, publishing and subscribing messages, configuring transport security and using the high-level convenience builders. The API is intended for general MQTT applications and does not depend on any application-specific runtime.
-
Interface Summary Interface Description MqttConnectedListener Callback invoked after a high-level client connection has been established.MqttDisconnectedListener Callback invoked when a high-level client connection is closed or lost.MqttMessageListener Receives high-level MQTT application messages for callback subscriptions.MqttReconnectFailedListener Callback invoked when automatic reconnect cannot re-establish the client.MqttSubscriptionHandle Handle for a high-level client subscription.PlccomMqttClient Synchronous PLCcom MQTT client.PlccomMqttClientEnhancedAuthenticator Handles broker AUTH challenges during MQTT 5 enhanced authentication. -
Class Summary Class Description MqttAsyncClientPublishBuilder Asynchronous high-level builder for one client-side MQTT PUBLISH operation.MqttAsyncClientRequestBuilder Asynchronous wrapper for one high-level MQTT 5 request/response exchange.MqttAsyncClientSubscribeBuilder Asynchronous high-level builder for one client-side MQTT SUBSCRIBE operation.MqttClientPublishBuilder High-level builder for one client-side MQTT PUBLISH operation.MqttClientRequestBuilder High-level builder for one MQTT 5 request/response exchange.MqttClientSubscribeBuilder High-level builder for one client-side MQTT SUBSCRIBE operation.MqttClientWillBuilder High-level builder for configuring a client Last Will onPlccomMqttClientBuilder.MqttConnectedContext Context delivered to high-level client connection callbacks.MqttDisconnectedContext Context delivered when a high-level client connection becomes disconnected.MqttMessage High-level view of an MQTT application message.MqttPublishResult Result of a high-level publish operation.MqttReconnectFailedContext Context delivered when bounded automatic reconnect gives up.MqttRequestResponseResult Result of one high-level MQTT 5 request/response operation.MqttSubscribeResult Result of a high-level subscribe operation.MqttUnsubscribeResult Result of a high-level client unsubscribe operation.PlccomMqttAsyncClient CompletableFuture based comfort facade for an existing PLCcom MQTT client.PlccomMqttClientBuilder High-level builder for creatingPlccomMqttClientinstances.PlccomMqttClientEnhancedAuthContext Immutable context passed to a client-side MQTT 5 enhanced authentication handler when the broker sends an AUTH challenge.PlccomMqttClientEnhancedAuthResponse Response returned by a client-side MQTT 5 enhanced authentication handler.PlccomMqttClientFactory Factory for PLCcom MQTT clients.PlccomMqttClientOptions Immutable options for a PLCcom MQTT client connection.PlccomMqttClientOptions.Builder Builder forPlccomMqttClientOptions.PlccomMqttConnectResult Result of an MQTT CONNECT handshake.PlccomMqttEndpoint MQTT endpoint address.PlccomMqttLastWill Immutable MQTT Last Will configuration for a client CONNECT packet.PlccomMqttLastWill.Builder Builder for immutable Last Will configuration.PlccomMqttPublishMessage MQTT publish message.PlccomMqttPublishMessage.Builder Builder for publish messages.PlccomMqttSubscription MQTT topic filter subscription.PlccomMqttTlsOptions TLS options formqtts://connections.PlccomMqttTlsOptions.Builder Builder forPlccomMqttTlsOptions.PlccomMqttUserProperty MQTT 5 user property. -
Enum Summary Enum Description PlccomMqttProtocolVersion MQTT protocol version requested by a PLCcom MQTT client connection.PlccomMqttQualityOfService MQTT Quality of Service level.PlccomMqttRetainHandling MQTT 5 Retain Handling option used by SUBSCRIBE. -
Exception Summary Exception Description PlccomMqttAuthenticationException MQTT authentication or authorization failure.PlccomMqttConnectException MQTT connection or CONNACK failure.PlccomMqttLicenseException Runtime exception thrown when a licensed high-level MQTT client operation is used without valid PLCcom license information.PlccomMqttTimeoutException MQTT operation timeout.PlccomMqttTlsException TLS setup or verification failure.PlccomMqttUnsupportedFeatureException Requested MQTT feature is not implemented in the current release.