org.apache.hadoop.yarn.client.api.async

Class NMClientAsync.AbstractCallbackHandler

java.lang.Object

org.apache.hadoop.yarn.client.api.async.NMClientAsync.AbstractCallbackHandler

All Implemented Interfaces:

NMClientAsync.CallbackHandler

Enclosing class:

NMClientAsync

public abstract static class NMClientAsync.AbstractCallbackHandler
extends Object
implements NMClientAsync.CallbackHandler

The callback abstract class. The callback functions need to be implemented by NMClientAsync users. The APIs are called when responses from NodeManager are available.

Once a callback happens, the users can chose to act on it in blocking or non-blocking manner. If the action on callback is done in a blocking manner, some of the threads performing requests on NodeManagers may get blocked depending on how many threads in the pool are busy.

The implementation of the callback functions should not throw the unexpected exception. Otherwise, NMClientAsync will just catch, log and then ignore it.

Constructor Summary

Constructors

Constructor and Description
AbstractCallbackHandler()

Method Summary

Modifier and Type	Method and Description
abstract void	onContainerResourceIncreased(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.Resource resource) The API is called when NodeManager responds to indicate the container resource has been successfully increased.
abstract void	onContainerStarted(org.apache.hadoop.yarn.api.records.ContainerId containerId, Map<String,ByteBuffer> allServiceResponse) The API is called when NodeManager responds to indicate its acceptance of the starting container request.
abstract void	onContainerStatusReceived(org.apache.hadoop.yarn.api.records.ContainerId containerId, org.apache.hadoop.yarn.api.records.ContainerStatus containerStatus) The API is called when NodeManager responds with the status of the container.
abstract void	onContainerStopped(org.apache.hadoop.yarn.api.records.ContainerId containerId) The API is called when NodeManager responds to indicate the container is stopped.
abstract void	onGetContainerStatusError(org.apache.hadoop.yarn.api.records.ContainerId containerId, Throwable t) The API is called when an exception is raised in the process of querying the status of a container.
abstract void	onIncreaseContainerResourceError(org.apache.hadoop.yarn.api.records.ContainerId containerId, Throwable t) The API is called when an exception is raised in the process of increasing container resource.
abstract void	onStartContainerError(org.apache.hadoop.yarn.api.records.ContainerId containerId, Throwable t) The API is called when an exception is raised in the process of starting a container.
abstract void	onStopContainerError(org.apache.hadoop.yarn.api.records.ContainerId containerId, Throwable t) The API is called when an exception is raised in the process of stopping a container.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCallbackHandler

public AbstractCallbackHandler()

Method Detail

onContainerStarted

public abstract void onContainerStarted(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                        Map<String,ByteBuffer> allServiceResponse)

The API is called when NodeManager responds to indicate its acceptance of the starting container request.

Specified by:

onContainerStarted in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

allServiceResponse - a Map between the auxiliary service names and their outputs

onContainerStatusReceived

public abstract void onContainerStatusReceived(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                               org.apache.hadoop.yarn.api.records.ContainerStatus containerStatus)

The API is called when NodeManager responds with the status of the container.

Specified by:

onContainerStatusReceived in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

containerStatus - the status of the container

onContainerStopped

public abstract void onContainerStopped(org.apache.hadoop.yarn.api.records.ContainerId containerId)

The API is called when NodeManager responds to indicate the container is stopped.

Specified by:

onContainerStopped in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

onStartContainerError

public abstract void onStartContainerError(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                           Throwable t)

The API is called when an exception is raised in the process of starting a container.

Specified by:

onStartContainerError in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

t - the raised exception

onContainerResourceIncreased

public abstract void onContainerResourceIncreased(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                                  org.apache.hadoop.yarn.api.records.Resource resource)

The API is called when NodeManager responds to indicate the container resource has been successfully increased.

Parameters:

containerId - the Id of the container

resource - the target resource of the container

onGetContainerStatusError

public abstract void onGetContainerStatusError(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                               Throwable t)

The API is called when an exception is raised in the process of querying the status of a container.

Specified by:

onGetContainerStatusError in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

t - the raised exception

onIncreaseContainerResourceError

public abstract void onIncreaseContainerResourceError(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                                      Throwable t)

The API is called when an exception is raised in the process of increasing container resource.

Parameters:

containerId - the Id of the container

t - the raised exception

onStopContainerError

public abstract void onStopContainerError(org.apache.hadoop.yarn.api.records.ContainerId containerId,
                                          Throwable t)

The API is called when an exception is raised in the process of stopping a container.

Specified by:

onStopContainerError in interface NMClientAsync.CallbackHandler

Parameters:

containerId - the Id of the container

t - the raised exception