org.apache.flink.runtime.instance

Class AkkaActorGateway

java.lang.Object

org.apache.flink.runtime.instance.AkkaActorGateway

All Implemented Interfaces:

Serializable, ActorGateway

public class AkkaActorGateway
extends Object
implements ActorGateway, Serializable

Concrete ActorGateway implementation which uses Akka to communicate with remote actors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AkkaActorGateway(akka.actor.ActorRef actor, UUID leaderSessionID)

Method Summary

Modifier and Type	Method and Description
akka.actor.ActorRef	actor() Returns ActorRef of the target actor
scala.concurrent.Future<Object>	ask(Object message, scala.concurrent.duration.FiniteDuration timeout) Sends a message asynchronously and returns its response.
void	forward(Object message, ActorGateway sender) Forwards a message.
UUID	leaderSessionID() Returns the leaderSessionID associated with the remote actor or null.
String	path() Returns the ActorPath of the remote instance.
scala.concurrent.Future<Object>	retry(Object message, int numberRetries, scala.concurrent.duration.FiniteDuration timeout, scala.concurrent.ExecutionContext executionContext) Retries to send asynchronously a message up to numberRetries times.
void	tell(Object message) Sends a message asynchronously without a result.
void	tell(Object message, ActorGateway sender) Sends a message asynchronously without a result with sender being the sender.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AkkaActorGateway

public AkkaActorGateway(akka.actor.ActorRef actor,
                        UUID leaderSessionID)

Method Detail

ask

public scala.concurrent.Future<Object> ask(Object message,
                                           scala.concurrent.duration.FiniteDuration timeout)

Sends a message asynchronously and returns its response. The response to the message is returned as a future.

Specified by:

ask in interface ActorGateway

Parameters:

message - Message to be sent

timeout - Timeout until the Future is completed with an AskTimeoutException

Returns:

Future which contains the response to the sent message

tell

public void tell(Object message)

Sends a message asynchronously without a result.

Specified by:

tell in interface ActorGateway

Parameters:

message - Message to be sent

tell

public void tell(Object message,
                 ActorGateway sender)

Sends a message asynchronously without a result with sender being the sender.

Specified by:

tell in interface ActorGateway

Parameters:

message - Message to be sent

sender - Sender of the message

forward

public void forward(Object message,
                    ActorGateway sender)

Forwards a message. For the receiver of this message it looks as if sender has sent the message.

Specified by:

forward in interface ActorGateway

Parameters:

message - Message to be sent

sender - Sender of the forwarded message

retry

public scala.concurrent.Future<Object> retry(Object message,
                                             int numberRetries,
                                             scala.concurrent.duration.FiniteDuration timeout,
                                             scala.concurrent.ExecutionContext executionContext)

Retries to send asynchronously a message up to numberRetries times. The response to this message is returned as a future. The message is re-sent if the number of retries is not yet exceeded and if an exception occurred while sending it.

Specified by:

retry in interface ActorGateway

Parameters:

message - Message to be sent

numberRetries - Number of times to retry sending the message

timeout - Timeout for each sending attempt

executionContext - ExecutionContext which is used to send the message multiple times

Returns:

Future of the response to the sent message

path

public String path()

Returns the ActorPath of the remote instance.

Specified by:

path in interface ActorGateway

Returns:

ActorPath of the remote instance.

actor

public akka.actor.ActorRef actor()

Returns ActorRef of the target actor

Specified by:

actor in interface ActorGateway

Returns:

ActorRef of the target actor

leaderSessionID

public UUID leaderSessionID()

Description copied from interface: ActorGateway

Returns the leaderSessionID associated with the remote actor or null.

Specified by:

leaderSessionID in interface ActorGateway

Returns:

Leader session ID if its associated with this gateway, otherwise null

toString

public String toString()

Overrides:

toString in class Object