io.micronaut.rxjava2.http.client.websockets

Interface RxWebSocketClient

All Superinterfaces:

java.lang.AutoCloseable, io.micronaut.websocket.WebSocketClient

public interface RxWebSocketClient
extends io.micronaut.websocket.WebSocketClient

Specialization of the WebSocketClient interface for RxJava.

Since:

1.0

Author:

graemerocher

See Also:

WebSocketClient

Field Summary

Fields inherited from interface io.micronaut.websocket.WebSocketClient

SCHEME_WS, SCHEME_WSS

Method Summary

Modifier and Type	Method and Description
<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.util.Map<java.lang.String,java.lang.Object> parameters)
<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, io.micronaut.http.MutableHttpRequest<?> request)
default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.lang.String uri)
default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.net.URI uri)
static RxWebSocketClient	create(java.net.URL url) Create a new RxWebSocketClient.
static RxWebSocketClient	create(java.net.URL url, io.micronaut.http.client.HttpClientConfiguration configuration) Create a new RxWebSocketClient with the specified configuration.

Methods inherited from interface io.micronaut.websocket.WebSocketClient

close, create, create

Method Detail

connect

<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                     io.micronaut.http.MutableHttpRequest<?> request)

Specified by:

connect in interface io.micronaut.websocket.WebSocketClient

connect

default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                             java.net.URI uri)

Specified by:

connect in interface io.micronaut.websocket.WebSocketClient

connect

<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                     java.util.Map<java.lang.String,java.lang.Object> parameters)

Specified by:

connect in interface io.micronaut.websocket.WebSocketClient

connect

default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T> connect(java.lang.Class<T> clientEndpointType,
                                                                             java.lang.String uri)

Specified by:

connect in interface io.micronaut.websocket.WebSocketClient

create

static RxWebSocketClient create(@Nullable
                                java.net.URL url)

Create a new RxWebSocketClient. Note that this method should only be used outside of the context of a Micronaut application. The returned RxWebSocketClient is not subject to dependency injection. The creator is responsible for closing the client to avoid leaking connections. Within a Micronaut application use Inject to inject a client instead.

Specified by:

create in interface io.micronaut.websocket.WebSocketClient

Parameters:

url - The base URL

Returns:

The client

Since:

1.1.0

create

static RxWebSocketClient create(@Nullable
                                java.net.URL url,
                                @NonNull
                                io.micronaut.http.client.HttpClientConfiguration configuration)

Create a new RxWebSocketClient with the specified configuration. Note that this method should only be used outside of the context of an application. Within Micronaut use Inject to inject a client instead

Specified by:

create in interface io.micronaut.websocket.WebSocketClient

Parameters:

url - The base URL

configuration - the client configuration

Returns:

The client

Since:

1.1.0