Package io.micronaut.websocket

Interface WebSocketClientRegistry<W extends WebSocketClient>

  • Type Parameters:
    W - Web Socket Client
    public interface WebSocketClientRegistry<W extends WebSocketClient>
    Interface for managing the construction and lifecycle of instances of reactive WebSocketClient clients.
    Since:
    3.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void disposeClient​(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)
      Dispose of the client defined by the given metadata.
      default W getDefaultWebSocketClient()  
      W getWebSocketClient​(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)
      Return the client for the given annotation metadata.
      W resolveWebSocketClient​(io.micronaut.inject.InjectionPoint<?> injectionPoint, io.micronaut.http.client.LoadBalancer loadBalancer, io.micronaut.http.client.HttpClientConfiguration configuration, io.micronaut.context.BeanContext beanContext)
      Resolves a WebSocketClient for the given injection point.

    • Method Detail

      • resolveWebSocketClient

        @NonNull
W resolveWebSocketClient​(@Nullable
                         io.micronaut.inject.InjectionPoint<?> injectionPoint,
                         @Nullable
                         io.micronaut.http.client.LoadBalancer loadBalancer,
                         @Nullable
                         io.micronaut.http.client.HttpClientConfiguration configuration,
                         @NonNull
                         io.micronaut.context.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
                     io.micronaut.core.annotation.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​(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)
        Dispose of the client defined by the given metadata.
        Parameters:
        annotationMetadata - The annotation metadata