Class SessionOutputBufferImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      Returns available space in the buffer.
      void bind​(java.io.OutputStream outStream)  
      int capacity()
      Returns total capacity of the buffer
      void flush()
      Flushes this session buffer and forces any buffered output bytes to be written out.
      private void flushBuffer()  
      private void flushStream()  
      HttpTransportMetrics getMetrics()
      Returns HttpTransportMetrics for this session buffer.
      private void handleEncodingResult​(java.nio.charset.CoderResult result)  
      boolean isBound()  
      int length()
      Return length data stored in the buffer
      private void streamWrite​(byte[] b, int off, int len)  
      void write​(byte[] b)
      Writes b.length bytes from the specified byte array to this session buffer.
      void write​(byte[] b, int off, int len)
      Writes len bytes from the specified byte array starting at offset off to this session buffer.
      void write​(int b)
      Writes the specified byte to this session buffer.
      private void writeEncoded​(java.nio.CharBuffer cbuf)  
      void writeLine​(java.lang.String s)
      Writes characters from the specified string followed by a line delimiter to this session buffer.
      void writeLine​(CharArrayBuffer charbuffer)
      Writes characters from the specified char array followed by a line delimiter to this session buffer.
      • Methods inherited from class java.lang.Object

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

      • CRLF

        private static final byte[] CRLF
      • fragementSizeHint

        private final int fragementSizeHint
      • encoder

        private final java.nio.charset.CharsetEncoder encoder
      • outStream

        private java.io.OutputStream outStream
      • bbuf

        private java.nio.ByteBuffer bbuf
    • Constructor Detail

      • SessionOutputBufferImpl

        public SessionOutputBufferImpl​(HttpTransportMetricsImpl metrics,
                                       int bufferSize,
                                       int fragementSizeHint,
                                       java.nio.charset.CharsetEncoder charEncoder)
        Creates new instance of SessionOutputBufferImpl.
        Parameters:
        metrics - HTTP transport metrics.
        bufferSize - buffer size. Must be a positive number.
        fragementSizeHint - fragment size hint defining a minimal size of a fragment that should be written out directly to the socket bypassing the session buffer. Value 0 disables fragment buffering.
        charEncoder - charEncoder to be used for encoding HTTP protocol elements. If null simple type cast will be used for char to byte conversion.
    • Method Detail

      • bind

        public void bind​(java.io.OutputStream outStream)
      • isBound

        public boolean isBound()
      • capacity

        public int capacity()
        Description copied from interface: BufferInfo
        Returns total capacity of the buffer
        Specified by:
        capacity in interface BufferInfo
        Returns:
        total capacity
      • length

        public int length()
        Description copied from interface: BufferInfo
        Return length data stored in the buffer
        Specified by:
        length in interface BufferInfo
        Returns:
        data length
      • available

        public int available()
        Description copied from interface: BufferInfo
        Returns available space in the buffer.
        Specified by:
        available in interface BufferInfo
        Returns:
        available space.
      • streamWrite

        private void streamWrite​(byte[] b,
                                 int off,
                                 int len)
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • flushStream

        private void flushStream()
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • flushBuffer

        private void flushBuffer()
                          throws java.io.IOException
        Throws:
        java.io.IOException
      • flush

        public void flush()
                   throws java.io.IOException
        Description copied from interface: SessionOutputBuffer
        Flushes this session buffer and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.
        Specified by:
        flush in interface SessionOutputBuffer
        Throws:
        java.io.IOException - if an I/O error occurs.
      • write

        public void write​(byte[] b,
                          int off,
                          int len)
                   throws java.io.IOException
        Description copied from interface: SessionOutputBuffer
        Writes len bytes from the specified byte array starting at offset off to this session buffer.

        If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

        Specified by:
        write in interface SessionOutputBuffer
        Parameters:
        b - the data.
        off - the start offset in the data.
        len - the number of bytes to write.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • write

        public void write​(byte[] b)
                   throws java.io.IOException
        Description copied from interface: SessionOutputBuffer
        Writes b.length bytes from the specified byte array to this session buffer.
        Specified by:
        write in interface SessionOutputBuffer
        Parameters:
        b - the data.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • write

        public void write​(int b)
                   throws java.io.IOException
        Description copied from interface: SessionOutputBuffer
        Writes the specified byte to this session buffer.
        Specified by:
        write in interface SessionOutputBuffer
        Parameters:
        b - the byte.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • writeLine

        public void writeLine​(java.lang.String s)
                       throws java.io.IOException
        Writes characters from the specified string followed by a line delimiter to this session buffer.

        This method uses CR-LF as a line delimiter.

        Specified by:
        writeLine in interface SessionOutputBuffer
        Parameters:
        s - the line.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • writeLine

        public void writeLine​(CharArrayBuffer charbuffer)
                       throws java.io.IOException
        Writes characters from the specified char array followed by a line delimiter to this session buffer.

        This method uses CR-LF as a line delimiter.

        Specified by:
        writeLine in interface SessionOutputBuffer
        Parameters:
        charbuffer - the buffer containing chars of the line.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • writeEncoded

        private void writeEncoded​(java.nio.CharBuffer cbuf)
                           throws java.io.IOException
        Throws:
        java.io.IOException
      • handleEncodingResult

        private void handleEncodingResult​(java.nio.charset.CoderResult result)
                                   throws java.io.IOException
        Throws:
        java.io.IOException