rsocket-transport-netty 1.1.4 · io.rsocket.transport.netty.client.WebsocketClientTransport

Modifier and Type	Field and Description
private final HttpClient	client
private static final String	DEFAULT_PATH
private HttpHeaders	headers
private final String	path
private final WebsocketClientSpec.Builder	specBuilder

Access	Constructor and Description
private	WebsocketClientTransport(HttpClient client, String path)

Method Summary

Modifier and Type	Method and Description
public Mono<DuplexConnection>	connect() Implements io.rsocket.transport.ClientTransport.connect. Return a `Mono` that connects for each subscriber.
public static WebsocketClientTransport	Returns: a new instance create(int the port to connect to port) Creates a new instance connecting to localhost
public static WebsocketClientTransport	Returns: a new instance create(String the address to connect to bindAddress, int the port to connect to port) Creates a new instance
public static WebsocketClientTransport	Returns: a new instance create(InetSocketAddress the address to connect to address) Creates a new instance
public static WebsocketClientTransport	Returns: a new instance create(TcpClient the `TcpClient` to use client) Creates a new instance
public static WebsocketClientTransport	Returns: a new instance create(URI the URI to connect to uri) Creates a new instance
public static WebsocketClientTransport	Returns: a new instance create(HttpClient the `HttpClient` to use client, String the path to request path) Creates a new instance
public WebsocketClientTransport	Returns: the same instance for method chaining header(String the header name name, String... the header value(s) values) Add a header and value(s) to use for the WebSocket handshake request.
public int	maxFrameLength() Overrides default io.rsocket.transport.Transport.maxFrameLength. Configurations that exposes the maximum frame size that a `DuplexConnection` can bring up to RSocket level.
public WebsocketClientTransport	Returns: the same instance for method chaining webSocketSpec(Consumer<WebsocketClientSpec.Builder> the configurer to apply to the spec configurer) Provide a consumer to customize properties of the `WebsocketClientSpec` to use for WebSocket upgrades.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

client	back to summary
private final HttpClient client

DEFAULT_PATH	back to summary
private static final String DEFAULT_PATH

headers	back to summary
private HttpHeaders headers

path	back to summary
private final String path

specBuilder	back to summary
private final WebsocketClientSpec.Builder specBuilder

WebsocketClientTransport	back to summary
private WebsocketClientTransport(HttpClient client, String path)

Method Detail

connect back to summary

connect	back to summary
public Mono<DuplexConnection> connect() Implements io.rsocket.transport.ClientTransport.connect. Doc from io.rsocket.transport.ClientTransport.connect. Return a `Mono` that connects for each subscriber. Annotations @Override

public Mono<DuplexConnection> connect()

Implements io.rsocket.transport.ClientTransport.connect.

Doc from io.rsocket.transport.ClientTransport.connect.

Return a Mono that connects for each subscriber.

Annotations

@Override

create	back to summary
public static WebsocketClientTransport create(int port) Creates a new instance connecting to localhost Parameters port:int the port to connect to Returns:WebsocketClientTransport a new instance

create

back to summary

public static WebsocketClientTransport create(int port)

Creates a new instance connecting to localhost

Parameters

port:int: the port to connect to

Returns:WebsocketClientTransport

a new instance

create back to summary

create	back to summary
public static WebsocketClientTransport create(String bindAddress, int port) Creates a new instance Parameters bindAddress:String the address to connect to port:int the port to connect to Returns:WebsocketClientTransport a new instance Exceptions NullPointerException: if `bindAddress` is `null`

public static WebsocketClientTransport create(String bindAddress, int port)

Creates a new instance

Parameters

bindAddress:String: the address to connect to
port:int: the port to connect to

Returns:WebsocketClientTransport

a new instance

Exceptions

NullPointerException:: if bindAddress is null

create back to summary

create	back to summary
public static WebsocketClientTransport create(InetSocketAddress address) Creates a new instance Parameters address:InetSocketAddress the address to connect to Returns:WebsocketClientTransport a new instance Exceptions NullPointerException: if `address` is `null`

public static WebsocketClientTransport create(InetSocketAddress address)

Creates a new instance

Parameters

address:InetSocketAddress: the address to connect to

Returns:WebsocketClientTransport

a new instance

Exceptions

NullPointerException:: if address is null

create back to summary

create	back to summary
public static WebsocketClientTransport create(TcpClient client) Creates a new instance Parameters client:TcpClient the `TcpClient` to use Returns:WebsocketClientTransport a new instance Exceptions NullPointerException: if `client` or `path` is `null`

public static WebsocketClientTransport create(TcpClient client)

Creates a new instance

Parameters

client:TcpClient: the TcpClient to use

Returns:WebsocketClientTransport

a new instance

Exceptions

NullPointerException:: if client or path is null

create back to summary

create	back to summary
public static WebsocketClientTransport create(URI uri) Creates a new instance Parameters uri:URI the URI to connect to Returns:WebsocketClientTransport a new instance Exceptions NullPointerException: if `uri` is `null`

public static WebsocketClientTransport create(URI uri)

Creates a new instance

Parameters

uri:URI: the URI to connect to

Returns:WebsocketClientTransport

a new instance

Exceptions

NullPointerException:: if uri is null

create back to summary

create	back to summary
public static WebsocketClientTransport create(HttpClient client, String path) Creates a new instance Parameters client:HttpClient the `HttpClient` to use path:String the path to request Returns:WebsocketClientTransport a new instance Exceptions NullPointerException: if `client` or `path` is `null`

public static WebsocketClientTransport create(HttpClient client, String path)

Creates a new instance

Parameters

client:HttpClient: the HttpClient to use
path:String: the path to request

Returns:WebsocketClientTransport

a new instance

Exceptions

NullPointerException:: if client or path is null

header	back to summary
public WebsocketClientTransport header(String name, String... values) Add a header and value(s) to use for the WebSocket handshake request. Parameters name:String the header name values:String[] the header value(s) Returns:WebsocketClientTransport the same instance for method chaining Since 1.0.1

header

back to summary

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

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

Parameters

name:String: the header name
values:String[]: the header value(s)

Returns:WebsocketClientTransport

the same instance for method chaining

Since

1.0.1

maxFrameLength back to summary

maxFrameLength	back to summary
public int maxFrameLength() Overrides default io.rsocket.transport.Transport.maxFrameLength. Doc from io.rsocket.transport.Transport.maxFrameLength. Configurations that exposes the maximum frame size that a `DuplexConnection` can bring up to RSocket level. This number should not exist the 16,777,215 (maximum frame size specified by RSocket spec) Returns:int return maximum configured frame size limit Annotations @Override

public int maxFrameLength()

Overrides default io.rsocket.transport.Transport.maxFrameLength.

Doc from io.rsocket.transport.Transport.maxFrameLength.

Configurations that exposes the maximum frame size that a DuplexConnection can bring up to RSocket level.

This number should not exist the 16,777,215 (maximum frame size specified by RSocket spec)

Returns:int

return maximum configured frame size limit

Annotations

@Override

webSocketSpec back to summary

webSocketSpec	back to summary
public WebsocketClientTransport webSocketSpec(Consumer<WebsocketClientSpec.Builder> configurer) Provide a consumer to customize properties of the `WebsocketClientSpec` to use for WebSocket upgrades. The consumer is invoked immediately. Parameters configurer:Consumer<WebsocketClientSpec.Builder> the configurer to apply to the spec Returns:WebsocketClientTransport the same instance for method chaining Since 1.0.1

public WebsocketClientTransport webSocketSpec(Consumer<WebsocketClientSpec.Builder> configurer)

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

Parameters

configurer:Consumer<WebsocketClientSpec.Builder>: the configurer to apply to the spec

Returns:WebsocketClientTransport

the same instance for method chaining

Since

1.0.1

public final Class WebsocketClientTransport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail