org.apache.tez.common

Class AsyncDispatcher

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.tez.common.AsyncDispatcher

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service, org.apache.hadoop.yarn.event.Dispatcher

@InterfaceAudience.Private
public class AsyncDispatcher
extends org.apache.hadoop.service.CompositeService
implements org.apache.hadoop.yarn.event.Dispatcher

Dispatches Events in a separate thread. Currently only single thread does that. Potentially there could be multiple channels for each event type class and a thread pool can be used to dispatch the events.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Class<? extends Enum>,AsyncDispatcherConcurrent>	concurrentEventDispatchers
protected Map<Class<? extends Enum>,AsyncDispatcher>	eventDispatchers
protected Map<Class<? extends Enum>,org.apache.hadoop.yarn.event.EventHandler>	eventHandlers

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Fields inherited from interface org.apache.hadoop.yarn.event.Dispatcher

DEFAULT_DISPATCHER_EXIT_ON_ERROR, DISPATCHER_EXIT_ON_ERROR_KEY

Constructor Summary

Constructors

Constructor and Description
AsyncDispatcher(String name)
AsyncDispatcher(String name, BlockingQueue<org.apache.hadoop.yarn.event.Event> eventQueue)

Method Summary

Modifier and Type	Method and Description
protected void	checkForExistingDispatchers(boolean checkHandler, Class<? extends Enum> eventType)
Runnable	createThread()
protected void	dispatch(org.apache.hadoop.yarn.event.Event event)
void	enableExitOnDispatchException()
org.apache.hadoop.yarn.event.EventHandler	getEventHandler()
int	getQueueSize()
void	register(Class<? extends Enum> eventType, org.apache.hadoop.yarn.event.EventHandler handler) Add an EventHandler for events handled inline on this dispatcher
void	registerAndCreateDispatcher(Class<? extends Enum> eventType, org.apache.hadoop.yarn.event.EventHandler handler, String dispatcherName) Add an EventHandler for events handled in their own dispatchers with given name
AsyncDispatcherConcurrent	registerAndCreateDispatcher(Class<? extends Enum> eventType, org.apache.hadoop.yarn.event.EventHandler handler, String dispatcherName, int numThreads)
void	registerWithExistingDispatcher(Class<? extends Enum> eventType, org.apache.hadoop.yarn.event.EventHandler handler, AsyncDispatcherConcurrent dispatcher)
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf)
protected void	serviceStart()
protected void	serviceStop()
void	setDrainEventsOnStop()

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

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

Field Detail

eventHandlers

protected final Map<Class<? extends Enum>,org.apache.hadoop.yarn.event.EventHandler> eventHandlers

eventDispatchers

protected final Map<Class<? extends Enum>,AsyncDispatcher> eventDispatchers

concurrentEventDispatchers

protected final Map<Class<? extends Enum>,AsyncDispatcherConcurrent> concurrentEventDispatchers

Constructor Detail

AsyncDispatcher

public AsyncDispatcher(String name)

AsyncDispatcher

public AsyncDispatcher(String name,
                       BlockingQueue<org.apache.hadoop.yarn.event.Event> eventQueue)

Method Detail

createThread

public Runnable createThread()

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception

Overrides:

serviceInit in class org.apache.hadoop.service.CompositeService

Throws:

Exception

serviceStart

protected void serviceStart()
                     throws Exception

Overrides:

serviceStart in class org.apache.hadoop.service.CompositeService

Throws:

Exception

setDrainEventsOnStop

public void setDrainEventsOnStop()

serviceStop

protected void serviceStop()
                    throws Exception

Overrides:

serviceStop in class org.apache.hadoop.service.CompositeService

Throws:

Exception

dispatch

protected void dispatch(org.apache.hadoop.yarn.event.Event event)

checkForExistingDispatchers

protected void checkForExistingDispatchers(boolean checkHandler,
                                           Class<? extends Enum> eventType)

enableExitOnDispatchException

public void enableExitOnDispatchException()

register

public void register(Class<? extends Enum> eventType,
                     org.apache.hadoop.yarn.event.EventHandler handler)

Add an EventHandler for events handled inline on this dispatcher

Specified by:

register in interface org.apache.hadoop.yarn.event.Dispatcher

registerAndCreateDispatcher

public void registerAndCreateDispatcher(Class<? extends Enum> eventType,
                                        org.apache.hadoop.yarn.event.EventHandler handler,
                                        String dispatcherName)

Add an EventHandler for events handled in their own dispatchers with given name

registerAndCreateDispatcher

public AsyncDispatcherConcurrent registerAndCreateDispatcher(Class<? extends Enum> eventType,
                                                             org.apache.hadoop.yarn.event.EventHandler handler,
                                                             String dispatcherName,
                                                             int numThreads)

registerWithExistingDispatcher

public void registerWithExistingDispatcher(Class<? extends Enum> eventType,
                                           org.apache.hadoop.yarn.event.EventHandler handler,
                                           AsyncDispatcherConcurrent dispatcher)

getEventHandler

public org.apache.hadoop.yarn.event.EventHandler getEventHandler()

Specified by:

getEventHandler in interface org.apache.hadoop.yarn.event.Dispatcher

getQueueSize

@InterfaceAudience.Private
public int getQueueSize()