com.predic8.membrane.core.transport.ws

Class WebSocketFrame

java.lang.Object

com.predic8.membrane.core.transport.ws.WebSocketFrame

public class WebSocketFrame
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
WebSocketFrame()
WebSocketFrame(boolean fin, boolean rsv1, boolean rsv2, boolean rsv3, int opcode, boolean isMasked, byte[] maskingKey, byte[] payload)

Method Summary

Modifier and Type	Method and Description
byte[]	getMaskKey()
int	getOpcode()
Exchange	getOriginalExchange()
byte[]	getPayload()
long	getPayloadLength()
boolean	isMasked()
void	setMasked(boolean masked)
void	setMaskKey(byte[] maskKey)
void	setOpcode(int opcode)
void	setOriginalExchange(Exchange originalExchange)
void	setPayload(byte[] payload)
void	setPayloadLength(long payloadLength)
byte[]	toBytes()
String	toString()
String	toStringHex()
int	tryRead(byte[] buffer, int offset, int length)
void	write(OutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.slf4j.Logger log

Constructor Detail

WebSocketFrame

public WebSocketFrame()

WebSocketFrame

public WebSocketFrame(boolean fin,
                      boolean rsv1,
                      boolean rsv2,
                      boolean rsv3,
                      int opcode,
                      boolean isMasked,
                      byte[] maskingKey,
                      byte[] payload)

Method Detail

write

public void write(OutputStream out)
           throws IOException

Throws:

IOException

getOpcode

public int getOpcode()

setOpcode

public void setOpcode(int opcode)

isMasked

public boolean isMasked()

setMasked

public void setMasked(boolean masked)

getPayloadLength

public long getPayloadLength()

setPayloadLength

public void setPayloadLength(long payloadLength)

getMaskKey

public byte[] getMaskKey()

setMaskKey

public void setMaskKey(byte[] maskKey)

getPayload

public byte[] getPayload()

setPayload

public void setPayload(byte[] payload)

tryRead

public int tryRead(byte[] buffer,
                   int offset,
                   int length)

Parameters:

buffer -

offset -

length -

Returns:

the number of bytes read. if > 0, this class has been properly initialized with the frame data read.

toString

public String toString()

Overrides:

toString in class Object

toStringHex

public String toStringHex()

toBytes

public byte[] toBytes()
               throws IOException

Throws:

IOException

getOriginalExchange

public Exchange getOriginalExchange()

setOriginalExchange

public void setOriginalExchange(Exchange originalExchange)