io.micronaut.websocket

Interface WebSocketClient

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

RxWebSocketClient

All Known Implementing Classes:

DefaultHttpClient

public interface WebSocketClient
extends AutoCloseable

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

Since:

1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
void	close()
<T extends AutoCloseable> Publisher<T>	connect(Class<T> clientEndpointType, Map<String,Object> parameters) Connect the given client endpoint type.
<T extends AutoCloseable> Publisher<T>	connect(Class<T> clientEndpointType, MutableHttpRequest<?> request) Connect the given client endpoint type to the URI over WebSocket.
default <T extends AutoCloseable> Publisher<T>	connect(Class<T> clientEndpointType, String uri) Connect the given client endpoint type to the URI over WebSocket.
default <T extends AutoCloseable> Publisher<T>	connect(Class<T> clientEndpointType, URI uri) Connect the given client endpoint type to the URI over WebSocket.

Method Detail

connect

<T extends AutoCloseable> Publisher<T> connect(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 AutoCloseable> Publisher<T> connect(Class<T> clientEndpointType,
                                               Map<String,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 AutoCloseable

connect

default <T extends AutoCloseable> Publisher<T> connect(Class<T> clientEndpointType,
                                                       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 AutoCloseable> Publisher<T> connect(Class<T> clientEndpointType,
                                                       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