Package org.eclipse.jetty.websocket.core.internal.messages

Class MessageReader

java.lang.Object

java.io.Reader

org.eclipse.jetty.websocket.core.internal.messages.MessageReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable, MessageSink

public class MessageReader
extends Reader
implements MessageSink

Support class for reading a (single) WebSocket TEXT message via a Reader.

In compliance to the WebSocket spec, this reader always uses the StandardCharsets.UTF_8.

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor	Description
MessageReader()
MessageReader(int bufferSize)

Method Summary

Modifier and Type	Method	Description
void	accept(Frame frame, Callback callback)	Consume the frame payload to the message.
void	close()
void	fail(Throwable failure)	Fail the message sink.
int	read(char[] cbuf, int off, int len)

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, read, ready, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

MessageReader

public MessageReader()

MessageReader

public MessageReader(int bufferSize)

Method Details

read

public int read(char[] cbuf,
 int off,
 int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

fail

public void fail(Throwable failure)

Description copied from interface: MessageSink

Fail the message sink.

Release any resources and fail all stored callbacks as MessageSink.accept(Frame, Callback) will never be called again.

Specified by:

fail in interface MessageSink

Parameters:

failure - the failure that occurred.

accept

public void accept(Frame frame,
 Callback callback)

Description copied from interface: MessageSink

Consume the frame payload to the message.

Specified by:

accept in interface MessageSink

Parameters:

frame - the frame, its payload (and fin state) to append

callback - the callback for how the frame was consumed