Package reactor.netty.http.client

Interface HttpClient.WebsocketReceiver<S extends HttpClient.WebsocketReceiver<?>>

All Superinterfaces:

HttpClient.UriConfiguration<S>

All Known Subinterfaces:

HttpClient.WebsocketSender

Enclosing class:

HttpClient

public static interface HttpClient.WebsocketReceiver<S extends HttpClient.WebsocketReceiver<?>>
extends HttpClient.UriConfiguration<S>

Allow a websocket handling. Since HttpClient.WebsocketReceiver API returns Flux or Mono, requesting is always deferred to Publisher.subscribe(Subscriber).

Method Summary

Modifier and Type	Method	Description
Mono<? extends Connection>	connect()	Negotiate a websocket upgrade and return a Mono of Connection.
<V> Flux<V>	handle(BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<V>> receiver)	Negotiate a websocket upgrade and extract a flux from the given WebsocketInbound and WebsocketOutbound.
ByteBufFlux	receive()	Negotiate a websocket upgrade and extract a flux from the underlying WebsocketInbound.

Methods inherited from interface reactor.netty.http.client.HttpClient.UriConfiguration

uri, uri, uri

Method Details

connect

Mono<? extends Connection> connect()

Negotiate a websocket upgrade and return a Mono of Connection. If Mono is cancelled, the underlying connection will be aborted. Once the Connection has been emitted and is not necessary anymore, disposing must be done by the user via DisposableChannel.dispose(). If update configuration phase fails, a Mono.error(Throwable) will be returned

Returns:

a Mono of Connection

handle

<V> Flux<V> handle(BiFunction<? super WebsocketInbound,? super WebsocketOutbound,? extends Publisher<V>> receiver)

Negotiate a websocket upgrade and extract a flux from the given WebsocketInbound and WebsocketOutbound.

The connection will not automatically DisposableChannel.dispose() and manual disposing with the Connection, WebsocketOutbound.sendClose() or the returned Flux might be necessary if the remote never terminates itself.

If the upgrade fails, the returned Flux will emit a WebSocketHandshakeException

Type Parameters:

V - the extracted flux type

Parameters:

receiver - extracting receiver

Returns:

a Flux of the extracted data via the returned Publisher

receive

ByteBufFlux receive()

Negotiate a websocket upgrade and extract a flux from the underlying WebsocketInbound.

The connection will be disposed when the underlying subscriber is disposed OR when a close frame has been received, forwarding onComplete to the returned flux subscription.

If the upgrade fails, the returned Flux will emit a WebSocketHandshakeException

Returns:

a ByteBufFlux of the inbound websocket content