com.hivemq.client.mqtt.MqttWebSocketConfigBuilderBase 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
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.CheckReturnValue;
import com.hivemq.client.annotations.DoNotImplement;
import org.jetbrains.annotations.NotNull;
import java.util.Map;
import java.util.concurrent.TimeUnit;
/**
* Builder base for a {@link MqttWebSocketConfig}.
*
* @param the type of the builder.
* @author Silvio Giebl
* @since 1.0
*/
@DoNotImplement
public interface MqttWebSocketConfigBuilderBase> {
/**
* Sets the {@link MqttWebSocketConfig#getServerPath() server path}.
*
* @param serverPath the server path.
* @return the builder.
*/
@CheckReturnValue
@NotNull B serverPath(@NotNull String serverPath);
/**
* Sets the {@link MqttWebSocketConfig#getQueryString() query string}.
*
* @param queryString the query string.
* @return the builder.
*/
@CheckReturnValue
@NotNull B queryString(@NotNull String queryString);
/**
* Sets the {@link MqttWebSocketConfig#getSubprotocol() subprotocol}.
*
* @param subprotocol the subprotocol.
* @return the builder.
*/
@CheckReturnValue
@NotNull B subprotocol(@NotNull String subprotocol);
/**
* Sets the {@link MqttWebSocketConfig#getHandshakeTimeoutMs() websocket handshake timeout}.
*
* The timeout in milliseconds must be in the range: [0, {@link Integer#MAX_VALUE}].
*
* @param timeout the websocket handshake timeout or 0 to disable the timeout.
* @param timeUnit the time unit of the given timeout (this timeout only supports millisecond precision).
* @return the builder.
* @since 1.2
*/
@CheckReturnValue
@NotNull B handshakeTimeout(long timeout, @NotNull TimeUnit timeUnit);
/**
* Sets the {@link MqttWebSocketConfig#getHttpHeaders() headers}.
*
* @param httpHeaders http headers.
* @return the builder.
*/
@CheckReturnValue
@NotNull B httpHeaders(@NotNull Map httpHeaders);
}