io.micronaut.websocket

Interface RxWebSocketClient

All Superinterfaces:

java.lang.AutoCloseable, WebSocketClient

All Known Implementing Classes:

DefaultHttpClient

public interface RxWebSocketClient
extends 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) Connect the given client endpoint type.
<T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, MutableHttpRequest<?> request) Connect the given client endpoint type to the URI over WebSocket.
default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.lang.String uri) Connect the given client endpoint type to the URI over WebSocket.
default <T extends java.lang.AutoCloseable> io.reactivex.Flowable<T>	connect(java.lang.Class<T> clientEndpointType, java.net.URI uri) Connect the given client endpoint type to the URI over WebSocket.

Methods inherited from interface io.micronaut.websocket.WebSocketClient

close

Method Detail

connect

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

Description copied from interface: WebSocketClient

Connect the given client endpoint type to the URI over WebSocket.

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

request - The original request to establish the connection

Returns:

A Publisher that emits the ClientWebSocket instance

connect

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

Connect the given client endpoint type to the URI over WebSocket.

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

uri - The URI to connect over

Returns:

A Publisher that emits the ClientWebSocket instance

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)

Connect the given client endpoint type. Unlike WebSocketClient.connect(Class, URI) this method will the value declared within the ClientWebSocket as the URI and expand the URI with the given parameters.

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

parameters - The URI parameters for the endpoint

Returns:

A Publisher that emits the ClientWebSocket instance

connect

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

Description copied from interface: WebSocketClient

Connect the given client endpoint type to the URI over WebSocket.

Specified by:

connect in interface WebSocketClient

Type Parameters:

T - The generic type

Parameters:

clientEndpointType - The endpoint type. Should be a class annotated with ClientWebSocket

uri - The URI to connect over

Returns:

A Publisher that emits the ClientWebSocket instance