PreChunkedStreamSinkConduit (Undertow 2.1.0.Final API)

java.lang.Object
- org.xnio.conduits.AbstractConduit<D>
- - org.xnio.conduits.AbstractSinkConduit<D>
  - - org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    - - io.undertow.conduits.PreChunkedStreamSinkConduit

All Implemented Interfaces:

org.xnio.conduits.Conduit, org.xnio.conduits.SinkConduit, org.xnio.conduits.StreamSinkConduit
```
public class PreChunkedStreamSinkConduit
extends org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
```
Channel that implements HTTP chunked transfer coding for data streams that already have chunk markers.

Author:

Stuart Douglas

Field Summary
- Fields inherited from class org.xnio.conduits.AbstractConduit
  next

Constructor Summary

Constructors
Constructor and Description
`PreChunkedStreamSinkConduit(org.xnio.conduits.StreamSinkConduit next, ConduitListener<? super PreChunkedStreamSinkConduit> finishListener, Attachable attachable)` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`awaitWritable()`
`void`	`awaitWritable(long time, TimeUnit timeUnit)`
`boolean`	`flush()`
`void`	`terminateWrites()`
`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, int offset, int length)`

Methods inherited from class org.xnio.conduits.AbstractSinkConduit
getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, truncateWrites, wakeupWrites

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.SinkConduit
getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, truncateWrites, wakeupWrites

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

- Constructor Detail
  - PreChunkedStreamSinkConduit
```
public PreChunkedStreamSinkConduit(org.xnio.conduits.StreamSinkConduit next,
                                   ConduitListener<? super PreChunkedStreamSinkConduit> finishListener,
                                   Attachable attachable)
```
    Construct a new instance.
    
    Parameters:
    
    next - the channel to wrap
    
    finishListener - The finish listener
    
    attachable - The attachable
- Method Detail
  - write
```
public int write(ByteBuffer src)
          throws IOException
```
    Specified by:
    
    write in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    write in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - write
```
public long write(ByteBuffer[] srcs,
                  int offset,
                  int length)
           throws IOException
```
    Specified by:
    
    write in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    write in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - writeFinal
```
public long writeFinal(ByteBuffer[] srcs,
                       int offset,
                       int length)
                throws IOException
```
    Specified by:
    
    writeFinal in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    writeFinal in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - writeFinal
```
public int writeFinal(ByteBuffer src)
               throws IOException
```
    Specified by:
    
    writeFinal in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    writeFinal in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - transferFrom
```
public long transferFrom(FileChannel src,
                         long position,
                         long count)
                  throws IOException
```
    Specified by:
    
    transferFrom in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    transferFrom in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - transferFrom
```
public long transferFrom(org.xnio.channels.StreamSourceChannel source,
                         long count,
                         ByteBuffer throughBuffer)
                  throws IOException
```
    Specified by:
    
    transferFrom in interface org.xnio.conduits.StreamSinkConduit
    
    Overrides:
    
    transferFrom in class org.xnio.conduits.AbstractStreamSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - flush
```
public boolean flush()
              throws IOException
```
    Specified by:
    
    flush in interface org.xnio.conduits.SinkConduit
    
    Overrides:
    
    flush in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - terminateWrites
```
public void terminateWrites()
                     throws IOException
```
    Specified by:
    
    terminateWrites in interface org.xnio.conduits.SinkConduit
    
    Overrides:
    
    terminateWrites in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - awaitWritable
```
public void awaitWritable()
                   throws IOException
```
    Specified by:
    
    awaitWritable in interface org.xnio.conduits.SinkConduit
    
    Overrides:
    
    awaitWritable in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException
  - awaitWritable
```
public void awaitWritable(long time,
                          TimeUnit timeUnit)
                   throws IOException
```
    Specified by:
    
    awaitWritable in interface org.xnio.conduits.SinkConduit
    
    Overrides:
    
    awaitWritable in class org.xnio.conduits.AbstractSinkConduit<org.xnio.conduits.StreamSinkConduit>
    
    Throws:
    
    IOException

Class PreChunkedStreamSinkConduit

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit

Constructor Summary

Method Summary

Methods inherited from class org.xnio.conduits.AbstractSinkConduit

Methods inherited from class org.xnio.conduits.AbstractConduit

Methods inherited from class java.lang.Object

Methods inherited from interface org.xnio.conduits.SinkConduit

Methods inherited from interface org.xnio.conduits.Conduit

Constructor Detail

PreChunkedStreamSinkConduit

Method Detail

write

write

writeFinal

writeFinal

transferFrom

transferFrom

flush

terminateWrites

awaitWritable

awaitWritable