io.rsocket.transport.netty.server

Class WebsocketServerTransport

java.lang.Object

io.rsocket.transport.netty.server.WebsocketServerTransport

All Implemented Interfaces:

io.rsocket.transport.ServerTransport<CloseableChannel>, io.rsocket.transport.Transport, io.rsocket.transport.TransportHeaderAware

public final class WebsocketServerTransport
extends Object
implements io.rsocket.transport.TransportHeaderAware

An implementation of ServerTransport that connects to a ClientTransport via a Websocket.

Nested Class Summary

Nested classes/interfaces inherited from interface io.rsocket.transport.ServerTransport

io.rsocket.transport.ServerTransport.ConnectionAcceptor

Method Summary

Modifier and Type	Method and Description
static WebsocketServerTransport	create(reactor.netty.http.server.HttpServer server) Creates a new instance
static WebsocketServerTransport	create(InetSocketAddress address) Creates a new instance
static WebsocketServerTransport	create(int port) Creates a new instance binding to localhost
static WebsocketServerTransport	create(String bindAddress, int port) Creates a new instance
WebsocketServerTransport	header(String name, String... values) Add a header and value(s) to set on the response of WebSocket handshakes.
int	maxFrameLength()
void	setTransportHeaders(Supplier<Map<String,String>> transportHeaders)
Mono<CloseableChannel>	start(io.rsocket.transport.ServerTransport.ConnectionAcceptor acceptor)
SELF	webSocketSpec(Consumer<reactor.netty.http.server.WebsocketServerSpec.Builder> configurer) Provide a consumer to customize properties of the WebsocketServerSpec 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 WebsocketServerTransport create(int port)

Creates a new instance binding to localhost

Parameters:

port - the port to bind to

Returns:

a new instance

create

public static WebsocketServerTransport create(String bindAddress,
                                              int port)

Creates a new instance

Parameters:

bindAddress - the address to bind to

port - the port to bind to

Returns:

a new instance

Throws:

NullPointerException - if bindAddress is null

create

public static WebsocketServerTransport create(InetSocketAddress address)

Creates a new instance

Parameters:

address - the address to bind to

Returns:

a new instance

Throws:

NullPointerException - if address is null

create

public static WebsocketServerTransport create(reactor.netty.http.server.HttpServer server)

Creates a new instance

Parameters:

server - the HttpServer to use

Returns:

a new instance

Throws:

NullPointerException - if server is null

header

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

Add a header and value(s) to set on the response of WebSocket handshakes.

Parameters:

name - the header name

values - the header value(s)

Returns:

the same instance for method chaining

Since:

1.0.1

setTransportHeaders

public void setTransportHeaders(Supplier<Map<String,String>> transportHeaders)

Specified by:

setTransportHeaders in interface io.rsocket.transport.TransportHeaderAware

start

public Mono<CloseableChannel> start(io.rsocket.transport.ServerTransport.ConnectionAcceptor acceptor)

Specified by:

start in interface io.rsocket.transport.ServerTransport<CloseableChannel>

webSocketSpec

public SELF webSocketSpec(Consumer<reactor.netty.http.server.WebsocketServerSpec.Builder> configurer)

Provide a consumer to customize properties of the WebsocketServerSpec 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