Class MessageInputStream

java.lang.Object

java.io.InputStream

org.eclipse.jetty.websocket.common.message.MessageInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, MessageAppender

public class MessageInputStream
extends InputStream
implements MessageAppender

Support class for reading a (single) WebSocket BINARY message via a InputStream.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	MessageInputStream.State

Field Summary

Fields

Modifier and Type	Field	Description
private ByteBuffer	activeBuffer
private final org.eclipse.jetty.io.ByteBufferPool	bufferPool
private final BlockingDeque<ByteBuffer>	buffers
private static final ByteBuffer	EOF
private static final org.eclipse.jetty.util.log.Logger	LOG
private final Session	session
private MessageInputStream.State	state
private SuspendToken	suspendToken
private final long	timeoutMs

Constructor Summary

Constructors

Constructor	Description
MessageInputStream(Session session)
MessageInputStream(Session session, int timeoutMs)

Method Summary

Modifier and Type	Method	Description
private ByteBuffer	acquire(int capacity, boolean direct)
void	appendFrame(ByteBuffer framePayload, boolean fin)	Append the frame payload to the message.
void	close()
void	handlerComplete()
void	mark(int readlimit)
boolean	markSupported()
void	messageComplete()	Notification that message is to be considered complete.
int	read()
int	read(byte[] b, int off, int len)
void	reset()

Methods inherited from class InputStream

available, read, skip

Methods inherited from class Object

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

Field Details

LOG

private static final org.eclipse.jetty.util.log.Logger LOG

EOF

private static final ByteBuffer EOF

session

private final Session session

bufferPool

private final org.eclipse.jetty.io.ByteBufferPool bufferPool

buffers

private final BlockingDeque<ByteBuffer> buffers

timeoutMs

private final long timeoutMs

activeBuffer

private ByteBuffer activeBuffer

suspendToken

private SuspendToken suspendToken

state

private MessageInputStream.State state

Constructor Details

MessageInputStream

public MessageInputStream(Session session)

MessageInputStream

public MessageInputStream(Session session,
 int timeoutMs)

Method Details

appendFrame

public void appendFrame(ByteBuffer framePayload,
 boolean fin)
                 throws IOException

Description copied from interface: MessageAppender

Append the frame payload to the message.

Specified by:

appendFrame in interface MessageAppender

Parameters:

framePayload - the frame payload to append.

fin - flag indicating if this is the last part of the message or not.

Throws:

IOException - if unable to append the frame payload

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

handlerComplete

public void handlerComplete()

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

messageComplete

public void messageComplete()

Description copied from interface: MessageAppender

Notification that message is to be considered complete.

Any cleanup or final actions should be taken here.

Specified by:

messageComplete in interface MessageAppender

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

acquire

private ByteBuffer acquire(int capacity,
 boolean direct)