io.rsocket.transport.netty.client

Class WebsocketClientTransport

java.lang.Object

io.rsocket.transport.netty.client.WebsocketClientTransport

All Implemented Interfaces:

io.rsocket.transport.ClientTransport, io.rsocket.transport.Transport

public final class WebsocketClientTransport
extends Object
implements io.rsocket.transport.ClientTransport

An implementation of ClientTransport that connects to a ServerTransport over WebSocket.

Method Summary

Modifier and Type	Method and Description
Mono<io.rsocket.DuplexConnection>	connect()
static WebsocketClientTransport	create(reactor.netty.http.client.HttpClient client, String path) Creates a new instance
static WebsocketClientTransport	create(InetSocketAddress address) Creates a new instance
static WebsocketClientTransport	create(int port) Creates a new instance connecting to localhost
static WebsocketClientTransport	create(String bindAddress, int port) Creates a new instance
static WebsocketClientTransport	create(reactor.netty.tcp.TcpClient client) Creates a new instance
static WebsocketClientTransport	create(URI uri) Creates a new instance
WebsocketClientTransport	header(String name, String... values) Add a header and value(s) to use for the WebSocket handshake request.
int	maxFrameLength()
WebsocketClientTransport	webSocketSpec(Consumer<reactor.netty.http.client.WebsocketClientSpec.Builder> configurer) Provide a consumer to customize properties of the WebsocketClientSpec to use for WebSocket upgrades.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static WebsocketClientTransport create(int port)

Creates a new instance connecting to localhost

Parameters:

port - the port to connect to

Returns:

a new instance

create

public static WebsocketClientTransport create(String bindAddress,
                                              int port)

Creates a new instance

Parameters:

bindAddress - the address to connect to

port - the port to connect to

Returns:

a new instance

Throws:

NullPointerException - if bindAddress is null

create

public static WebsocketClientTransport create(InetSocketAddress address)

Creates a new instance

Parameters:

address - the address to connect to

Returns:

a new instance

Throws:

NullPointerException - if address is null

create

public static WebsocketClientTransport create(reactor.netty.tcp.TcpClient client)

Creates a new instance

Parameters:

client - the TcpClient to use

Returns:

a new instance

Throws:

NullPointerException - if client or path is null

create

public static WebsocketClientTransport create(URI uri)

Creates a new instance

Parameters:

uri - the URI to connect to

Returns:

a new instance

Throws:

NullPointerException - if uri is null

create

public static WebsocketClientTransport create(reactor.netty.http.client.HttpClient client,
                                              String path)

Creates a new instance

Parameters:

client - the HttpClient to use

path - the path to request

Returns:

a new instance

Throws:

NullPointerException - if client or path is null

header

public WebsocketClientTransport header(String name,
                                       String... values)

Add a header and value(s) to use for the WebSocket handshake request.

Parameters:

name - the header name

values - the header value(s)

Returns:

the same instance for method chaining

Since:

1.0.1

webSocketSpec

public WebsocketClientTransport webSocketSpec(Consumer<reactor.netty.http.client.WebsocketClientSpec.Builder> configurer)

Provide a consumer to customize properties of the WebsocketClientSpec to use for WebSocket upgrades. The consumer is invoked immediately.

Parameters:

configurer - the configurer to apply to the spec

Returns:

the same instance for method chaining

Since:

1.0.1

maxFrameLength

public int maxFrameLength()

Specified by:

maxFrameLength in interface io.rsocket.transport.Transport

connect

public Mono<io.rsocket.DuplexConnection> connect()

Specified by:

connect in interface io.rsocket.transport.ClientTransport