Package net.targetr.rc.client

Class ClientWebSocketHandler

java.lang.Object

net.targetr.rc.client.ClientWebSocketHandler

All Implemented Interfaces:

SocketExceptionHandler

public class ClientWebSocketHandler
extends Object
implements SocketExceptionHandler

Communicates with a client using a WebSocket.

Author:

Dr Michael Gardiner

Field Summary

Fields

Modifier and Type	Field	Description
static final AtomicInteger	clientCount	Counter for connected clients.
static final long	IDLE_PERIOD	Maximum idle period before checking connection status.
static final int	TIMEOUT	WebSocket connection timeout in milliseconds.

Constructor Summary

Constructors

Constructor	Description
ClientWebSocketHandler(HttpRequest httpReq)	Constructs a new WebSocket handler for the given request.

Method Summary

Modifier and Type	Method	Description
HttpResponse	generateResponse()	Completes the WebSocket handshake and manages the live connection.
void	handleException(Exception ex)	Adds support to a HttpResponder for capturing an exception during write.

Methods inherited from class java.lang.Object

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

Field Details

TIMEOUT

public static final int TIMEOUT

WebSocket connection timeout in milliseconds.

See Also:

• Constant Field Values

IDLE_PERIOD

public static final long IDLE_PERIOD

Maximum idle period before checking connection status.

See Also:

• Constant Field Values

clientCount

public static final AtomicInteger clientCount

Counter for connected clients.

Constructor Details

ClientWebSocketHandler

public ClientWebSocketHandler(HttpRequest httpReq)

Constructs a new WebSocket handler for the given request.

Parameters:

httpReq - the incoming HTTP upgrade request

Method Details

generateResponse

public HttpResponse generateResponse()
                              throws IOException,
NoSuchAlgorithmException

Completes the WebSocket handshake and manages the live connection.

Returns:

an HTTP response for the protocol upgrade

Throws:

IOException - if network communication fails

NoSuchAlgorithmException - if handshake hashing fails

handleException

public void handleException(Exception ex)

Description copied from interface: SocketExceptionHandler

Adds support to a HttpResponder for capturing an exception during write.

Specified by:

handleException in interface SocketExceptionHandler

Parameters:

ex - an exception occurred while sending data to client.