dev.rafex.ether.websocket.jetty12.JettyWebSocketModule Interface Reference

SPI contract for WebSocket modules that register endpoint routes. More...

Collaboration diagram for dev.rafex.ether.websocket.jetty12.JettyWebSocketModule:

Public Member Functions
default void	registerRoutes (final JettyWebSocketRouteRegistry routes, final JettyWebSocketModuleContext context)
	Registers WebSocket routes on the given registry.

Detailed Description

SPI contract for WebSocket modules that register endpoint routes.

Implementations define which WebSocket endpoints the application exposes by calling JettyWebSocketRouteRegistry#add inside registerRoutes. The framework invokes this method once during server bootstrap, passing the shared registry and a read-only context.

Definition at line 37 of file JettyWebSocketModule.java.

Member Function Documentation

registerRoutes()

default void dev.rafex.ether.websocket.jetty12.JettyWebSocketModule.registerRoutes	(	final JettyWebSocketRouteRegistry	routes,
		final JettyWebSocketModuleContext	context )

Registers WebSocket routes on the given registry.

The default implementation is a no-op, so modules only need to override this method when they expose actual endpoints.

Parameters

routes	the route registry to register endpoints on
context	the module context providing server configuration

Definition at line 48 of file JettyWebSocketModule.java.

References dev.rafex.ether.websocket.jetty12.JettyWebSocketModuleContext().

Here is the call graph for this function:

---

The documentation for this interface was generated from the following file:

• ether-websocket-jetty12/ether-websocket-jetty12/src/main/java/dev/rafex/ether/websocket/jetty12/JettyWebSocketModule.java