• Home
• com.hivemq
• hivemq-mqtt-client
• 1.3.2
• source code
• MqttClientExecutorConfigBuilderBase.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.hivemq.client.mqtt.MqttClientExecutorConfigBuilderBase Maven / Gradle / Ivy

/*
 * Copyright 2018-present HiveMQ and the HiveMQ Community
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hivemq.client.mqtt;

import com.hivemq.client.annotations.CheckReturnValue;
import com.hivemq.client.annotations.DoNotImplement;
import io.reactivex.Scheduler;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.concurrent.Executor;

/**
 * Builder base for a {@link MqttClientExecutorConfig}.
 *
 * @param  the type of the builder.
 * @author Silvio Giebl
 * @since 1.0
 */
@DoNotImplement
public interface MqttClientExecutorConfigBuilderBase> {

    /**
     * Sets the optional user defined {@link MqttClientExecutorConfig#getNettyExecutor() executor for Netty} (network
     * communication framework).
     *
     * @param nettyExecutor the user defined executor for Netty or null to use the default executor.
     * @return the builder.
     */
    @CheckReturnValue
    @NotNull B nettyExecutor(@Nullable Executor nettyExecutor);

    /**
     * Sets the optional user defined {@link MqttClientExecutorConfig#getNettyThreads() amount of threads Netty}
     * (network communication framework).
     *
     * @param nettyThreads the user defined amount of threads Netty.
     * @return the builder.
     */
    @CheckReturnValue
    @NotNull B nettyThreads(int nettyThreads);

    /**
     * Sets the {@link MqttClientExecutorConfig#getApplicationScheduler() scheduler used for executing application
     * specific code}.
     *
     * @param applicationScheduler the scheduler used for executing application specific code.
     * @return the builder.
     */
    @CheckReturnValue
    @NotNull B applicationScheduler(@NotNull Scheduler applicationScheduler);
}