Module 

Class SplitStreamSinkChannel

    • Constructor Detail

      • SplitStreamSinkChannel

        public SplitStreamSinkChannel​(StreamSinkChannel delegate,
                                      boolean delegateConfig)
        Construct a new instance.
        Parameters:
        delegate - the delegate channel
        delegateConfig - true to delegate configuration, false otherwise
      • SplitStreamSinkChannel

        public SplitStreamSinkChannel​(StreamSinkChannel delegate)
        Construct a new instance which does not delegate configuration.
        Parameters:
        delegate - the delegate channel
    • Method Detail

      • writeFinal

        public int writeFinal​(java.nio.ByteBuffer src)
                       throws java.io.IOException
        Description copied from interface: StreamSinkChannel
        Writes some data to the channel, with the same semantics as WritableByteChannel.write(java.nio.ByteBuffer). If all the data is written out then the channel will have its writes shutdown. Semantically this method is equivalent to: int rem = src.remaining(); int written = channel.write(src); if(written == rem) { channel.shutdownWrites() } If an exception is thrown the caller is still responsible for closing the channel.
        Specified by:
        writeFinal in interface StreamSinkChannel
        Parameters:
        src - The data to write
        Returns:
        The amount of data that was actually written.
        Throws:
        java.io.IOException
        See Also:
        WritableByteChannel.write(java.nio.ByteBuffer), SuspendableWriteChannel.shutdownWrites()
      • writeFinal

        public long writeFinal​(java.nio.ByteBuffer[] srcs,
                               int offset,
                               int length)
                        throws java.io.IOException
        Description copied from interface: StreamSinkChannel
        Writes some data to the channel, with the same semantics as GatheringByteChannel.write(java.nio.ByteBuffer[], int, int). If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.
        Specified by:
        writeFinal in interface StreamSinkChannel
        Parameters:
        srcs - The buffers from which bytes are to be retrieved
        offset - The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length
        length - The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset
        Returns:
        The amount of data that was actually written
        Throws:
        java.io.IOException
        See Also:
        GatheringByteChannel.write(java.nio.ByteBuffer[], int, int), SuspendableWriteChannel.shutdownWrites()
      • writeFinal

        public long writeFinal​(java.nio.ByteBuffer[] srcs)
                        throws java.io.IOException
        Description copied from interface: StreamSinkChannel
        Writes some data to the channel, with the same semantics as GatheringByteChannel.write(java.nio.ByteBuffer[]). If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.
        Specified by:
        writeFinal in interface StreamSinkChannel
        Parameters:
        srcs - The buffers from which bytes are to be retrieved
        Returns:
        The amount of data that was actually written
        Throws:
        java.io.IOException
        See Also:
        GatheringByteChannel.write(java.nio.ByteBuffer[]), SuspendableWriteChannel.shutdownWrites()
      • shutdownWrites

        public void shutdownWrites()
                            throws java.io.IOException
        Description copied from interface: SuspendableWriteChannel
        Indicate that writing is complete for this channel. Further attempts to write data to this channel after this method is invoked will result in an exception. If this method was already called, calling this method again will have no additional effect. After this method is called, any remaining data still must be flushed out via the SuspendableWriteChannel.flush() method; once this is done, if the read side of the channel was shut down, the channel will automatically close.
        Specified by:
        shutdownWrites in interface SuspendableWriteChannel
        Throws:
        java.io.IOException - if an I/O error occurs
      • isOpen

        public boolean isOpen()
        Description copied from interface: SuspendableWriteChannel
        Determine whether this channel is open. This method will return false if all directions are shut down, even if there is unflushed write data pending.
        Specified by:
        isOpen in interface java.nio.channels.Channel
        Specified by:
        isOpen in interface SuspendableWriteChannel
        Returns:
        true if the channel is open, false otherwise
      • close

        public void close()
                   throws java.io.IOException
        Description copied from interface: SuspendableWriteChannel
        Close this channel. If data has been written but not flushed, that data may be discarded, depending on the channel implementation. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.nio.channels.Channel
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface CloseableChannel
        Specified by:
        close in interface java.nio.channels.InterruptibleChannel
        Specified by:
        close in interface SuspendableWriteChannel
        Throws:
        java.io.IOException - if the close failed
      • flush

        public boolean flush()
                      throws java.io.IOException
        Description copied from interface: SuspendableWriteChannel
        Flush any waiting partial send or write. If there is no data to flush, or if the flush completed successfully, this method will return true. If there is data to flush which cannot be immediately written, this method will return false. If this method returns true after SuspendableWriteChannel.shutdownWrites() was called on this channel, the write listener will no longer be invoked on this channel. If this is case and additionally this is a write-only channel or the read side was previously shut down, then the channel will automatically be closed.
        Specified by:
        flush in interface SuspendableWriteChannel
        Returns:
        true if the message was flushed, or false if the result would block
        Throws:
        java.io.IOException - if an I/O error occurs
      • transferFrom

        public long transferFrom​(java.nio.channels.FileChannel src,
                                 long position,
                                 long count)
                          throws java.io.IOException
        Description copied from interface: StreamSinkChannel
        Transfer bytes into this channel from the given file. Using this method in preference to FileChannel.transferTo(long, long, WritableByteChannel) may provide a performance advantage on some platforms.

        If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

        Specified by:
        transferFrom in interface StreamSinkChannel
        Parameters:
        src - the file to read from
        position - the position within the file from which the transfer is to begin
        count - the number of bytes to be transferred
        Returns:
        the number of bytes (possibly 0) that were actually transferred
        Throws:
        java.io.IOException - if an I/O error occurs
      • transferFrom

        public long transferFrom​(StreamSourceChannel source,
                                 long count,
                                 java.nio.ByteBuffer throughBuffer)
                          throws java.io.IOException
        Description copied from interface: StreamSinkChannel
        Transfers bytes from the given channel source. On some platforms, this may avoid copying bytes between user and kernel space. On other platforms, bytes are passed through the throughBuffer parameter's buffer space. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from source which must be written to this channel to complete the operation. Note that using a direct buffer may provide an intermediate performance gain on platforms without zero-copy facilities.

        If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

        Specified by:
        transferFrom in interface StreamSinkChannel
        Parameters:
        source - the source to read from
        count - the number of bytes to be transferred
        throughBuffer - the buffer to copy through.
        Returns:
        the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached
        Throws:
        java.io.IOException - if an I/O error occurs
      • write

        public int write​(java.nio.ByteBuffer src)
                  throws java.io.IOException
        Specified by:
        write in interface java.nio.channels.WritableByteChannel
        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 java.nio.channels.GatheringByteChannel
        Throws:
        java.io.IOException
      • write

        public long write​(java.nio.ByteBuffer[] srcs)
                   throws java.io.IOException
        Specified by:
        write in interface java.nio.channels.GatheringByteChannel
        Throws:
        java.io.IOException
      • awaitWritable

        public void awaitWritable()
                           throws java.io.IOException
        Description copied from interface: SuspendableWriteChannel
        Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.
        Specified by:
        awaitWritable in interface SuspendableWriteChannel
        Throws:
        java.io.InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well
        java.io.IOException - if an I/O error occurs
      • awaitWritable

        public void awaitWritable​(long time,
                                  java.util.concurrent.TimeUnit timeUnit)
                           throws java.io.IOException
        Description copied from interface: SuspendableWriteChannel
        Block until this channel becomes writable again, or until the timeout expires. This method may return spuriously before the channel becomes writable or the timeout expires.
        Specified by:
        awaitWritable in interface SuspendableWriteChannel
        Parameters:
        time - the time to wait
        timeUnit - the time unit
        Throws:
        java.io.InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well
        java.io.IOException - if an I/O error occurs
      • setOption

        public <T> T setOption​(Option<T> option,
                               T value)
                        throws java.lang.IllegalArgumentException,
                               java.io.IOException
        Description copied from interface: Configurable
        Set an option for this channel. Unsupported options are ignored.
        Specified by:
        setOption in interface Configurable
        Type Parameters:
        T - the type of the option value
        Parameters:
        option - the option to set
        value - the value of the option to set
        Returns:
        the previous option value, if any
        Throws:
        java.lang.IllegalArgumentException - if the value is not acceptable for this option
        java.io.IOException - if an I/O error occurred when modifying the option
      • getOption

        public <T> T getOption​(Option<T> option)
                        throws java.io.IOException
        Description copied from interface: Configurable
        Get the value of a channel option.
        Specified by:
        getOption in interface Configurable
        Type Parameters:
        T - the type of the option value
        Parameters:
        option - the option to get
        Returns:
        the value of the option, or null if it is not set
        Throws:
        java.io.IOException - if an I/O error occurred when reading the option
      • supportsOption

        public boolean supportsOption​(Option<?> option)
        Description copied from interface: Configurable
        Determine whether an option is supported on this channel.
        Specified by:
        supportsOption in interface Configurable
        Parameters:
        option - the option
        Returns:
        true if it is supported