org.eclipse.jetty.websocket.common.message

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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	appendFrame(ByteBuffer framePayload, boolean fin) Append the frame payload to the message.
void	close()
void	mark(int readlimit)
boolean	markSupported()
void	messageComplete() Notification that message is to be considered complete.
int	read()
void	reset()

Methods inherited from class java.io.InputStream

available, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageInputStream

public MessageInputStream(Session session)

MessageInputStream

public MessageInputStream(Session session,
                          int timeoutMs)

Method Detail

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 Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException