bayou.websocket

Class HotWebSocketHandler

java.lang.Object

bayou.websocket.HotWebSocketHandler

All Implemented Interfaces:

WebSocketHandler

public class HotWebSocketHandler
extends Object
implements WebSocketHandler

Hot-reloadable WebSocketHandler.

A hot handler is a "shell" that forwards handle(request) calls to the app handler that does the actual work. When source files are changed, a new app handler instance is created. Reloading is done by a HotReloader.

Typically a HotWebSocketHandler works together with a HotHttpHandler, and they should share the same HotReloader. For example:

     HotReloader reloader = new HotReloader().onJavaFiles(SRC_DIR);

     HotHttpHandler httpHandler = new HotHttpHandler(reloader, MyHttpHandler.class);

     HotWebSocketHandler wsHandler = new HotWebSocketHandler(reloader, MyWsHandler.class);
 

Constructor Summary

Constructors

Constructor and Description
HotWebSocketHandler(Class appHandlerClass) Create a hot handler.
HotWebSocketHandler(HotReloader reloader, Class appHandlerClass) Create a hot handler.
HotWebSocketHandler(HotReloader reloader, String appHandlerClassName) Create a hot handler.

Method Summary

Instance Methods
Async<WebSocketResponse>	handle(WebSocketRequest request) Handle a WebSocket request.
HotReloader	reloader() Get the HotReloader.
HotWebSocketHandler	onJavaFiles(String... srcDirs) Reload on java file changes.
HotWebSocketHandler	onClassFiles() Reload on class file changes.
HotWebSocketHandler	onFiles(String fileDesc, String filePattern, String... srcDirs) Reload on file changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

HotWebSocketHandler

public HotWebSocketHandler(Class appHandlerClass)

Create a hot handler.

This constructor is equivalent to HotWebSocketHandler( new HotReloader(), appHandlerClass.getName() ).

HotWebSocketHandler

public HotWebSocketHandler(HotReloader reloader,
                           Class appHandlerClass)

Create a hot handler.

This constructor is equivalent to HotWebSocketHandler( reloader, appHandlerClass.getName() ).

HotWebSocketHandler

public HotWebSocketHandler(HotReloader reloader,
                           String appHandlerClassName)

Create a hot handler.

The app handler class must implement WebSocketHandler and have a public 0-arg constructor.

Method Detail

handle

public Async<WebSocketResponse> handle(WebSocketRequest request)

Handle a WebSocket request.

This method obtains the app handler by reloader().getAppInstance(appHandlerClassName), then forwards the call to the app handler.

Specified by:

handle in interface WebSocketHandler

reloader

public HotReloader reloader()

Get the HotReloader.

onJavaFiles

public HotWebSocketHandler onJavaFiles(String... srcDirs)
                                throws Exception

Reload on java file changes.

This method is equivalent to reloader().onJavaFiles(srcDirs).

Returns:

this

Throws:

Exception

onClassFiles

public HotWebSocketHandler onClassFiles()

Reload on class file changes.

This method is equivalent to reloader().onClassFiles(srcDirs).

Returns:

this

onFiles

public HotWebSocketHandler onFiles(String fileDesc,
                                   String filePattern,
                                   String... srcDirs)

Reload on file changes.

This method is equivalent to reloader().onFiles(srcDirs).

Returns:

this