eu.luminis.websocket

Class Frame

java.lang.Object

eu.luminis.websocket.Frame

Direct Known Subclasses:

ControlFrame, DataFrame

public abstract class Frame
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIN_BIT_ON
static int	MASK_BIT_MASKED
static int	OPCODE_BINARY
static int	OPCODE_CLOSE
static int	OPCODE_CONT
static int	OPCODE_PING
static int	OPCODE_PONG
static int	OPCODE_TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Frame(int size)

Method Summary

Modifier and Type	Method and Description
byte[]	getFrameBytes()
protected abstract byte	getOpCode()
protected abstract byte[]	getPayload()
abstract int	getPayloadSize()
int	getSize()
abstract String	getTypeAsString()
boolean	isBinary()
boolean	isClose()
boolean	isControl()
boolean	isData()
boolean	isPing()
boolean	isPong()
boolean	isText()
protected static int	readFromStream(InputStream stream, byte[] buffer)
protected static int	readFromStream(InputStream stream, byte[] buffer, int offset, int expected, org.apache.log.Logger logger) Read from stream until expected number of bytes is read, or the stream is closed.
protected static int	readFromStream(InputStream stream, byte[] buffer, org.apache.log.Logger log) Read from stream until expected number of bytes is read, or the stream is closed.

Methods inherited from class java.lang.Object

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

Field Detail

OPCODE_CONT

public static final int OPCODE_CONT

See Also:

Constant Field Values

OPCODE_TEXT

public static final int OPCODE_TEXT

See Also:

Constant Field Values

OPCODE_BINARY

public static final int OPCODE_BINARY

See Also:

Constant Field Values

OPCODE_CLOSE

public static final int OPCODE_CLOSE

See Also:

Constant Field Values

OPCODE_PING

public static final int OPCODE_PING

See Also:

Constant Field Values

OPCODE_PONG

public static final int OPCODE_PONG

See Also:

Constant Field Values

FIN_BIT_ON

public static final int FIN_BIT_ON

See Also:

Constant Field Values

MASK_BIT_MASKED

public static final int MASK_BIT_MASKED

See Also:

Constant Field Values

Constructor Detail

Frame

protected Frame(int size)

Method Detail

getFrameBytes

public byte[] getFrameBytes()

readFromStream

protected static int readFromStream(InputStream stream,
                                    byte[] buffer)
                             throws IOException

Throws:

IOException

readFromStream

protected static int readFromStream(InputStream stream,
                                    byte[] buffer,
                                    org.apache.log.Logger log)
                             throws IOException

Read from stream until expected number of bytes is read, or the stream is closed. So, this method might block! (Note that this is the difference with java.io.BufferedInputStream: that reads as much as available.)

Parameters:

stream - the stream to read from

buffer - the buffer to write to

log - logger

Returns:

the number of bytes read

Throws:

IOException - if the underlying stream throws an IOException

readFromStream

protected static int readFromStream(InputStream stream,
                                    byte[] buffer,
                                    int offset,
                                    int expected,
                                    org.apache.log.Logger logger)
                             throws IOException

Read from stream until expected number of bytes is read, or the stream is closed. So, this method might block! (Note that this is the difference with java.io.BufferedInputStream: that reads as much as available.)

Parameters:

stream - the stream to read from

buffer - the buffer to write to

offset - the offset in the buffer

expected - the expected number of bytes to read

logger - logger

Returns:

the number of bytes read

Throws:

IOException - if the underlying stream throws an IOException

isData

public boolean isData()

isText

public boolean isText()

isBinary

public boolean isBinary()

isControl

public boolean isControl()

isClose

public boolean isClose()

isPing

public boolean isPing()

isPong

public boolean isPong()

getPayload

protected abstract byte[] getPayload()

getOpCode

protected abstract byte getOpCode()

getTypeAsString

public abstract String getTypeAsString()

getSize

public int getSize()

getPayloadSize

public abstract int getPayloadSize()