Package io.micronaut.rxjava3.http.client.websockets

Interface Rx3WebSocketClient

All Superinterfaces:
AutoCloseable, io.micronaut.websocket.WebSocketClient
public interface Rx3WebSocketClient extends io.micronaut.websocket.WebSocketClient
Specialization of the WebSocketClient interface for RxJava 3.
Since:
2.1.0
Author:
James Kleeh
See Also:
  • WebSocketClient

  • Field Summary

    Fields inherited from interface io.micronaut.websocket.WebSocketClient

    SCHEME_WS, SCHEME_WSS

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends AutoCloseable>
    io.reactivex.rxjava3.core.Flowable<T>
    connect(Class<T> clientEndpointType, io.micronaut.http.MutableHttpRequest<?> request)
     
    default <T extends AutoCloseable>
    io.reactivex.rxjava3.core.Flowable<T>
    connect(Class<T> clientEndpointType, String uri)
     
    default <T extends AutoCloseable>
    io.reactivex.rxjava3.core.Flowable<T>
    connect(Class<T> clientEndpointType, URI uri)
    <T extends AutoCloseable>
    io.reactivex.rxjava3.core.Flowable<T>
    connect(Class<T> clientEndpointType, Map<String,Object> parameters)
    static Rx3WebSocketClient
    create(@Nullable URL url)
    Create a new Rx3WebSocketClient.
    static Rx3WebSocketClient
    create(@Nullable URL url, @NonNull io.micronaut.http.client.HttpClientConfiguration configuration)
    Create a new Rx3WebSocketClient with the specified configuration.

    Methods inherited from interface io.micronaut.websocket.WebSocketClient

    close

  • Method Details

    • connect

      <T extends AutoCloseable> io.reactivex.rxjava3.core.Flowable<T> connect(Class<T> clientEndpointType, io.micronaut.http.MutableHttpRequest<?> request)
      Specified by:
      connect in interface io.micronaut.websocket.WebSocketClient

    • connect

      default <T extends AutoCloseable> io.reactivex.rxjava3.core.Flowable<T> connect(Class<T> clientEndpointType, URI uri)
      Specified by:
      connect in interface io.micronaut.websocket.WebSocketClient

    • connect

      <T extends AutoCloseable> io.reactivex.rxjava3.core.Flowable<T> connect(Class<T> clientEndpointType, Map<String,Object> parameters)
      Specified by:
      connect in interface io.micronaut.websocket.WebSocketClient

    • connect

      default <T extends AutoCloseable> io.reactivex.rxjava3.core.Flowable<T> connect(Class<T> clientEndpointType, String uri)
      Specified by:
      connect in interface io.micronaut.websocket.WebSocketClient

    • create

      static Rx3WebSocketClient create(@Nullable @Nullable URL url)
      Create a new Rx3WebSocketClient. Note that this method should only be used outside of the context of a Micronaut application. The returned Rx3WebSocketClient is not subject to dependency injection. The creator is responsible for closing the client to avoid leaking connections. Within a Micronaut application use Inject to inject a client instead.
      Parameters:
      url - The base URL
      Returns:
      The client
      Since:
      2.1.0

    • create

      static Rx3WebSocketClient create(@Nullable @Nullable URL url, @NonNull @NonNull io.micronaut.http.client.HttpClientConfiguration configuration)
      Create a new Rx3WebSocketClient 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
      Since:
      2.1.0