Package org.xnio.conduits
Class AbstractSinkConduit<D extends SinkConduit>
java.lang.Object
org.xnio.conduits.AbstractConduit<D>
org.xnio.conduits.AbstractSinkConduit<D>
- All Implemented Interfaces:
Conduit
,SinkConduit
- Direct Known Subclasses:
AbstractMessageSinkConduit
,AbstractStreamSinkConduit
,FramingMessageSinkConduit
,MessageStreamSinkConduit
public abstract class AbstractSinkConduit<D extends SinkConduit>
extends AbstractConduit<D>
implements SinkConduit
An abstract base class for filtering output conduits.
- Author:
- David M. Lloyd
-
Field Summary
Fields inherited from class org.xnio.conduits.AbstractConduit
next
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Block until this channel becomes writable again.void
awaitWritable
(long time, TimeUnit timeUnit) Block until this conduit becomes writable again, or until the timeout expires.boolean
flush()
Flush out any unwritten, buffered output.Get the write thread for this conduit.boolean
Determine whether write notifications are currently enabled.boolean
Determine whether writes have been fully shut down on this conduit.void
Indicate that the conduit'sWriteReadyHandler
should be invoked as soon as data can be written without blocking.void
setWriteReadyHandler
(WriteReadyHandler handler) Set the handler which should receive readiness notifications.void
Indicate that calling the conduit'sWriteReadyHandler
should be suspended.void
Signal that no more write data is forthcoming.void
Terminate writes and discard any outstanding write data.void
Indicate that the conduit'sWriteReadyHandler
should be invoked immediately, and then again as soon as data can be written without blocking.Methods inherited from class org.xnio.conduits.AbstractConduit
getWorker
-
Constructor Details
-
AbstractSinkConduit
Construct a new instance.- Parameters:
next
- the delegate conduit to set
-
-
Method Details
-
terminateWrites
Description copied from interface:SinkConduit
Signal that no more write data is forthcoming. The conduit must beSinkConduit.flush()
ed before it is considered to be shut down.- Specified by:
terminateWrites
in interfaceSinkConduit
- Throws:
IOException
-
isWriteShutdown
public boolean isWriteShutdown()Description copied from interface:SinkConduit
Determine whether writes have been fully shut down on this conduit.- Specified by:
isWriteShutdown
in interfaceSinkConduit
- Returns:
true
if writes are fully shut down,false
otherwise
-
resumeWrites
public void resumeWrites()Description copied from interface:SinkConduit
Indicate that the conduit'sWriteReadyHandler
should be invoked as soon as data can be written without blocking.- Specified by:
resumeWrites
in interfaceSinkConduit
-
suspendWrites
public void suspendWrites()Description copied from interface:SinkConduit
Indicate that calling the conduit'sWriteReadyHandler
should be suspended.- Specified by:
suspendWrites
in interfaceSinkConduit
-
wakeupWrites
public void wakeupWrites()Description copied from interface:SinkConduit
Indicate that the conduit'sWriteReadyHandler
should be invoked immediately, and then again as soon as data can be written without blocking.- Specified by:
wakeupWrites
in interfaceSinkConduit
-
isWriteResumed
public boolean isWriteResumed()Description copied from interface:SinkConduit
Determine whether write notifications are currently enabled.- Specified by:
isWriteResumed
in interfaceSinkConduit
- Returns:
true
if write notifications are enabled
-
awaitWritable
Description copied from interface:SinkConduit
Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.- Specified by:
awaitWritable
in interfaceSinkConduit
- Throws:
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as wellIOException
- if an I/O error occurs
-
awaitWritable
Description copied from interface:SinkConduit
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.- Specified by:
awaitWritable
in interfaceSinkConduit
- Parameters:
time
- the time to waittimeUnit
- the time unit- Throws:
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as wellIOException
- if an I/O error occurs
-
getWriteThread
Description copied from interface:SinkConduit
Get the write thread for this conduit.- Specified by:
getWriteThread
in interfaceSinkConduit
- Returns:
- the thread, or
null
if none is configured or available
-
setWriteReadyHandler
Description copied from interface:SinkConduit
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.- Specified by:
setWriteReadyHandler
in interfaceSinkConduit
-
truncateWrites
Description copied from interface:SinkConduit
Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.- Specified by:
truncateWrites
in interfaceSinkConduit
- Throws:
IOException
- if channel termination failed for some reason
-
flush
Description copied from interface:SinkConduit
Flush out any unwritten, buffered output.- Specified by:
flush
in interfaceSinkConduit
- Returns:
true
if everything is flushed,false
otherwise- Throws:
IOException
- if flush fails
-