MessageReader

java.lang.Object

java.io.InputStreamReader

org.eclipse.jetty.websocket.common.message.MessageReader

All Implemented Interfaces:: Closeable, AutoCloseable, Readable, MessageAppender

public class MessageReader extends InputStreamReader implements MessageAppender

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

In compliance to the WebSocket spec, this reader always uses the UTF8 Charset.

Field Summary

Fields

Modifier and Type

Field

Description

private final MessageInputStream

stream

Fields inherited from class Reader
lock
Constructor Summary

Constructors

Constructor

Description

MessageReader(Session session)

MessageReader(MessageInputStream stream)
Method Summary

Modifier and Type

Method

Description

void

appendFrame(ByteBuffer payload, boolean isLast)

Append the frame payload to the message.

void

handlerComplete()

void

messageComplete()

Notification that message is to be considered complete.

Methods inherited from class InputStreamReader
close, getEncoding, read, read, ready

Methods inherited from class Reader
mark, markSupported, read, read, reset, skip

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- stream
  
  private final MessageInputStream stream
Constructor Details
- MessageReader
  
  public MessageReader(Session session)
- MessageReader
  
  public MessageReader(MessageInputStream stream)
Method Details
- appendFrame
  
  public void appendFrame(ByteBuffer payload, boolean isLast) throws IOException
  
  Description copied from interface: MessageAppender
  
  Append the frame payload to the message.
  
  Specified by:
  
  appendFrame in interface MessageAppender
  
  Parameters:
  
  payload - the frame payload to append.
  
  isLast - flag indicating if this is the last part of the message or not.
  
  Throws:
  
  IOException - if unable to append the frame payload
- 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
- handlerComplete
  
  public void handlerComplete()