Package io.micronaut.websocket

Interface WebSocketClientFactory

public interface WebSocketClientFactory

A factory to create WebSocket clients.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
default WebSocketClient	createWebSocketClient(java.net.URI uri)	Create a new WebSocketClient.
default WebSocketClient	createWebSocketClient(java.net.URI uri, io.micronaut.http.client.HttpClientConfiguration configuration)	Create a new WebSocketClient with the specified configuration.
default WebSocketClient	createWebSocketClient(java.net.URL url)	Deprecated. Use createWebSocketClient(URI) instead
default WebSocketClient	createWebSocketClient(java.net.URL url, io.micronaut.http.client.HttpClientConfiguration configuration)	Deprecated. Use createWebSocketClient(URI, HttpClientConfiguration) instead

Method Detail

createWebSocketClient

@NonNull
@Deprecated
default WebSocketClient createWebSocketClient(@Nullable
                                              java.net.URL url)

Deprecated.

Use createWebSocketClient(URI) instead

Create a new WebSocketClient. Note that this method should only be used outside of 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 WebSocketClient createWebSocketClient(@Nullable
                                              java.net.URL url,
                                              @NonNull
                                              io.micronaut.http.client.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 of 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 WebSocketClient createWebSocketClient(@Nullable
                                              java.net.URI uri)

Create a new WebSocketClient. Note that this method should only be used outside of 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 WebSocketClient createWebSocketClient(@Nullable
                                              java.net.URI uri,
                                              @NonNull
                                              io.micronaut.http.client.HttpClientConfiguration configuration)

Create a new WebSocketClient 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

Parameters:

uri - The base URI

configuration - The client configuration

Returns:

The client

Since:

3.2.0