Top Description Inners Methods
org.xnio.conduits

public Interface WriteReadyHandler

extends TerminateHandler
Known Direct Implementers
org.xnio.conduits.WriteReadyHandler.ChannelListenerHandler
Imports
org.xnio.ChannelListener, .ChannelListeners, .IoUtils, org.xnio.channels.CloseListenerSettable, .SuspendableWriteChannel, .WriteListenerSettable

A conduit write-ready handler.
Author
David M. Lloyd

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WriteReadyHandler.ChannelListenerHandler<
the channel type
C extends SuspendableWriteChannel & WriteListenerSettable<C> & CloseListenerSettable<C>
>

A write ready handler which calls channel listener(s).

public static class
WriteReadyHandler.ReadyTask

A runnable task which invokes the WriteReadyHandler#writeReady() method of the given handler.

Method Summary

Modifier and TypeMethod and Description
public void
writeReady()

Signify that writes are ready.

Inherited from org.xnio.conduits.TerminateHandler:
forceTerminationterminated

Method Detail

writeReadyback to summary
public void writeReady()

Signify that writes are ready.

org.xnio.conduits back to summary

public Class WriteReadyHandler.ChannelListenerHandler<C extends SuspendableWriteChannel & WriteListenerSettable<C> & CloseListenerSettable<C>>

extends Object
implements WriteReadyHandler
Class Inheritance
All Implemented Interfaces
org.xnio.conduits.WriteReadyHandler, org.xnio.conduits.TerminateHandler
Type Parameters
<C>
the channel type

A write ready handler which calls channel listener(s).

Field Summary

Modifier and TypeField and Description
private final C

Constructor Summary

AccessConstructor and Description
public
ChannelListenerHandler(final C
the channel
channel
)

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
forceTermination()

Implements org.xnio.conduits.TerminateHandler.forceTermination.

Force the front-end channel to close, in response to XNIO worker shutdown.

public void
terminated()

Implements org.xnio.conduits.TerminateHandler.terminated.

Indicate that a previous shutdown request has successfully resulted in termination.

public void
writeReady()

Implements org.xnio.conduits.WriteReadyHandler.writeReady.

Signify that writes are ready.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

channelback to summary
private final C channel

Constructor Detail

ChannelListenerHandlerback to summary
public ChannelListenerHandler(final C channel)

Construct a new instance.

Parameters
channel:C

the channel

Method Detail

forceTerminationback to summary
public void forceTermination()

Implements org.xnio.conduits.TerminateHandler.forceTermination.

Doc from org.xnio.conduits.TerminateHandler.forceTermination.

Force the front-end channel to close, in response to XNIO worker shutdown.

terminatedback to summary
public void terminated()

Implements org.xnio.conduits.TerminateHandler.terminated.

Doc from org.xnio.conduits.TerminateHandler.terminated.

Indicate that a previous shutdown request has successfully resulted in termination.

writeReadyback to summary
public void writeReady()

Implements org.xnio.conduits.WriteReadyHandler.writeReady.

Doc from org.xnio.conduits.WriteReadyHandler.writeReady.

Signify that writes are ready.

org.xnio.conduits back to summary

public Class WriteReadyHandler.ReadyTask

extends Object
implements Runnable
Class Inheritance
All Implemented Interfaces
java.lang.Runnable

A runnable task which invokes the WriteReadyHandler#writeReady() method of the given handler.

Field Summary

Modifier and TypeField and Description
private final WriteReadyHandler

Constructor Summary

AccessConstructor and Description
public
ReadyTask(final WriteReadyHandler
the handler to invoke
handler
)

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
run()

Implements java.lang.Runnable.run.

Runs this operation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

handlerback to summary
private final WriteReadyHandler handler

Constructor Detail

ReadyTaskback to summary
public ReadyTask(final WriteReadyHandler handler)

Construct a new instance.

Parameters
handler:WriteReadyHandler

the handler to invoke

Method Detail

runback to summary
public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.