Top Description Fields Constructors Methods

org.glassfish.grizzly.websockets

public Class DataFrame

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.websockets.DataFrame

Known Direct Subclasses

org.glassfish.grizzly.websockets.ClosingFrame

Imports

java.io.IOException, .OutputStream, org.glassfish.grizzly.utils.Charsets

In memory representation of a websocket frame.

See Also: Frame Definition

Field Summary

Modifier and Type	Field and Description
private byte[]	bytes
private boolean	last
private String	payload
private final FrameType	type

Constructor Summary

Access	Constructor and Description
public	DataFrame(FrameType type)
public	DataFrame(FrameType type, String data)
public	DataFrame(FrameType type, String data, boolean fin)
public	DataFrame(FrameType type, byte[] data)
public	DataFrame(FrameType type, byte[] data, boolean fin)

Method Summary

Modifier and Type	Method and Description
public byte[]	getBytes()
public String	getTextPayload()
public FrameType	getType()
public static boolean	isDataFrame(final Object o)
public boolean	isLast()
public void	respond(WebSocket socket)
public void	setLast(boolean last)
public final void	setPayload(String payload)
public void	setPayload(byte[] bytes)
public void	toStream(final OutputStream os)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

bytes	back to summary
private byte[] bytes

last	back to summary
private boolean last

payload	back to summary
private String payload

type	back to summary
private final FrameType type

Constructor Detail

DataFrame	back to summary
public DataFrame(FrameType type)

DataFrame	back to summary
public DataFrame(FrameType type, String data)

DataFrame	back to summary
public DataFrame(FrameType type, String data, boolean fin)

DataFrame	back to summary
public DataFrame(FrameType type, byte[] data)

DataFrame	back to summary
public DataFrame(FrameType type, byte[] data, boolean fin)

Method Detail

getBytes	back to summary
public byte[] getBytes()

getTextPayload	back to summary
public String getTextPayload()

getType	back to summary
public FrameType getType()

isDataFrame	back to summary
public static boolean isDataFrame(final Object o)

isLast	back to summary
public boolean isLast()

respond	back to summary
public void respond(WebSocket socket)

setLast	back to summary
public void setLast(boolean last)

setPayload	back to summary
public final void setPayload(String payload)

setPayload	back to summary
public void setPayload(byte[] bytes)

toStream	back to summary
public void toStream(final OutputStream os) throws IOException

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override