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

Class MessageInputStream

java.lang.Object

java.io.InputStream

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

All Implemented Interfaces:

Closeable, AutoCloseable, MessageSink

public class MessageInputStream
extends InputStream
implements MessageSink

Support class for reading a WebSocket BINARY message via a InputStream.

An InputStream that can access a queue of ByteBuffer payloads, along with expected InputStream blocking behavior.

Constructor Summary

Constructors

Constructor	Description
MessageInputStream()

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()
int	read(byte[] b, int off, int len)
int	read(ByteBuffer buffer)
void	setTimeout(long timeoutMs)

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

MessageInputStream

public MessageInputStream()

Method Details

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(ByteBuffer buffer)
         throws IOException

Throws:

IOException

setTimeout

public void setTimeout(long timeoutMs)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

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.