Class MessageInputStream

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

    public class MessageInputStream
    extends java.io.InputStream
    implements MessageSink
    Support class for reading a WebSocket BINARY message via a InputStream.

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

    • 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()  
      int read​(byte[] b, int off, int len)  
      int read​(java.nio.ByteBuffer buffer)  
      void setTimeout​(long timeoutMs)  
      • Methods inherited from class java.io.InputStream

        available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MessageInputStream

        public MessageInputStream()
    • Method Detail

      • 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
      • read

        public int read()
                 throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
      • read

        public int read​(byte[] b,
                        int off,
                        int len)
                 throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
      • read

        public int read​(java.nio.ByteBuffer buffer)
                 throws java.io.IOException
        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
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException
      • setTimeout

        public void setTimeout​(long timeoutMs)