io.helidon.webclient.websocket.WsClientConfigBlueprint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-webclient-websocket Show documentation

The newest version!

/*
 * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
 *
 * 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 io.helidon.webclient.websocket;

import io.helidon.builder.api.Option;
import io.helidon.builder.api.Prototype;
import io.helidon.webclient.api.HttpClientConfig;

/**
 * WebSocket full webclient configuration.
 * The client configuration also contains all necessary configuration for HTTP, as WebSocket upgrades from HTTP.
 *
 * @see io.helidon.webclient.api.WebClient#client(io.helidon.webclient.spi.Protocol,
 *         io.helidon.webclient.spi.ProtocolConfig)
 */
@Prototype.Blueprint
@Prototype.Configured
interface WsClientConfigBlueprint extends HttpClientConfig, Prototype.Factory {
    /**
     * WebSocket specific configuration.
     *
     * @return protocol specific configuration
     */
    @Option.Configured
    @Option.Default("create()")
    WsClientProtocolConfig protocolConfig();
}