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

Go to download

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

The 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.MqttWebSocketConfigImplBuilder;
import org.jetbrains.annotations.NotNull;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Configuration for a WebSocket transport to use by {@link MqttClient MQTT clients}.
 *
 * @author Christian Hoff
 * @author Silvio Giebl
 * @since 1.0
 */
@DoNotImplement
public interface MqttWebSocketConfig {

    /**
     * The default WebSocket server path.
     */
    @NotNull String DEFAULT_SERVER_PATH = "";
    /**
     * The default WebSocket query string.
     */
    @NotNull String DEFAULT_QUERY_STRING = "";
    /**
     * The default WebSocket subprotocol.
     * 
     * See the WebSocket Subprotocol
     * Name Registry
     */
    @NotNull String DEFAULT_MQTT_SUBPROTOCOL = "mqtt";
    /**
     * The default websocket handshake timeout in milliseconds.
     *
     * @since 1.2
     */
    int DEFAULT_HANDSHAKE_TIMEOUT_MS = 10_000;
    /**
     * The default map of headers.
     * @since 1.2.3
     */
    @NotNull Map DEFAULT_HTTP_HEADERS = new LinkedHashMap<>();


    /**
     * Creates a builder for a WebSocket configuration.
     *
     * @return the created builder for a WebSocket configuration.
     */
    static @NotNull MqttWebSocketConfigBuilder builder() {
        return new MqttWebSocketConfigImplBuilder.Default();
    }

    /**
     * @return the WebSocket server path.
     */
    @NotNull String getServerPath();

    /**
     * @return the WebSocket query string.
     */
    @NotNull String getQueryString();

    /**
     * @return the WebSocket subprotocol.
     */
    @NotNull String getSubprotocol();

    /**
     * @return the websocket handshake timeout in milliseconds.
     * @since 1.2
     */
    int getHandshakeTimeoutMs();

    /**
     * @return map of already set headers.
     * @since 1.2.3
     */
    @NotNull Map getHttpHeaders();

    /**
     * Creates a builder for extending this WebSocket configuration.
     *
     * @return the created builder.
     * @since 1.1
     */
    @NotNull MqttWebSocketConfigBuilder extend();

}