XNIO API 3.8.13.Final · org.xnio.conduits.StreamSinkChannelWrappingConduit

Modifier and Type	Field and Description
private final StreamSinkChannel	channel

Access	Constructor and Description
public	StreamSinkChannelWrappingConduit(final StreamSinkChannel the channel to wrap channel) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public void	awaitWritable() Implements org.xnio.conduits.SinkConduit.awaitWritable. Block until this channel becomes writable again.
public void	awaitWritable(final long the time to wait time, final TimeUnit the time unit timeUnit) Implements org.xnio.conduits.SinkConduit.awaitWritable. Block until this conduit becomes writable again, or until the timeout expires.
public boolean	flush() Implements org.xnio.conduits.SinkConduit.flush. Flush out any unwritten, buffered output.
public XnioWorker	getWorker() Implements org.xnio.conduits.Conduit.getWorker. Get the XNIO worker associated with this conduit.
public XnioIoThread	getWriteThread() Implements org.xnio.conduits.SinkConduit.getWriteThread. Get the write thread for this conduit.
public boolean	isWriteResumed() Implements org.xnio.conduits.SinkConduit.isWriteResumed. Determine whether write notifications are currently enabled.
public boolean	isWriteShutdown() Implements org.xnio.conduits.SinkConduit.isWriteShutdown. Determine whether writes have been fully shut down on this conduit.
public void	resumeWrites() Implements org.xnio.conduits.SinkConduit.resumeWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked as soon as data can be written without blocking.
public void	setWriteReadyHandler(final WriteReadyHandler the filter to receive readiness notifications handler) Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler. Set the handler which should receive readiness notifications.
public void	suspendWrites() Implements org.xnio.conduits.SinkConduit.suspendWrites. Indicate that calling the conduit's `WriteReadyHandler` should be suspended.
public void	terminateWrites() Implements org.xnio.conduits.SinkConduit.terminateWrites. Signal that no more write data is forthcoming.
public long	transferFrom(final FileChannel the file to read from src, final long the position within the file from which the transfer is to begin position, final long the number of bytes to be transferred count) Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Transfer bytes into this conduit from the given file.
public long	transferFrom(final StreamSourceChannel the source to read from source, final long the number of bytes to be transferred count, final ByteBuffer the buffer to copy through. throughBuffer) Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Transfers bytes from the given channel source.
public void	truncateWrites() Implements org.xnio.conduits.SinkConduit.truncateWrites. Terminate writes and discard any outstanding write data.
public void	wakeupWrites() Implements org.xnio.conduits.SinkConduit.wakeupWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked immediately, and then again as soon as data can be written without blocking.
public int	write(final ByteBuffer the buffer containing data to write src) Implements org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffer.
public long	write(final ByteBuffer[] the buffers containing data to write srcs, final int the offset into the buffer array offs, final int the number of buffers to write len) Implements org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffers.
public int	writeFinal(ByteBuffer The data to write src) Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer)`.
public long	writeFinal(ByteBuffer[] The buffers from which bytes are to be retrieved srcs, int 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` offset, int The maximum number of buffers to be accessed; must be non-negative and no larger than `srcs.length` - `offset` length) Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer[], int, int)`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

channel	back to summary
private final StreamSinkChannel channel

StreamSinkChannelWrappingConduit	back to summary
public StreamSinkChannelWrappingConduit(final StreamSinkChannel channel) Construct a new instance. Parameters channel:StreamSinkChannel the channel to wrap

Method Detail

awaitWritable	back to summary
public void awaitWritable() throws IOException Implements org.xnio.conduits.SinkConduit.awaitWritable. Doc from org.xnio.conduits.SinkConduit.awaitWritable. Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable. Exceptions IOException: if an I/O error occurs

awaitWritable

back to summary

public void awaitWritable() throws IOException

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.

Exceptions

IOException:: if an I/O error occurs

awaitWritable	back to summary
public void awaitWritable(final long time, final TimeUnit timeUnit) throws IOException Implements org.xnio.conduits.SinkConduit.awaitWritable. Doc from org.xnio.conduits.SinkConduit.awaitWritable. Block until this conduit becomes writable again, or until the timeout expires. This method may return spuriously before the conduit becomes writable or the timeout expires. Parameters time:long the time to wait timeUnit:TimeUnit the time unit Exceptions IOException: if an I/O error occurs

awaitWritable

back to summary

public void awaitWritable(final long time, final TimeUnit timeUnit) throws IOException

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this conduit becomes writable again, or until the timeout expires. This method may return spuriously before the conduit becomes writable or the timeout expires.

Parameters

time:long: the time to wait
timeUnit:TimeUnit: the time unit

Exceptions

IOException:: if an I/O error occurs

flush back to summary

flush	back to summary
public boolean flush() throws IOException Implements org.xnio.conduits.SinkConduit.flush. Doc from org.xnio.conduits.SinkConduit.flush. Flush out any unwritten, buffered output. Returns:boolean `true` if everything is flushed, `false` otherwise Exceptions IOException: if flush fails

public boolean flush() throws IOException

Implements org.xnio.conduits.SinkConduit.flush.

Doc from org.xnio.conduits.SinkConduit.flush.

Flush out any unwritten, buffered output.

Returns:boolean

true if everything is flushed, false otherwise

Exceptions

IOException:: if flush fails

getWorker	back to summary
public XnioWorker getWorker() Implements org.xnio.conduits.Conduit.getWorker. Doc from org.xnio.conduits.Conduit.getWorker. Get the XNIO worker associated with this conduit. Returns:XnioWorker the XNIO worker associated with this conduit

getWorker

back to summary

public XnioWorker getWorker()

Implements org.xnio.conduits.Conduit.getWorker.

Doc from org.xnio.conduits.Conduit.getWorker.

Get the XNIO worker associated with this conduit.

Returns:XnioWorker: the XNIO worker associated with this conduit

getWriteThread back to summary

getWriteThread	back to summary
public XnioIoThread getWriteThread() Implements org.xnio.conduits.SinkConduit.getWriteThread. Doc from org.xnio.conduits.SinkConduit.getWriteThread. Get the write thread for this conduit. Returns:XnioIoThread the thread, or `null` if none is configured or available

public XnioIoThread getWriteThread()

Implements org.xnio.conduits.SinkConduit.getWriteThread.

Doc from org.xnio.conduits.SinkConduit.getWriteThread.

Get the write thread for this conduit.

Returns:XnioIoThread: the thread, or null if none is configured or available

isWriteResumed back to summary

isWriteResumed	back to summary
public boolean isWriteResumed() Implements org.xnio.conduits.SinkConduit.isWriteResumed. Doc from org.xnio.conduits.SinkConduit.isWriteResumed. Determine whether write notifications are currently enabled. Returns:boolean `true` if write notifications are enabled

public boolean isWriteResumed()

Implements org.xnio.conduits.SinkConduit.isWriteResumed.

Doc from org.xnio.conduits.SinkConduit.isWriteResumed.

Determine whether write notifications are currently enabled.

Returns:boolean: true if write notifications are enabled

isWriteShutdown back to summary

isWriteShutdown	back to summary
public boolean isWriteShutdown() Implements org.xnio.conduits.SinkConduit.isWriteShutdown. Doc from org.xnio.conduits.SinkConduit.isWriteShutdown. Determine whether writes have been fully shut down on this conduit. Returns:boolean `true` if writes are fully shut down, `false` otherwise

public boolean isWriteShutdown()

Implements org.xnio.conduits.SinkConduit.isWriteShutdown.

Doc from org.xnio.conduits.SinkConduit.isWriteShutdown.

Determine whether writes have been fully shut down on this conduit.

Returns:boolean: true if writes are fully shut down, false otherwise

resumeWrites back to summary

resumeWrites	back to summary
public void resumeWrites() Implements org.xnio.conduits.SinkConduit.resumeWrites. Doc from org.xnio.conduits.SinkConduit.resumeWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked as soon as data can be written without blocking.

public void resumeWrites()

Implements org.xnio.conduits.SinkConduit.resumeWrites.

Doc from org.xnio.conduits.SinkConduit.resumeWrites.

Indicate that the conduit's WriteReadyHandler should be invoked as soon as data can be written without blocking.

setWriteReadyHandler	back to summary
public void setWriteReadyHandler(final WriteReadyHandler handler) Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler. Doc from org.xnio.conduits.SinkConduit.setWriteReadyHandler. Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself. Parameters handler:WriteReadyHandler the filter to receive readiness notifications

setWriteReadyHandler

back to summary

public void setWriteReadyHandler(final WriteReadyHandler handler)

Implements org.xnio.conduits.SinkConduit.setWriteReadyHandler.

Doc from org.xnio.conduits.SinkConduit.setWriteReadyHandler.

Set the handler which should receive readiness notifications. A filter may pass this invocation on to the filter it wraps, or it may substitute itself.

Parameters

handler:WriteReadyHandler: the filter to receive readiness notifications

suspendWrites back to summary

suspendWrites	back to summary
public void suspendWrites() Implements org.xnio.conduits.SinkConduit.suspendWrites. Doc from org.xnio.conduits.SinkConduit.suspendWrites. Indicate that calling the conduit's `WriteReadyHandler` should be suspended.

public void suspendWrites()

Implements org.xnio.conduits.SinkConduit.suspendWrites.

Doc from org.xnio.conduits.SinkConduit.suspendWrites.

Indicate that calling the conduit's WriteReadyHandler should be suspended.

terminateWrites back to summary

terminateWrites	back to summary
public void terminateWrites() throws IOException Implements org.xnio.conduits.SinkConduit.terminateWrites. Doc from org.xnio.conduits.SinkConduit.terminateWrites. Signal that no more write data is forthcoming. The conduit must be `flush()`ed before it is considered to be shut down.

public void terminateWrites() throws IOException

Implements org.xnio.conduits.SinkConduit.terminateWrites.

Doc from org.xnio.conduits.SinkConduit.terminateWrites.

Signal that no more write data is forthcoming. The conduit must be flush()ed before it is considered to be shut down.

transferFrom	back to summary
public long transferFrom(final FileChannel src, final long position, final long count) throws IOException Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Doc from org.xnio.conduits.StreamSinkConduit.transferFrom. Transfer bytes into this conduit from the given file. Parameters src:FileChannel the file to read from position:long the position within the file from which the transfer is to begin count:long the number of bytes to be transferred Returns:long the number of bytes (possibly 0) that were actually transferred Exceptions IOException: if an I/O error occurs

transferFrom

back to summary

public long transferFrom(final FileChannel src, final long position, final long count) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfer bytes into this conduit from the given file.

Parameters

src:FileChannel: the file to read from
position:long: the position within the file from which the transfer is to begin
count:long: the number of bytes to be transferred

Returns:long

the number of bytes (possibly 0) that were actually transferred

Exceptions

IOException:: if an I/O error occurs

transferFrom back to summary

transferFrom	back to summary
public long transferFrom(final StreamSourceChannel source, final long count, final ByteBuffer throughBuffer) throws IOException Implements org.xnio.conduits.StreamSinkConduit.transferFrom. Doc from org.xnio.conduits.StreamSinkConduit.transferFrom. Transfers bytes from the given channel source. 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. Parameters source:StreamSourceChannel the source to read from count:long the number of bytes to be transferred throughBuffer:ByteBuffer the buffer to copy through. Returns:long the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached Exceptions IOException: if an I/O error occurs

public long transferFrom(final StreamSourceChannel source, final long count, final ByteBuffer throughBuffer) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfers bytes from the given channel source. 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.

Parameters

source:StreamSourceChannel: the source to read from
count:long: the number of bytes to be transferred
throughBuffer:ByteBuffer: the buffer to copy through.

Returns:long

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

Exceptions

IOException:: if an I/O error occurs

truncateWrites	back to summary
public void truncateWrites() throws IOException Implements org.xnio.conduits.SinkConduit.truncateWrites. Doc from org.xnio.conduits.SinkConduit.truncateWrites. Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method. Exceptions IOException: if channel termination failed for some reason

truncateWrites

back to summary

public void truncateWrites() throws IOException

Implements org.xnio.conduits.SinkConduit.truncateWrites.

Doc from org.xnio.conduits.SinkConduit.truncateWrites.

Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.

Exceptions

IOException:: if channel termination failed for some reason

wakeupWrites back to summary

wakeupWrites	back to summary
public void wakeupWrites() Implements org.xnio.conduits.SinkConduit.wakeupWrites. Doc from org.xnio.conduits.SinkConduit.wakeupWrites. Indicate that the conduit's `WriteReadyHandler` should be invoked immediately, and then again as soon as data can be written without blocking.

public void wakeupWrites()

Implements org.xnio.conduits.SinkConduit.wakeupWrites.

Doc from org.xnio.conduits.SinkConduit.wakeupWrites.

Indicate that the conduit's WriteReadyHandler should be invoked immediately, and then again as soon as data can be written without blocking.

write	back to summary
public int write(final ByteBuffer src) throws IOException Implements org.xnio.conduits.StreamSinkConduit.write. Doc from org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffer. Parameters src:ByteBuffer the buffer containing data to write Returns:int the number of bytes written, possibly 0 Exceptions IOException: if an error occurs

write

back to summary

public int write(final ByteBuffer src) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffer.

Parameters

src:ByteBuffer: the buffer containing data to write

Returns:int

the number of bytes written, possibly 0

Exceptions

IOException:: if an error occurs

write	back to summary
public long write(final ByteBuffer[] srcs, final int offs, final int len) throws IOException Implements org.xnio.conduits.StreamSinkConduit.write. Doc from org.xnio.conduits.StreamSinkConduit.write. Writes a sequence of bytes to this conduit from the given buffers. Parameters srcs:ByteBuffer[] the buffers containing data to write offs:int the offset into the buffer array len:int the number of buffers to write Returns:long the number of bytes written, possibly 0 Exceptions IOException: if an error occurs

write

back to summary

public long write(final ByteBuffer[] srcs, final int offs, final int len) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffers.

Parameters

srcs:ByteBuffer[]: the buffers containing data to write
offs:int: the offset into the buffer array
len:int: the number of buffers to write

Returns:long

the number of bytes written, possibly 0

Exceptions

IOException:: if an error occurs

writeFinal back to summary

writeFinal	back to summary
public int writeFinal(ByteBuffer src) throws IOException Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Doc from org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer)`. If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to: `int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }` Parameters src:ByteBuffer The data to write Returns:int The amount of data that was actually written. Annotations @Override

public int writeFinal(ByteBuffer src) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer). If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to: int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }

Parameters

src:ByteBuffer: The data to write

Returns:int

The amount of data that was actually written.

Annotations

@Override

writeFinal back to summary

writeFinal	back to summary
public long writeFinal(ByteBuffer[] srcs, int offset, int length) throws IOException Implements org.xnio.conduits.StreamSinkConduit.writeFinal. Doc from org.xnio.conduits.StreamSinkConduit.writeFinal. Writes some data to the conduit, with the same semantics as `write(java.nio.ByteBuffer[], int, int)`. If all the data is written out then the conduit will have its writes terminated. Parameters srcs:ByteBuffer[] The buffers from which bytes are to be retrieved offset:int 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:int The maximum number of buffers to be accessed; must be non-negative and no larger than `srcs.length` - `offset` Returns:long The amount of data that was actually written Annotations @Override

public long writeFinal(ByteBuffer[] srcs, int offset, int length) throws IOException

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer[], int, int). If all the data is written out then the conduit will have its writes terminated.

Parameters

srcs:ByteBuffer[]: The buffers from which bytes are to be retrieved
offset:int: 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:int: The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:long

The amount of data that was actually written

Annotations

@Override

public final Class StreamSinkChannelWrappingConduit

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail