ej.websocket.frame

Class FrameScanner

java.lang.Object

ej.websocket.frame.FrameScanner

public class FrameScanner
extends Object

A FrameScanner keeps reading the InputStream (which is supposed to be the input stream of a WebSocket. Each time the getFrame() method is called, it tries to create a RawFrame from bytes that arrived on the input stream.

Constructor Summary

Constructors

Constructor and Description
FrameScanner(InputStream is) Create a new FrameScanner for the given InputStream.

Method Summary

Modifier and Type	Method and Description
RawFrame	getFrame() Get a complete frame from the input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameScanner

public FrameScanner(InputStream is)

Create a new FrameScanner for the given InputStream.

Parameters:

is - the input stream to read from. It is supposed to be the stream of a WebSocket

Method Detail

getFrame

public RawFrame getFrame()
                  throws IOException,
                         WebSocketException

Get a complete frame from the input stream. This method will block until a frame is completely received or an IOException occurs.

Returns:

a websocket frame as a byte array

Throws:

IOException - if an IOException is encountered by the input stream

WebSocketException - if the frame is invalid.