org.fusesource.hawtdispatch.internal

Class NioDispatchSource

java.lang.Object

org.fusesource.hawtdispatch.Task

org.fusesource.hawtdispatch.internal.BaseSuspendable

org.fusesource.hawtdispatch.internal.AbstractDispatchObject

org.fusesource.hawtdispatch.internal.NioDispatchSource

All Implemented Interfaces:

java.lang.Runnable, DispatchObject, DispatchSource, Suspendable

public final class NioDispatchSource
extends AbstractDispatchObject
implements DispatchSource

Implements the DispatchSource interface.

Description: An NioDispatchSource is associated with one SelectableChannel but supports being registered on selectors associated with different thread. Usually just one at time tho.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NioDispatchSource.KeyState

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.concurrent.atomic.AtomicBoolean	canceled
(package private) Task	cancelHandler
(package private) java.nio.channels.SelectableChannel	channel
static boolean	DEBUG
(package private) Task	eventHandler
(package private) int	interestOps
(package private) java.lang.ThreadLocal<NioDispatchSource.KeyState>	keyState
(package private) DispatchQueue	selectorQueue
private Task	updateInterestTask

Fields inherited from class org.fusesource.hawtdispatch.internal.AbstractDispatchObject

targetQueue

Fields inherited from class org.fusesource.hawtdispatch.internal.BaseSuspendable

startup, suspended

Constructor Summary

Constructors

Constructor and Description
NioDispatchSource(HawtDispatcher dispatcher, java.nio.channels.SelectableChannel channel, int interestOps, DispatchQueue targetQueue)

Method Summary

Modifier and Type	Method and Description
void	cancel() Asynchronously cancel the dispatch source, preventing any further invocation of its event handler runnable.
protected void	debug(java.lang.String str, java.lang.Object... args)
protected void	debug(java.lang.Throwable thrown, java.lang.String str, java.lang.Object... args)
void	fire(int readyOps)
private NioManager	getCurrentNioManager()
java.lang.Void	getData()
(package private) void	internal_cancel()
boolean	isCanceled()
private boolean	isCurrent(DispatchQueue q)
private void	key_cancel()
protected void	onResume()
protected void	onStartup()
protected void	onSuspend()
private static java.lang.String	opsToString(int ops)
private static DispatchQueue	pickThreadQueue(HawtDispatcher dispatcher, DispatchQueue targetQueue)
private void	register_on(DispatchQueue queue)
void	setCancelHandler(java.lang.Runnable handler) Deprecated.
void	setCancelHandler(Task cancelHandler) Sets the cancellation handler task for the given dispatch source.
void	setEventHandler(java.lang.Runnable handler) Deprecated.
void	setEventHandler(Task eventHandler) Sets the event handler task of this dispatch source.
void	setTargetQueue(DispatchQueue next) Sets the target queue for this object.
private void	updateInterest()

Methods inherited from class org.fusesource.hawtdispatch.internal.AbstractDispatchObject

getTargetQueue

Methods inherited from class org.fusesource.hawtdispatch.internal.BaseSuspendable

isSuspended, resume, run, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fusesource.hawtdispatch.DispatchObject

getTargetQueue

Methods inherited from interface org.fusesource.hawtdispatch.Suspendable

isSuspended, resume, suspend

Field Detail

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

channel

final java.nio.channels.SelectableChannel channel

selectorQueue

volatile DispatchQueue selectorQueue

canceled

final java.util.concurrent.atomic.AtomicBoolean canceled

interestOps

final int interestOps

cancelHandler

Task cancelHandler

eventHandler

Task eventHandler

keyState

final java.lang.ThreadLocal<NioDispatchSource.KeyState> keyState

updateInterestTask

private Task updateInterestTask

Constructor Detail

NioDispatchSource

public NioDispatchSource(HawtDispatcher dispatcher,
                         java.nio.channels.SelectableChannel channel,
                         int interestOps,
                         DispatchQueue targetQueue)

Method Detail

opsToString

private static java.lang.String opsToString(int ops)

pickThreadQueue

private static DispatchQueue pickThreadQueue(HawtDispatcher dispatcher,
                                             DispatchQueue targetQueue)

onStartup

protected void onStartup()

Overrides:

onStartup in class BaseSuspendable

cancel

public void cancel()

Description copied from interface: DispatchSource

Asynchronously cancel the dispatch source, preventing any further invocation of its event handler runnable.

Cancellation prevents any further invocation of the event handler runnable for the specified dispatch source, but does not interrupt an event handler runnable that is already in progress.

The cancellation handler is submitted to the source's target queue once the the source's event handler has finished, indicating it is now safe to close the source's handle.

Specified by:

cancel in interface DispatchSource

See Also:

DispatchSource.setCancelHandler(Runnable)

internal_cancel

void internal_cancel()

getCurrentNioManager

private NioManager getCurrentNioManager()

key_cancel

private void key_cancel()

register_on

private void register_on(DispatchQueue queue)

fire

public void fire(int readyOps)

updateInterest

private void updateInterest()

isCurrent

private boolean isCurrent(DispatchQueue q)

onSuspend

protected void onSuspend()

Overrides:

onSuspend in class BaseSuspendable

onResume

protected void onResume()

Overrides:

onResume in class BaseSuspendable

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface DispatchSource

Returns:

true if the dispatch source has been canceled.

See Also:

DispatchSource.cancel()

setCancelHandler

@Deprecated
public void setCancelHandler(java.lang.Runnable handler)

Deprecated.

Description copied from interface: DispatchSource

Sets the cancellation handler runnable for the given dispatch source.

The cancellation handler (if specified) will be submitted to the source's target queue in response to a call to DispatchSource.cancel() once the system has released all references to the source's underlying handle and the source's event handler runnable has returned.

Specified by:

setCancelHandler in interface DispatchSource

Parameters:

handler - The cancellation handler runnable to submit to the source's target queue.

setEventHandler

@Deprecated
public void setEventHandler(java.lang.Runnable handler)

Deprecated.

Description copied from interface: DispatchSource

Sets the event handler runnable of this dispatch source.

Specified by:

setEventHandler in interface DispatchSource

Parameters:

handler - The event handler runnable to submit to the source's target queue.

setCancelHandler

public void setCancelHandler(Task cancelHandler)

Description copied from interface: DispatchSource

Sets the cancellation handler task for the given dispatch source.

The cancellation handler (if specified) will be submitted to the source's target queue in response to a call to DispatchSource.cancel() once the system has released all references to the source's underlying handle and the source's event handler runnable has returned.

Specified by:

setCancelHandler in interface DispatchSource

Parameters:

cancelHandler - The cancellation handler runnable to submit to the source's target queue.

setEventHandler

public void setEventHandler(Task eventHandler)

Description copied from interface: DispatchSource

Sets the event handler task of this dispatch source.

Specified by:

setEventHandler in interface DispatchSource

Parameters:

eventHandler - The event handler runnable to submit to the source's target queue.

getData

public java.lang.Void getData()

setTargetQueue

public void setTargetQueue(DispatchQueue next)

Description copied from interface: DispatchObject

Sets the target queue for this object.

An object's target queue is responsible for processing the object.

A dispatch queue's priority is inherited by its target queue. Use the Dispatch.getGlobalQueue() method to obtain suitable target queue of the desired priority.

A dispatch source's target queue specifies where its event handler and cancellation handler runnables will be submitted.

Specified by:

setTargetQueue in interface DispatchObject

Overrides:

setTargetQueue in class AbstractDispatchObject

Parameters:

next - The new target queue for the object. The queue is retained, and the previous one, if any, is released. The result of passing NULL in this parameter is undefined.

debug

protected void debug(java.lang.String str,
                     java.lang.Object... args)

debug

protected void debug(java.lang.Throwable thrown,
                     java.lang.String str,
                     java.lang.Object... args)