WriteTimeoutStreamSinkChannel (Undertow 1.3.0.CR1 API)

java.lang.Object
- io.undertow.channels.DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
- - io.undertow.channels.WriteTimeoutStreamSinkChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, GatheringByteChannel, InterruptibleChannel, WritableByteChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.StreamSinkChannel, org.xnio.channels.SuspendableWriteChannel
```
public final class WriteTimeoutStreamSinkChannel
extends DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
```
Wrapper for write timeout. This should always be the first wrapper applied to the underlying channel.

Author:

Stuart Douglas

See Also:

Options.WRITE_TIMEOUT

Field Summary
- Fields inherited from class io.undertow.channels.DelegatingStreamSinkChannel
  closeSetter, delegate, writeSetter
- Fields inherited from interface org.xnio.channels.Configurable
  EMPTY

Constructor Summary

Constructors
Constructor and Description

WriteTimeoutStreamSinkChannel(org.xnio.channels.StreamSinkChannel delegate)

Constructors
Constructor and Description
`WriteTimeoutStreamSinkChannel(org.xnio.channels.StreamSinkChannel delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`<T> T`	`setOption(org.xnio.Option<T> option, T value)`
`void`	`shutdownWrites()`
`long`	`transferFrom(FileChannel src, long position, long count)`
`long`	`transferFrom(org.xnio.channels.StreamSourceChannel source, long count, ByteBuffer throughBuffer)`
`int`	`write(ByteBuffer src)`
`long`	`write(ByteBuffer[] srcs, int offset, int length)`
`int`	`writeFinal(ByteBuffer src)`
`long`	`writeFinal(ByteBuffer[] srcs)`
`long`	`writeFinal(ByteBuffer[] srcs, int offset, int length)`

Methods inherited from class io.undertow.channels.DelegatingStreamSinkChannel
awaitWritable, awaitWritable, flush, getCloseSetter, getIoThread, getOption, getWorker, getWriteSetter, getWriteThread, isOpen, isWriteResumed, resumeWrites, supportsOption, suspendWrites, wakeupWrites, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WriteTimeoutStreamSinkChannel
```
public WriteTimeoutStreamSinkChannel(org.xnio.channels.StreamSinkChannel delegate)
```
    Parameters:
    
    delegate - The underlying channel
- Method Detail
  - write
```
public int write(ByteBuffer src)
          throws IOException
```
    Specified by:
    
    write in interface WritableByteChannel
    
    Overrides:
    
    write in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - write
```
public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException
```
    Specified by:
    
    write in interface GatheringByteChannel
    
    Overrides:
    
    write in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - writeFinal
```
public int writeFinal(ByteBuffer src)
               throws IOException
```
    Specified by:
    
    writeFinal in interface org.xnio.channels.StreamSinkChannel
    
    Overrides:
    
    writeFinal in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - writeFinal
```
public long writeFinal(ByteBuffer[] srcs,
                       int offset,
                       int length)
                throws IOException
```
    Specified by:
    
    writeFinal in interface org.xnio.channels.StreamSinkChannel
    
    Overrides:
    
    writeFinal in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - writeFinal
```
public long writeFinal(ByteBuffer[] srcs)
                throws IOException
```
    Specified by:
    
    writeFinal in interface org.xnio.channels.StreamSinkChannel
    
    Overrides:
    
    writeFinal in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - transferFrom
```
public long transferFrom(FileChannel src,
                         long position,
                         long count)
                  throws IOException
```
    Specified by:
    
    transferFrom in interface org.xnio.channels.StreamSinkChannel
    
    Overrides:
    
    transferFrom in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - transferFrom
```
public long transferFrom(org.xnio.channels.StreamSourceChannel source,
                         long count,
                         ByteBuffer throughBuffer)
                  throws IOException
```
    Specified by:
    
    transferFrom in interface org.xnio.channels.StreamSinkChannel
    
    Overrides:
    
    transferFrom in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - setOption
```
public <T> T setOption(org.xnio.Option<T> option,
                       T value)
                throws IllegalArgumentException,
                       IOException
```
    Specified by:
    
    setOption in interface org.xnio.channels.Configurable
    
    Overrides:
    
    setOption in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IllegalArgumentException
    
    IOException
  - shutdownWrites
```
public void shutdownWrites()
                    throws IOException
```
    Specified by:
    
    shutdownWrites in interface org.xnio.channels.SuspendableWriteChannel
    
    Overrides:
    
    shutdownWrites in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Channel
    
    Specified by:
    
    close in interface InterruptibleChannel
    
    Specified by:
    
    close in interface org.xnio.channels.CloseableChannel
    
    Specified by:
    
    close in interface org.xnio.channels.SuspendableWriteChannel
    
    Overrides:
    
    close in class DelegatingStreamSinkChannel<WriteTimeoutStreamSinkChannel>
    
    Throws:
    
    IOException

Class WriteTimeoutStreamSinkChannel

Field Summary

Fields inherited from class io.undertow.channels.DelegatingStreamSinkChannel

Fields inherited from interface org.xnio.channels.Configurable

Constructor Summary

Method Summary

Methods inherited from class io.undertow.channels.DelegatingStreamSinkChannel

Methods inherited from class java.lang.Object

Constructor Detail

WriteTimeoutStreamSinkChannel

Method Detail

write

write

writeFinal

writeFinal

writeFinal

transferFrom

transferFrom

setOption

shutdownWrites

close