Package robaho.net.httpserver.websockets

Class WebSocket

java.lang.Object

robaho.net.httpserver.websockets.WebSocket

Direct Known Subclasses:

BufferedWebSocket

public abstract class WebSocket
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocket(HttpExchange exchange)

Method Summary

Modifier and Type	Method	Description
void	close(CloseCode code, String reason, boolean initiatedByRemote)
boolean	isOpen()
protected abstract void	onClose(CloseCode code, String reason, boolean initiatedByRemote)
protected void	onException(IOException exception)
protected void	onFrameReceived(WebSocketFrame frame)
protected void	onFrameSent(WebSocketFrame frame)	Debug method.
protected abstract void	onMessage(WebSocketFrame message)
protected void	onOpen()
protected abstract void	onPong(WebSocketFrame pong)
void	ping(byte[] payload)
void	send(byte[] payload)
void	send(String payload)
void	sendFrame(WebSocketFrame frame)

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocket

protected WebSocket(HttpExchange exchange)

Method Details

isOpen

public boolean isOpen()

onOpen

protected void onOpen()
               throws WebSocketException

Throws:

WebSocketException

onClose

protected abstract void onClose(CloseCode code,
 String reason,
 boolean initiatedByRemote)

onMessage

protected abstract void onMessage(WebSocketFrame message)
                           throws WebSocketException

Throws:

WebSocketException

onPong

protected abstract void onPong(WebSocketFrame pong)
                        throws WebSocketException

Throws:

WebSocketException

onException

protected void onException(IOException exception)

onFrameReceived

protected void onFrameReceived(WebSocketFrame frame)

onFrameSent

protected void onFrameSent(WebSocketFrame frame)

Debug method. Do not Override unless for debug purposes!
This method is called before actually sending the frame.

Parameters:

frame - The sent WebSocket Frame.

close

public void close(CloseCode code,
 String reason,
 boolean initiatedByRemote)
           throws IOException

Throws:

IOException

ping

public void ping(byte[] payload)
          throws IOException

Throws:

IOException

send

public void send(byte[] payload)
          throws IOException

Throws:

IOException

send

public void send(String payload)
          throws IOException

Throws:

IOException

sendFrame

public void sendFrame(WebSocketFrame frame)
               throws IOException

Throws:

IOException