Package com.hivemq.client.mqtt

Interface MqttClientExecutorConfig

@DoNotImplement
public interface MqttClientExecutorConfig

Configuration for the executors and threads to use by MQTT clients.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull Scheduler	DEFAULT_APPLICATION_SCHEDULER

Method Summary

Modifier and Type	Method	Description
static @NotNull MqttClientExecutorConfigBuilder	builder()	Creates a builder for an executor configuration.
@NotNull MqttClientExecutorConfigBuilder	extend()	Creates a builder for extending this executor configuration.
@NotNull Scheduler	getApplicationScheduler()
@NotNull Optional<Executor>	getNettyExecutor()
@NotNull OptionalInt	getNettyThreads()

Field Details

DEFAULT_APPLICATION_SCHEDULER

@NotNull
static final @NotNull Scheduler DEFAULT_APPLICATION_SCHEDULER

Method Details

builder

@NotNull
static @NotNull MqttClientExecutorConfigBuilder builder()

Creates a builder for an executor configuration.

Returns:

the created builder for an executor configuration.

getNettyExecutor

@NotNull
@NotNull Optional<Executor> getNettyExecutor()

Returns:

the optional user defined executor for Netty (network communication framework).

getNettyThreads

@NotNull
@NotNull OptionalInt getNettyThreads()

Returns:

the optional user defined amount of threads Netty (network communication framework) will use.

getApplicationScheduler

@NotNull
@NotNull Scheduler getApplicationScheduler()

Returns:

the Scheduler used for executing application specific code, such as callbacks.

extend

@NotNull
@NotNull MqttClientExecutorConfigBuilder extend()

Creates a builder for extending this executor configuration.

Returns:

the created builder.

Since:

1.1