Class WsRouting

java.lang.Object

io.helidon.webserver.websocket.WsRouting

All Implemented Interfaces:

Routing, ServerLifecycle

public class WsRouting
extends Object
implements Routing

WebSocket specific routing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WsRouting.Builder	Fluent API builder for WsRouting.

Method Summary

Modifier and Type	Method	Description
void	afterStop()	After server stop.
void	beforeStart()	Before server start.
static WsRouting.Builder	builder()	Builder for WebSocket routing.
static WsRouting	empty()	Empty WebSocket routing.
WsRoute	findRoute(HttpPrologue prologue)	Find a route based on the provided prologue.
Class<? extends Routing>	routingType()	The class used by a Router to identify this Routing type and associate a connection with it.

Methods inherited from class Object

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

Methods inherited from interface ServerLifecycle

afterStart

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

Method Details

builder

public static WsRouting.Builder builder()

Builder for WebSocket routing.

Returns:

new builder

empty

public static WsRouting empty()

Empty WebSocket routing.

Returns:

empty routing

routingType

public Class<? extends Routing> routingType()

Description copied from interface: Routing

The class used by a Router to identify this Routing type and associate a connection with it.

Specified by:

routingType in interface Routing

Returns:

this routing type

beforeStart

public void beforeStart()

Description copied from interface: ServerLifecycle

Before server start. If this method throws an exception, server startup fails and the server attempts startup cleanup.

Specified by:

beforeStart in interface ServerLifecycle

afterStop

public void afterStop()

Description copied from interface: ServerLifecycle

After server stop. Exceptions thrown by this method fail WebServer.stop() after listener cleanup has been attempted. If this method is invoked during startup cleanup, exceptions may fail WebServer.start(). If this method is invoked during suspend or resume failure cleanup, exceptions may be suppressed on the original suspend or resume failure.

Specified by:

afterStop in interface ServerLifecycle

findRoute

public WsRoute findRoute(HttpPrologue prologue)

Find a route based on the provided prologue.

Parameters:

prologue - prologue with path and other request information

Returns:

found route