reactor.netty.http.client.WebsocketClientSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactor-netty-http Show documentation
HTTP functionality for the Reactor Netty library
There is a newer version: 1.2.1
/*
 * Copyright (c) 2020-2023 VMware, Inc. or its affiliates, All Rights Reserved.
 *
 * 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
 *
 *   https://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 reactor.netty.http.client;

import io.netty.handler.codec.http.websocketx.WebSocketVersion;
import io.netty.handler.codec.http.websocketx.extensions.compression.PerMessageDeflateClientExtensionHandshaker;
import reactor.netty.http.websocket.WebsocketSpec;

import java.util.Objects;

/**
 * Websocket client configuration.
 *
 * @author Violeta Georgieva
 * @since 0.9.7
 */
public interface WebsocketClientSpec extends WebsocketSpec {

	/**
	 * Returns whether the server is allowed to activate {@code client_no_context_takeover}.
	 *
	 * @return whether the server is allowed to activate {@code client_no_context_takeover}
	 * @since 1.1.14
	 */
	boolean compressionAllowClientNoContext();

	/**
	 * Returns whether the client needs to activate {@code server_no_context_takeover}.
	 *
	 * @return whether the client needs to activate {@code server_no_context_takeover}
	 * @since 1.1.14
	 */
	boolean compressionRequestedServerNoContext();

	/**
	 * Returns the configured WebSocket version.
	 *
	 * @return returns the configured WebSocket version
	 * @since 1.0.3
	 */
	WebSocketVersion version();

	/**
	 * Create builder with default properties.

	 * version = {@link io.netty.handler.codec.http.websocketx.WebSocketVersion#V13}
	 * 

	 * protocols = null
	 * 

	 * maxFramePayloadLength = 65536
	 * 

	 * handlePing = false
	 * 

	 * compress = false
	 * 

	 * compressionAllowClientNoContext = false
	 * 

	 * compressionRequestedServerNoContext = false
	 *
	 * @return {@link Builder}
	 */
	static Builder builder() {
		return new Builder();
	}

	final class Builder extends WebsocketSpec.Builder {

		boolean allowClientNoContext;
		boolean requestedServerNoContext;
		WebSocketVersion version = WebSocketVersion.V13;

		private Builder() {
		}

		/**
		 * Allows the server to activate {@code client_no_context_takeover}
		 * Default to false.
		 *
		 * @param allowClientNoContext allows the server to activate {@code client_no_context_takeover}
		 * @return {@literal this}
		 * @since 1.1.14
		 * @see PerMessageDeflateClientExtensionHandshaker
		 */
		public final Builder compressionAllowClientNoContext(boolean allowClientNoContext) {
			this.allowClientNoContext = allowClientNoContext;
			return this;
		}

		/**
		 * Indicates if the client needs to activate {@code server_no_context_takeover} if the server is compatible with.
		 * Default to false.
		 *
		 * @param requestedServerNoContext indicates if the client needs to activate
		 * {@code server_no_context_takeover} if the server is compatible with
		 * @return {@literal this}
		 * @since 1.1.14
		 * @see PerMessageDeflateClientExtensionHandshaker
		 */
		public final Builder compressionRequestedServerNoContext(boolean requestedServerNoContext) {
			this.requestedServerNoContext = requestedServerNoContext;
			return this;
		}

		/**
		 * Sets websocket version to use.
		 * Set to {@link io.netty.handler.codec.http.websocketx.WebSocketVersion#V13} by default
		 *
		 * @param version WebSocket version to be used
		 * @return {@literal this}
		 * @throws NullPointerException if version is null
		 * @throws IllegalArgumentException if the version is unknown
		 * @since 1.0.3
		 */
		public final Builder version(WebSocketVersion version) {
			Objects.requireNonNull(version, "version");
			if (WebSocketVersion.UNKNOWN.equals(version)) {
				throw new IllegalArgumentException("WebSocketVersion.UNKNOWN represents an invalid version, please provide a proper version");
			}
			this.version = version;
			return this;
		}

		/**
		 * Builds new {@link WebsocketClientSpec}.
		 *
		 * @return builds new {@link WebsocketClientSpec}
		 */
		public final WebsocketClientSpec build() {
			return new WebsocketClientSpecImpl(this);
		}
	}
}