Class MessageInputStream

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

    public class MessageInputStream
    extends java.io.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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendFrame​(java.nio.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, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, 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()
      • MessageInputStream

        public MessageInputStream​(int timeoutMs)
    • Method Detail

      • appendFrame

        public void appendFrame​(java.nio.ByteBuffer framePayload,
                                boolean fin)
                         throws java.io.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:
        java.io.IOException - if unable to append the frame payload
      • 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
      • mark

        public void mark​(int readlimit)
        Overrides:
        mark in class java.io.InputStream
      • markSupported

        public boolean markSupported()
        Overrides:
        markSupported in class java.io.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 java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
      • reset

        public void reset()
                   throws java.io.IOException
        Overrides:
        reset in class java.io.InputStream
        Throws:
        java.io.IOException