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 and Description
WebSocketClient	createWebSocketClient(java.net.URL url) Create a new WebSocketClient.
WebSocketClient	createWebSocketClient(java.net.URL url, HttpClientConfiguration configuration) Create a new WebSocketClient with the specified configuration.

Method Detail

createWebSocketClient

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

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
WebSocketClient createWebSocketClient(@Nullable
                                               java.net.URL url,
                                               @NonNull
                                               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:

url - The base URL

configuration - The client configuration

Returns:

The client