Class WsRoute

java.lang.Object

io.helidon.webserver.websocket.WsRoute

All Implemented Interfaces:

Route, ServerLifecycle

public class WsRoute
extends Object
implements Route

WebSocket route. Result of routing in WsRouting.findRoute(io.helidon.http.HttpPrologue).

Method Summary

Modifier and Type	Method	Description
static WsRoute	create(String path, WsListener listener)	Create a new WebSocket route for a specific path.
static WsRoute	create(String path, Supplier<? extends WsListener> listener)	Create a new WebSocket route for a specific path.
WsListener	listener()	WebSocket listener associated with this route.

Methods inherited from class Object

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

Methods inherited from interface ServerLifecycle

afterStart, afterStop, beforeStart

Modifier and Type	Method	Description
default void	afterStart(WebServer webServer)	After server start.
default void	afterStop()	After server stop.
default void	beforeStart()	Before server start.

Method Details

create

public static WsRoute create(String path,
 WsListener listener)

Create a new WebSocket route for a specific path.

Parameters:

path - path of the websocket endpoint

listener - listener instance to use for all connections

Returns:

a new route

create

public static WsRoute create(String path,
 Supplier<? extends WsListener> listener)

Create a new WebSocket route for a specific path.

Parameters:

path - path of the websocket endpoint

listener - supplier of listener instances, a new instance will be used for each connection

Returns:

a new route

listener

public WsListener listener()

WebSocket listener associated with this route.

Returns:

listener