Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.router

Interface WebSocketSubprotocolRoute<A>

Type Parameters:

A - the resource type

All Superinterfaces:

Route<A>

public interface WebSocketSubprotocolRoute<A>
extends Route<A>

A WebSocket subprotocol route.

This is used to define route based on the WebSocket subprotocol specified in an input. For instance, in order to resolve a handler for a WebSocket request with subprotocol json, a WebSocket subprotocol route must be defined with subprotocol json targeting a WSebSocket handler consuming and producing json messages.

Since:

1.12

Author:

Jeremy Kuhn

See Also:

• AuthorityRoutingLink

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebSocketSubprotocolRoute.Extractor<A,B extends WebSocketSubprotocolRoute<A>,C extends WebSocketSubprotocolRoute.Extractor<A,B,C>>	A WebSocket subprotocol route extractor.
static interface	WebSocketSubprotocolRoute.Manager<A,B,C extends WebSocketSubprotocolRoute<A>,D extends WebSocketSubprotocolRoute.Manager<A,B,C,D,E>,E extends Router<A,B,C,D,E>>	A WebSocket subprotocol route manager.

Method Summary

Modifier and Type	Method	Description
String	getSubprotocol()	Returns a WebSocket subprotocol.

Methods inherited from interface io.inverno.mod.http.base.router.Route

disable, enable, get, get, isDisabled, remove

Method Details

getSubprotocol

String getSubprotocol()

Returns a WebSocket subprotocol.

Returns:

a WebSocket subprotocol or null