Package io.undertow.conduits

Class AbstractFixedLengthStreamSinkConduit

  • All Implemented Interfaces:
    org.xnio.conduits.Conduit, org.xnio.conduits.SinkConduit, org.xnio.conduits.StreamSinkConduit
    Direct Known Subclasses:
    ServerFixedLengthStreamSinkConduit
    public abstract class AbstractFixedLengthStreamSinkConduit
extends org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    A channel which writes a fixed amount of data. A listener is called once the data has been written.
    Author:
    David M. Lloyd

    • Field Summary

      • Fields inherited from class org.xnio.conduits.AbstractConduit

        next

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractFixedLengthStreamSinkConduit​(org.xnio.conduits.StreamSinkConduit next, long contentLength, boolean configurable, boolean propagateClose)
      Construct a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void awaitWritable()  
      void awaitWritable​(long time, java.util.concurrent.TimeUnit timeUnit)  
      protected void channelFinished()  
      boolean flush()  
      long getRemaining()
      Get the number of remaining bytes in this fixed length channel.
      boolean isWriteResumed()  
      protected void reset​(long contentLength, boolean propagateClose)  
      void terminateWrites()  
      long transferFrom​(java.nio.channels.FileChannel src, long position, long count)  
      long transferFrom​(org.xnio.channels.StreamSourceChannel source, long count, java.nio.ByteBuffer throughBuffer)  
      void truncateWrites()  
      void wakeupWrites()  
      int write​(java.nio.ByteBuffer src)  
      long write​(java.nio.ByteBuffer[] srcs, int offset, int length)  
      int writeFinal​(java.nio.ByteBuffer src)  
      long writeFinal​(java.nio.ByteBuffer[] srcs, int offset, int length)  

      • Methods inherited from class org.xnio.conduits.AbstractSinkConduit

        getWriteThread, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites

      • Methods inherited from class org.xnio.conduits.AbstractConduit

        getWorker

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.xnio.conduits.Conduit

        getWorker

      • Methods inherited from interface org.xnio.conduits.SinkConduit

        getWriteThread, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites

    • Constructor Detail

      • AbstractFixedLengthStreamSinkConduit

        public AbstractFixedLengthStreamSinkConduit​(org.xnio.conduits.StreamSinkConduit next,
                                            long contentLength,
                                            boolean configurable,
                                            boolean propagateClose)
        Construct a new instance.
        Parameters:
        next - the next channel
        contentLength - the content length
        configurable - true if this instance should pass configuration to the next
        propagateClose - true if this instance should pass close to the next

    • Method Detail

      • reset

        protected void reset​(long contentLength,
                     boolean propagateClose)

      • write

        public int write​(java.nio.ByteBuffer src)
          throws java.io.IOException
        Specified by:
        write in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        write in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • write

        public long write​(java.nio.ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws java.io.IOException
        Specified by:
        write in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        write in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • writeFinal

        public long writeFinal​(java.nio.ByteBuffer[] srcs,
                       int offset,
                       int length)
                throws java.io.IOException
        Specified by:
        writeFinal in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        writeFinal in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • writeFinal

        public int writeFinal​(java.nio.ByteBuffer src)
               throws java.io.IOException
        Specified by:
        writeFinal in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        writeFinal in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • transferFrom

        public long transferFrom​(java.nio.channels.FileChannel src,
                         long position,
                         long count)
                  throws java.io.IOException
        Specified by:
        transferFrom in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        transferFrom in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • transferFrom

        public long transferFrom​(org.xnio.channels.StreamSourceChannel source,
                         long count,
                         java.nio.ByteBuffer throughBuffer)
                  throws java.io.IOException
        Specified by:
        transferFrom in interface org.xnio.conduits.StreamSinkConduit
        Overrides:
        transferFrom in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • flush

        public boolean flush()
              throws java.io.IOException
        Specified by:
        flush in interface org.xnio.conduits.SinkConduit
        Overrides:
        flush in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • isWriteResumed

        public boolean isWriteResumed()
        Specified by:
        isWriteResumed in interface org.xnio.conduits.SinkConduit
        Overrides:
        isWriteResumed in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>

      • wakeupWrites

        public void wakeupWrites()
        Specified by:
        wakeupWrites in interface org.xnio.conduits.SinkConduit
        Overrides:
        wakeupWrites in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>

      • terminateWrites

        public void terminateWrites()
                     throws java.io.IOException
        Specified by:
        terminateWrites in interface org.xnio.conduits.SinkConduit
        Overrides:
        terminateWrites in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • truncateWrites

        public void truncateWrites()
                    throws java.io.IOException
        Specified by:
        truncateWrites in interface org.xnio.conduits.SinkConduit
        Overrides:
        truncateWrites in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • awaitWritable

        public void awaitWritable()
                   throws java.io.IOException
        Specified by:
        awaitWritable in interface org.xnio.conduits.SinkConduit
        Overrides:
        awaitWritable in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • awaitWritable

        public void awaitWritable​(long time,
                          java.util.concurrent.TimeUnit timeUnit)
                   throws java.io.IOException
        Specified by:
        awaitWritable in interface org.xnio.conduits.SinkConduit
        Overrides:
        awaitWritable in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
        Throws:
        java.io.IOException

      • getRemaining

        public long getRemaining()
        Get the number of remaining bytes in this fixed length channel.
        Returns:
        the number of remaining bytes

      • channelFinished

        protected void channelFinished()