io.muserver

Class WebSocketHandler

java.lang.Object

io.muserver.WebSocketHandler

All Implemented Interfaces:

MuHandler

public class WebSocketHandler
extends Object
implements MuHandler

A handler that can establish a web socket based on web socket upgrade requests. Create with WebSocketHandlerBuilder.webSocketHandler()

Method Summary

Modifier and Type	Method and Description
boolean	handle(MuRequest request, MuResponse response) Called when an HTTP request is made (unless a previous handler stopped handler processing)

Methods inherited from class java.lang.Object

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

Method Detail

handle

public boolean handle(MuRequest request,
                      MuResponse response)
               throws Exception

Description copied from interface: MuHandler

Called when an HTTP request is made (unless a previous handler stopped handler processing)

Specified by:

handle in interface MuHandler

Parameters:

request - The HTTP request.

response - The HTTP response.

Returns:

Return false to continue processing the next handler (for example if writing a filter or inspector); or true to stop processing (normally done if this handler sent a response).

Throws:

Exception - Any uncaught exceptions will result in a 500 error code being returned to the client with a simple message.