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

Class AMRMClientAsyncImpl<T extends AMRMClient.ContainerRequest>

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.client.api.async.AMRMClientAsync<T>

org.apache.hadoop.yarn.client.api.async.impl.AMRMClientAsyncImpl<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class AMRMClientAsyncImpl<T extends AMRMClient.ContainerRequest>
extends AMRMClientAsync<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.yarn.client.api.async.AMRMClientAsync

AMRMClientAsync.CallbackHandler

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

Service.STATE

Field Summary

Fields inherited from class org.apache.hadoop.yarn.client.api.async.AMRMClientAsync

client, handler, heartbeatIntervalMs

Constructor Summary

Constructors

Constructor and Description
AMRMClientAsyncImpl(AMRMClient<T> client, int intervalMs, AMRMClientAsync.CallbackHandler callbackHandler)
AMRMClientAsyncImpl(int intervalMs, AMRMClientAsync.CallbackHandler callbackHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	addContainerRequest(T req) Request containers for resources before calling allocate
Resource	getAvailableResources() Get the currently available resources in the cluster.
int	getClusterNodeCount() Get the current number of nodes in the cluster.
List<? extends Collection<T>>	getMatchingRequests(Priority priority, String resourceName, Resource capability)
RegisterApplicationMasterResponse	registerApplicationMaster(String appHostName, int appHostPort, String appTrackingUrl) Registers this application master with the resource manager.
void	releaseAssignedContainer(ContainerId containerId) Release containers assigned by the Resource Manager.
void	removeContainerRequest(T req) Remove previous container request.
protected void	serviceInit(Configuration conf) All initialization code needed by a service.
protected void	serviceStart() Actions called during the INITED to STARTED transition.
protected void	serviceStop() Tells the heartbeat and handler threads to stop and waits for them to terminate.
void	setHeartbeatInterval(int interval)
void	unregisterApplicationMaster(FinalApplicationStatus appStatus, String appMessage, String appTrackingUrl) Unregister the application master.

Methods inherited from class org.apache.hadoop.yarn.client.api.async.AMRMClientAsync

createAMRMClientAsync, createAMRMClientAsync

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

Constructor Detail

AMRMClientAsyncImpl

public AMRMClientAsyncImpl(int intervalMs,
                   AMRMClientAsync.CallbackHandler callbackHandler)

AMRMClientAsyncImpl

@InterfaceAudience.Private
public AMRMClientAsyncImpl(AMRMClient<T> client,
                                             int intervalMs,
                                             AMRMClientAsync.CallbackHandler callbackHandler)

Method Detail

serviceInit

protected void serviceInit(Configuration conf)
                    throws Exception

Description copied from class: AbstractService

All initialization code needed by a service. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.init(Configuration) prevents re-entrancy. The base implementation checks to see if the subclass has created a new configuration instance, and if so, updates the base class value

Overrides:

serviceInit in class AbstractService

Parameters:

conf - configuration

Throws:

Exception - on a failure -these will be caught, possibly wrapped, and wil; trigger a service stop

serviceStart

protected void serviceStart()
                     throws Exception

Description copied from class: AbstractService

Actions called during the INITED to STARTED transition. This method will only ever be called once during the lifecycle of a specific service instance. Implementations do not need to be synchronized as the logic in AbstractService.start() prevents re-entrancy.

Overrides:

serviceStart in class AbstractService

Throws:

Exception - if needed -these will be caught, wrapped, and trigger a service stop

serviceStop

protected void serviceStop()
                    throws Exception

Tells the heartbeat and handler threads to stop and waits for them to terminate.

Overrides:

serviceStop in class AbstractService

Throws:

Exception - if needed -these will be caught and logged.

setHeartbeatInterval

public void setHeartbeatInterval(int interval)

Overrides:

setHeartbeatInterval in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

getMatchingRequests

public List<? extends Collection<T>> getMatchingRequests(Priority priority,
                                                String resourceName,
                                                Resource capability)

Specified by:

getMatchingRequests in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

registerApplicationMaster

public RegisterApplicationMasterResponse registerApplicationMaster(String appHostName,
                                                          int appHostPort,
                                                          String appTrackingUrl)
                                                            throws YarnException,
                                                                   IOException

Registers this application master with the resource manager. On successful registration, starts the heartbeating thread.

Specified by:

registerApplicationMaster in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Throws:

YarnException

IOException

unregisterApplicationMaster

public void unregisterApplicationMaster(FinalApplicationStatus appStatus,
                               String appMessage,
                               String appTrackingUrl)
                                 throws YarnException,
                                        IOException

Unregister the application master. This must be called in the end.

Specified by:

unregisterApplicationMaster in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Parameters:

appStatus - Success/Failure status of the master

appMessage - Diagnostics message on failure

appTrackingUrl - New URL to get master info

Throws:

YarnException

IOException

addContainerRequest

public void addContainerRequest(T req)

Request containers for resources before calling allocate

Specified by:

addContainerRequest in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Parameters:

req - Resource request

removeContainerRequest

public void removeContainerRequest(T req)

Remove previous container request. The previous container request may have already been sent to the ResourceManager. So even after the remove request the app must be prepared to receive an allocation for the previous request even after the remove request

Specified by:

removeContainerRequest in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Parameters:

req - Resource request

releaseAssignedContainer

public void releaseAssignedContainer(ContainerId containerId)

Release containers assigned by the Resource Manager. If the app cannot use the container or wants to give up the container then it can release them. The app needs to make new requests for the released resource capability if it still needs it. eg. it released non-local resources

Specified by:

releaseAssignedContainer in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Parameters:

containerId -

getAvailableResources

public Resource getAvailableResources()

Get the currently available resources in the cluster. A valid value is available after a call to allocate has been made

Specified by:

getAvailableResources in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Returns:

Currently available resources

getClusterNodeCount

public int getClusterNodeCount()

Get the current number of nodes in the cluster. A valid values is available after a call to allocate has been made

Specified by:

getClusterNodeCount in class AMRMClientAsync<T extends AMRMClient.ContainerRequest>

Returns:

Current number of nodes in the cluster