Package org.eclipse.jetty.websocket.common.message

Class MessageReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable, MessageAppender
    public class MessageReader
extends java.io.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 inherited from class java.io.Reader

        lock

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendFrame​(java.nio.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 java.io.InputStreamReader

        close, getEncoding, read, read, ready

      • Methods inherited from class java.io.Reader

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MessageReader

        public MessageReader​(Session session)

    • Method Detail

      • appendFrame

        public void appendFrame​(java.nio.ByteBuffer payload,
                        boolean isLast)
                 throws java.io.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:
        java.io.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()