org.apache.spark.internal.plugin

Class PluginContextImpl

Object

org.apache.spark.internal.plugin.PluginContextImpl

All Implemented Interfaces:

PluginContext, Logging

public class PluginContextImpl
extends Object
implements PluginContext, Logging

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PluginContextImpl.PluginMetricsSource

Constructor Summary

Constructors

Constructor and Description
PluginContextImpl(String pluginName, org.apache.spark.rpc.RpcEnv rpcEnv, org.apache.spark.metrics.MetricsSystem metricsSystem, SparkConf conf, String executorID)

Method Summary

Modifier and Type	Method and Description
Object	ask(Object message) Send an RPC to the plugin's driver-side component.
SparkConf	conf() Configuration of the Spark application.
String	executorID() Executor ID of the process.
String	hostname() The host name which is being used by the Spark process for communication.
com.codahale.metrics.MetricRegistry	metricRegistry() Registry where to register metrics published by the plugin associated with this context.
void	registerMetrics()
void	send(Object message) Send a message to the plugin's driver-side component.

Methods inherited from class Object

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

Methods inherited from interface org.apache.spark.internal.Logging

initializeForcefully, initializeLogging, initializeLogIfNecessary, initializeLogIfNecessary, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

PluginContextImpl

public PluginContextImpl(String pluginName,
                         org.apache.spark.rpc.RpcEnv rpcEnv,
                         org.apache.spark.metrics.MetricsSystem metricsSystem,
                         SparkConf conf,
                         String executorID)

Method Detail

ask

public Object ask(Object message)

Description copied from interface: PluginContext

Send an RPC to the plugin's driver-side component.

This method sends a message to the driver-side component of the plugin, and blocks until a reply arrives, or the configured RPC ask timeout (spark.rpc.askTimeout) elapses.

If the driver replies with an error, an exception with the corresponding error will be thrown.

The message must be serializable.

Specified by:

ask in interface PluginContext

Parameters:

message - Message to be sent.

Returns:

The reply from the driver-side component.

conf

public SparkConf conf()

Description copied from interface: PluginContext

Configuration of the Spark application.

Specified by:

conf in interface PluginContext

executorID

public String executorID()

Description copied from interface: PluginContext

Executor ID of the process. On the driver, this will identify the driver.

Specified by:

executorID in interface PluginContext

hostname

public String hostname()

Description copied from interface: PluginContext

The host name which is being used by the Spark process for communication.

Specified by:

hostname in interface PluginContext

metricRegistry

public com.codahale.metrics.MetricRegistry metricRegistry()

Description copied from interface: PluginContext

Registry where to register metrics published by the plugin associated with this context.

Specified by:

metricRegistry in interface PluginContext

registerMetrics

public void registerMetrics()

send

public void send(Object message)

Description copied from interface: PluginContext

Send a message to the plugin's driver-side component.

This method sends a message to the driver-side component of the plugin, without expecting a reply. It returns as soon as the message is enqueued for sending.

The message must be serializable.

Specified by:

send in interface PluginContext

Parameters:

message - Message to be sent.