io.micronaut.websocket

Interface WebSocketClient

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

RxWebSocketClient

All Known Implementing Classes:

DefaultHttpClient

public interface WebSocketClient
extends java.lang.AutoCloseable

Interface that provides a way to connect a client over WebSocket.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEME_WS Constant for HTTP scheme.
static java.lang.String	SCHEME_WSS Constant for HTTPS scheme.

Method Summary

Modifier and Type	Method and Description
void	close()
<T extends java.lang.AutoCloseable> org.reactivestreams.Publisher<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> org.reactivestreams.Publisher<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> org.reactivestreams.Publisher<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> org.reactivestreams.Publisher<T>	connect(java.lang.Class<T> clientEndpointType, java.net.URI uri) Connect the given client endpoint type to the URI over WebSocket.

Field Detail

SCHEME_WS

static final java.lang.String SCHEME_WS

Constant for HTTP scheme.

See Also:

Constant Field Values

SCHEME_WSS

static final java.lang.String SCHEME_WSS

Constant for HTTPS scheme.

See Also:

Constant Field Values

Method Detail

connect

<T extends java.lang.AutoCloseable> org.reactivestreams.Publisher<T> connect(java.lang.Class<T> clientEndpointType,
                                                                             MutableHttpRequest<?> request)

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

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

<T extends java.lang.AutoCloseable> org.reactivestreams.Publisher<T> connect(java.lang.Class<T> clientEndpointType,
                                                                             java.util.Map<java.lang.String,java.lang.Object> parameters)

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

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

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

connect

default <T extends java.lang.AutoCloseable> org.reactivestreams.Publisher<T> connect(java.lang.Class<T> clientEndpointType,
                                                                                     java.lang.String uri)

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

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

default <T extends java.lang.AutoCloseable> org.reactivestreams.Publisher<T> connect(java.lang.Class<T> clientEndpointType,
                                                                                     java.net.URI uri)

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

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