software.amazon.awssdk.crt.mqtt

Class MqttClient

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.mqtt.MqttClient

All Implemented Interfaces:

AutoCloseable

public class MqttClient
extends CrtResource

This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionalities via the AWS Common Runtime One MqttClient class is needed per application. It can create any number of connections to any number of MQTT endpoints

Constructor Summary

Constructors

Constructor and Description
MqttClient() Creates a default MqttClient with no TLS and a ClientBootstrap constructed with default settings
MqttClient(ClientBootstrap clientBootstrap) Creates an MqttClient from the provided ClientBootstrap with no TLS
MqttClient(ClientBootstrap clientBootstrap, TlsContext tlsContext) Creates an MqttClient from the provided ClientBootstrap and TlsContext

Method Summary

Modifier and Type	Method and Description
void	close() Cleans up the native resources associated with this client.
TlsContext	tlsContext() Get the TlsContext associated with this client

Methods inherited from class software.amazon.awssdk.crt.CrtResource

acquire, getAllocatedNativeResourceCount, getAllocatedNativeResources, isNull, native_ptr, own, release

Methods inherited from class java.lang.Object

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

Constructor Detail

MqttClient

public MqttClient()
           throws CrtRuntimeException

Creates a default MqttClient with no TLS and a ClientBootstrap constructed with default settings

Throws:

CrtRuntimeException - @see software.amazon.awssdk.crt.io.ClientBootstrap#constructor(EventLoopGroup) @see software.amazon.awssdk.crt.io.EventLoopGroup#constructor(int)

MqttClient

public MqttClient(ClientBootstrap clientBootstrap)
           throws CrtRuntimeException

Creates an MqttClient from the provided ClientBootstrap with no TLS

Parameters:

clientBootstrap - The ClientBootstrap to use

Throws:

CrtRuntimeException - If the system is unable to allocate space for a native MQTT client structure

MqttClient

public MqttClient(ClientBootstrap clientBootstrap,
                  TlsContext tlsContext)
           throws CrtRuntimeException

Creates an MqttClient from the provided ClientBootstrap and TlsContext

Parameters:

clientBootstrap - The ClientBootstrap to use

tlsContext - The TlsContext to use

Throws:

CrtRuntimeException - If the system is unable to allocate space for a native MQTT client structure

Method Detail

close

public void close()

Cleans up the native resources associated with this client. The client is unusable after this call

Specified by:

close in interface AutoCloseable

Overrides:

close in class CrtResource

tlsContext

public TlsContext tlsContext()

Get the TlsContext associated with this client

Returns:

the TlsContext provided to this client at construction. May be null.