Class MessageReader

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable, MessageSink

    public class MessageReader
    extends java.io.Reader
    implements MessageSink
    Support class for reading a (single) WebSocket TEXT message via a Reader.

    In compliance to the WebSocket spec, this reader always uses the StandardCharsets.UTF_8.

    • Field Summary

      • Fields inherited from class java.io.Reader

        lock
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(Frame frame, Callback callback)
      Consume the frame payload to the message.
      void close()  
      int read​(char[] cbuf, int off, int len)  
      • Methods inherited from class java.io.Reader

        mark, markSupported, nullReader, read, read, read, ready, 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()
      • MessageReader

        public MessageReader​(int bufferSize)
    • Method Detail

      • read

        public int read​(char[] cbuf,
                        int off,
                        int len)
                 throws java.io.IOException
        Specified by:
        read in class java.io.Reader
        Throws:
        java.io.IOException
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class java.io.Reader
        Throws:
        java.io.IOException
      • 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