io.micronaut.rxjava2.http.client.websockets.RxWebSocketClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-rxjava2-http-client Show documentation
Integration between Micronaut and RxJava 2
The newest version!
/*
 * Copyright 2017-2020 original authors
 *
 * 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 io.micronaut.rxjava2.http.client.websockets;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.MutableHttpRequest;
import io.micronaut.http.client.HttpClientConfiguration;
import io.micronaut.websocket.WebSocketClient;
import io.reactivex.Flowable;

import java.net.URI;
import java.net.URL;
import java.util.Map;

/**
 * Specialization of the {@link WebSocketClient} interface for RxJava.
 *
 * @author graemerocher
 * @since 1.0
 * @see WebSocketClient
 */
public interface RxWebSocketClient extends WebSocketClient {

    @Override
     Flowable connect(Class clientEndpointType, MutableHttpRequest request);

    /**
     * {@inheritDoc}
     */
    @Override
    default  Flowable connect(Class clientEndpointType, URI uri) {
        return (Flowable) WebSocketClient.super.connect(clientEndpointType, uri);
    }

    /**
     * {@inheritDoc}
     */
    @Override
     Flowable connect(Class clientEndpointType, Map parameters);

    @Override
    default  Flowable connect(Class clientEndpointType, String uri) {
        return (Flowable) WebSocketClient.super.connect(clientEndpointType, uri);
    }

    /**
     * Create a new {@link RxWebSocketClient}.
     * Note that this method should only be used outside of the context of a Micronaut application.
     * The returned {@link RxWebSocketClient} is not subject to dependency injection.
     * The creator is responsible for closing the client to avoid leaking connections.
     * Within a Micronaut application use {@link jakarta.inject.Inject} to inject a client instead.
     *
     * @param url The base URL
     * @return The client
     * @since 1.1.0
     */
    static RxWebSocketClient create(@Nullable URL url) {
        return new BridgedRxWebSocketClient(WebSocketClient.create(url));
    }

    /**
     * Create a new {@link RxWebSocketClient} with the specified configuration. Note that this method should only be used
     * outside of the context of an application. Within Micronaut use {@link jakarta.inject.Inject} to inject a client instead
     *
     * @param url The base URL
     * @param configuration the client configuration
     * @return The client
     * @since 1.1.0
     */
    static RxWebSocketClient create(@Nullable URL url, @NonNull HttpClientConfiguration configuration) {
        return new BridgedRxWebSocketClient(WebSocketClient.create(url, configuration));
    }
}