org.eclipse.jetty.websocket
Class WebSocketParserD13

java.lang.Object
  org.eclipse.jetty.websocket.WebSocketParserD13

All Implemented Interfaces:

WebSocketParser

public class WebSocketParserD13
extends Object
implements WebSocketParser

Parser the WebSocket protocol.

Nested Class Summary

static class

WebSocketParserD13.State

Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.WebSocketParser

WebSocketParser.FrameHandler

Constructor Summary

WebSocketParserD13(WebSocketBuffers buffers, EndPoint endp, WebSocketParser.FrameHandler handler, boolean shouldBeMasked)

Method Summary

void	fill(Buffer buffer)
Buffer	getBuffer()
boolean	isBufferEmpty()
boolean	isFakeFragments()
int	parseNext() Parse to next event.
void	returnBuffer()
void	setFakeFragments(boolean fakeFragments)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketParserD13

public WebSocketParserD13(WebSocketBuffers buffers,
                          EndPoint endp,
                          WebSocketParser.FrameHandler handler,
                          boolean shouldBeMasked)

Parameters:

buffers - The buffers to use for parsing. Only the Buffers.getBuffer() is used. This should be a direct buffer if binary data is mostly used or an indirect buffer if utf-8 data is mostly used.

endp - the endpoint

handler - the handler to notify when a parse event occurs

shouldBeMasked - whether masking should be handled

Method Detail

isFakeFragments

public boolean isFakeFragments()

Returns:

True if fake fragments should be created for frames larger than the buffer.

setFakeFragments

public void setFakeFragments(boolean fakeFragments)

Parameters:

fakeFragments - True if fake fragments should be created for frames larger than the buffer.

isBufferEmpty

public boolean isBufferEmpty()

Specified by:

isBufferEmpty in interface WebSocketParser

getBuffer

public Buffer getBuffer()

Specified by:

getBuffer in interface WebSocketParser

parseNext

public int parseNext()

Parse to next event. Parse to the next WebSocketParser.FrameHandler event or until no more data is available. Fill data from the EndPoint only as necessary.

Specified by:

parseNext in interface WebSocketParser

Returns:

An indication of progress or otherwise. -1 indicates EOF, 0 indicates that no bytes were read and no messages parsed. A positive number indicates either the bytes filled or the messages parsed.

fill

public void fill(Buffer buffer)

Specified by:

fill in interface WebSocketParser

returnBuffer

public void returnBuffer()

toString

public String toString()

Overrides:

toString in class Object