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

Class ContainerManagementProtocolPBClientImpl

java.lang.Object

org.apache.hadoop.yarn.api.impl.pb.client.ContainerManagementProtocolPBClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, ContainerManagementProtocol

@InterfaceAudience.Private
public class ContainerManagementProtocolPBClientImpl
extends Object
implements ContainerManagementProtocol, Closeable

Constructor Summary

Constructors

Constructor and Description
ContainerManagementProtocolPBClientImpl(long clientVersion, InetSocketAddress addr, Configuration conf)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
GetContainerStatusesResponse	getContainerStatuses(GetContainerStatusesRequest request) The API used by the ApplicationMaster to request for current statuses of Containers from the NodeManager.
StartContainersResponse	startContainers(StartContainersRequest requests) The ApplicationMaster provides a list of StartContainerRequests to a NodeManager to start Containers allocated to it using this interface.
StopContainersResponse	stopContainers(StopContainersRequest requests) The ApplicationMaster requests a NodeManager to stop a list of Containers allocated to it using this interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerManagementProtocolPBClientImpl

public ContainerManagementProtocolPBClientImpl(long clientVersion,
                                       InetSocketAddress addr,
                                       Configuration conf)
                                        throws IOException

Throws:

IOException

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

startContainers

public StartContainersResponse startContainers(StartContainersRequest requests)
                                        throws YarnException,
                                               IOException

Description copied from interface: ContainerManagementProtocol

The ApplicationMaster provides a list of StartContainerRequests to a NodeManager to start Containers allocated to it using this interface.

The ApplicationMaster has to provide details such as allocated resource capability, security tokens (if enabled), command to be executed to start the container, environment for the process, necessary binaries/jar/shared-objects etc. via the ContainerLaunchContext in the StartContainerRequest.

The NodeManager sends a response via StartContainersResponse which includes a list of Containers of successfully launched Containers, a containerId-to-exception map for each failed StartContainerRequest in which the exception indicates errors from per container and a allServicesMetaData map between the names of auxiliary services and their corresponding meta-data. Note: None-container-specific exceptions will still be thrown by the API method itself.

The ApplicationMaster can use ContainerManagementProtocol.getContainerStatuses(GetContainerStatusesRequest) to get updated statuses of the to-be-launched or launched containers.

Specified by:

startContainers in interface ContainerManagementProtocol

Parameters:

requests - request to start a list of containers

Returns:

response including conatinerIds of all successfully launched containers, a containerId-to-exception map for failed requests and a allServicesMetaData map.

Throws:

YarnException

NMNotYetReadyException - This exception is thrown when NM starts from scratch but has not yet connected with RM.

IOException

stopContainers

public StopContainersResponse stopContainers(StopContainersRequest requests)
                                      throws YarnException,
                                             IOException

Description copied from interface: ContainerManagementProtocol

The ApplicationMaster requests a NodeManager to stop a list of Containers allocated to it using this interface.

The ApplicationMaster sends a StopContainersRequest which includes the ContainerIds of the containers to be stopped.

The NodeManager sends a response via StopContainersResponse which includes a list of ContainerId s of successfully stopped containers, a containerId-to-exception map for each failed request in which the exception indicates errors from per container. Note: None-container-specific exceptions will still be thrown by the API method itself. ApplicationMaster can use ContainerManagementProtocol.getContainerStatuses(GetContainerStatusesRequest) to get updated statuses of the containers.

Specified by:

stopContainers in interface ContainerManagementProtocol

Parameters:

requests - request to stop a list of containers

Returns:

response which includes a list of containerIds of successfully stopped containers, a containerId-to-exception map for failed requests.

Throws:

YarnException

IOException

getContainerStatuses

public GetContainerStatusesResponse getContainerStatuses(GetContainerStatusesRequest request)
                                                  throws YarnException,
                                                         IOException

Description copied from interface: ContainerManagementProtocol

The API used by the ApplicationMaster to request for current statuses of Containers from the NodeManager.

The ApplicationMaster sends a GetContainerStatusesRequest which includes the ContainerIds of all containers whose statuses are needed.

The NodeManager responds with GetContainerStatusesResponse which includes a list of ContainerStatus of the successfully queried containers and a containerId-to-exception map for each failed request in which the exception indicates errors from per container. Note: None-container-specific exceptions will still be thrown by the API method itself.

Specified by:

getContainerStatuses in interface ContainerManagementProtocol

Parameters:

request - request to get ContainerStatuses of containers with the specified ContainerIds

Returns:

response containing the list of ContainerStatus of the successfully queried containers and a containerId-to-exception map for failed requests.

Throws:

YarnException

IOException