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

Show more of this group Show more artifacts with this name
Show all versions of hivemq-mqtt-client Show documentation

HiveMQ MQTT Client is an MQTT 5.0 and MQTT 3.1.1 compatible and feature-rich high-performance Java client library with different API flavours and backpressure support

There is a newer version: 1.3.3

Show newest version

/*
 * 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.DoNotImplement;
import com.hivemq.client.internal.mqtt.MqttRxClientBuilderBase;
import org.jetbrains.annotations.NotNull;

/**
 * Common interface for MQTT clients.
 *
 * @author Silvio Giebl
 * @since 1.0
 */
@DoNotImplement
public interface MqttClient {

    /**
     * The default server host.
     */
    @NotNull String DEFAULT_SERVER_HOST = "localhost";
    /**
     * The default server port.
     */
    int DEFAULT_SERVER_PORT = 1883;
    /**
     * The default server port when using SSL/TLS.
     */
    int DEFAULT_SERVER_PORT_SSL = 8883;
    /**
     * The default server port when using WebSocket.
     */
    int DEFAULT_SERVER_PORT_WEBSOCKET = 80;
    /**
     * The default server port when using SSL/TLS and WebSocket.
     */
    int DEFAULT_SERVER_PORT_WEBSOCKET_SSL = 443;

    /**
     * Creates a builder for an MQTT client.
     *
     * @return the created builder for an MQTT client.
     */
    static @NotNull MqttClientBuilder builder() {
        return new MqttRxClientBuilderBase.Choose();
    }

    /**
     * @return the configuration of this client.
     */
    @NotNull MqttClientConfig getConfig();

    /**
     * @return the state of this client.
     * @since 1.1
     */
    default @NotNull MqttClientState getState() {
        return getConfig().getState();
    }
}