Class NanoWSD.WebSocket

java.lang.Object

fi.iki.elonen.NanoWSD.WebSocket

Direct Known Subclasses:

DebugWebSocketServer.DebugWebSocket

Enclosing class:

NanoWSD

public abstract static class NanoWSD.WebSocket
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final List<NanoWSD.WebSocketFrame>	continuousFrames
private NanoWSD.WebSocketFrame.OpCode	continuousOpCode
private final NanoHTTPD.IHTTPSession	handshakeRequest
private final NanoHTTPD.Response	handshakeResponse
private final InputStream	in
private OutputStream	out
private NanoWSD.State	state

Constructor Summary

Constructors

Constructor	Description
WebSocket(NanoHTTPD.IHTTPSession handshakeRequest)

Method Summary

Modifier and Type	Method	Description
void	close(NanoWSD.WebSocketFrame.CloseCode code, String reason, boolean initiatedByRemote)
protected void	debugFrameReceived(NanoWSD.WebSocketFrame frame)	Debug method.
protected void	debugFrameSent(NanoWSD.WebSocketFrame frame)	Debug method.
private void	doClose(NanoWSD.WebSocketFrame.CloseCode code, String reason, boolean initiatedByRemote)
NanoHTTPD.IHTTPSession	getHandshakeRequest()
NanoHTTPD.Response	getHandshakeResponse()
private void	handleCloseFrame(NanoWSD.WebSocketFrame frame)
private void	handleFrameFragment(NanoWSD.WebSocketFrame frame)
private void	handleWebsocketFrame(NanoWSD.WebSocketFrame frame)
boolean	isOpen()
protected abstract void	onClose(NanoWSD.WebSocketFrame.CloseCode code, String reason, boolean initiatedByRemote)
protected abstract void	onException(IOException exception)
protected abstract void	onMessage(NanoWSD.WebSocketFrame message)
protected abstract void	onOpen()
protected abstract void	onPong(NanoWSD.WebSocketFrame pong)
void	ping(byte[] payload)
private void	readWebsocket()
void	send(byte[] payload)
void	send(String payload)
void	sendFrame(NanoWSD.WebSocketFrame frame)

Methods inherited from class Object

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

Field Details

in

private final InputStream in

out

private OutputStream out

continuousOpCode

private NanoWSD.WebSocketFrame.OpCode continuousOpCode

continuousFrames

private final List<NanoWSD.WebSocketFrame> continuousFrames

state

private NanoWSD.State state

handshakeRequest

private final NanoHTTPD.IHTTPSession handshakeRequest

handshakeResponse

private final NanoHTTPD.Response handshakeResponse

Constructor Details

WebSocket

public WebSocket(NanoHTTPD.IHTTPSession handshakeRequest)

Method Details

isOpen

public boolean isOpen()

onOpen

protected abstract void onOpen()

onClose

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

onMessage

protected abstract void onMessage(NanoWSD.WebSocketFrame message)

onPong

protected abstract void onPong(NanoWSD.WebSocketFrame pong)

onException

protected abstract void onException(IOException exception)

debugFrameReceived

protected void debugFrameReceived(NanoWSD.WebSocketFrame frame)

Debug method. Do not Override unless for debug purposes!

Parameters:

frame - The received WebSocket Frame.

debugFrameSent

protected void debugFrameSent(NanoWSD.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(NanoWSD.WebSocketFrame.CloseCode code,
 String reason,
 boolean initiatedByRemote)
           throws IOException

Throws:

IOException

doClose

private void doClose(NanoWSD.WebSocketFrame.CloseCode code,
 String reason,
 boolean initiatedByRemote)

getHandshakeRequest

public NanoHTTPD.IHTTPSession getHandshakeRequest()

getHandshakeResponse

public NanoHTTPD.Response getHandshakeResponse()

handleCloseFrame

private void handleCloseFrame(NanoWSD.WebSocketFrame frame)
                       throws IOException

Throws:

IOException

handleFrameFragment

private void handleFrameFragment(NanoWSD.WebSocketFrame frame)
                          throws IOException

Throws:

IOException

handleWebsocketFrame

private void handleWebsocketFrame(NanoWSD.WebSocketFrame frame)
                           throws IOException

Throws:

IOException

ping

public void ping(byte[] payload)
          throws IOException

Throws:

IOException

readWebsocket

private void readWebsocket()

send

public void send(byte[] payload)
          throws IOException

Throws:

IOException

send

public void send(String payload)
          throws IOException

Throws:

IOException

sendFrame

public void sendFrame(NanoWSD.WebSocketFrame frame)
               throws IOException

Throws:

IOException