Package io.micronaut.websocket

Interface WebSocketClientFactory

All Known Implementing Classes:

NettyHttpClientFactory

public interface WebSocketClientFactory

A factory to create WebSocket clients.

Since:

3.0.0

Author:

James Kleeh, Sergio del Amo

Method Summary

Modifier and Type	Method	Description
default @NonNull WebSocketClient	createWebSocketClient(@Nullable URI uri)	Create a new WebSocketClient.
default @NonNull WebSocketClient	createWebSocketClient(@Nullable URI uri, @NonNull HttpClientConfiguration configuration)	Create a new WebSocketClient with the specified configuration.
default @NonNull WebSocketClient	createWebSocketClient(@Nullable URL url)	Deprecated. Use createWebSocketClient(URI) instead
default @NonNull WebSocketClient	createWebSocketClient(@Nullable URL url, @NonNull HttpClientConfiguration configuration)	Deprecated. Use createWebSocketClient(URI, HttpClientConfiguration) instead

Method Details

createWebSocketClient

@NonNull
@Deprecated
default @NonNull WebSocketClient createWebSocketClient(@Nullable
 @Nullable URL url)

Deprecated.

Use createWebSocketClient(URI) instead

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

Parameters:

url - The base URL

Returns:

The client

createWebSocketClient

@NonNull
@Deprecated
default @NonNull WebSocketClient createWebSocketClient(@Nullable
 @Nullable URL url,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

Deprecated.

Use createWebSocketClient(URI, HttpClientConfiguration) instead

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

Parameters:

url - The base URL

configuration - The client configuration

Returns:

The client

createWebSocketClient

@NonNull
default @NonNull WebSocketClient createWebSocketClient(@Nullable
 @Nullable URI uri)

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

Parameters:

uri - The base URI

Returns:

The client

Since:

3.2.0

createWebSocketClient

@NonNull
default @NonNull WebSocketClient createWebSocketClient(@Nullable
 @Nullable URI uri,
 @NonNull
 @NonNull HttpClientConfiguration configuration)

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

Parameters:

uri - The base URI

configuration - The client configuration

Returns:

The client

Since:

3.2.0