ninja.websockets

Interface WebSockets

All Known Implementing Classes:

DefaultWebSockets

public interface WebSockets

Interface for implementations of web sockets in Ninja. Any interaction Ninja requires for enabling web sockets will be done thru this interface.

Author:

jjlauer

Method Summary

Modifier and Type	Method and Description
void	compileRoute(Route route) Configure the container for the websocket route.
boolean	isEnabled() If WebSocket support is detected and enabled by the underlying container.

Method Detail

isEnabled

boolean isEnabled()

If WebSocket support is detected and enabled by the underlying container. If true then any websocket routes should successfully configure.

Returns:

True or false if websockets are available.

compileRoute

void compileRoute(Route route)

Configure the container for the websocket route.

Parameters:

route - The websocket route