Package io.micronaut.websocket

Interface WebSocketClientRegistry<W extends WebSocketClient>

Type Parameters:

W - Web Socket Client

All Known Implementing Classes:

DefaultNettyHttpClientRegistry

public interface WebSocketClientRegistry<W extends WebSocketClient>

Interface for managing the construction and lifecycle of instances of reactive WebSocketClient clients.

Since:

3.0.0

Author:

Sergio del Amo

Method Summary

Modifier and Type	Method	Description
void	disposeClient(AnnotationMetadata annotationMetadata)	Dispose of the client defined by the given metadata.
default W	getDefaultWebSocketClient()
W	getWebSocketClient(@NonNull AnnotationMetadata annotationMetadata)	Return the client for the given annotation metadata.
W	resolveWebSocketClient(@Nullable InjectionPoint<?> injectionPoint, @Nullable LoadBalancer loadBalancer, @Nullable HttpClientConfiguration configuration, @NonNull BeanContext beanContext)	Resolves a WebSocketClient for the given injection point.

Method Details

resolveWebSocketClient

@NonNull
W resolveWebSocketClient(@Nullable
 @Nullable InjectionPoint<?> injectionPoint,
 @Nullable
 @Nullable LoadBalancer loadBalancer,
 @Nullable
 @Nullable HttpClientConfiguration configuration,
 @NonNull
 @NonNull BeanContext beanContext)

Resolves a WebSocketClient for the given injection point.

Parameters:

injectionPoint - The injection point

loadBalancer - The load balancer to use (Optional)

configuration - The configuration (Optional)

beanContext - The bean context to use

Returns:

The Streaming HTTP Client

getWebSocketClient

@NonNull
W getWebSocketClient(@NonNull
 @NonNull AnnotationMetadata annotationMetadata)

Return the client for the given annotation metadata.

Parameters:

annotationMetadata - The annotation metadata.

Returns:

The client

getDefaultWebSocketClient

default W getDefaultWebSocketClient()

Returns:

Return the default Websocket HTTP client.

disposeClient

void disposeClient(AnnotationMetadata annotationMetadata)

Dispose of the client defined by the given metadata.

Parameters:

annotationMetadata - The annotation metadata