org.apache.flink.runtime.instance

Interface ActorGateway

All Superinterfaces:

Serializable

All Known Implementing Classes:

AkkaActorGateway

public interface ActorGateway
extends Serializable

Interface to abstract the communication with an actor. It allows to avoid direct interaction with an ActorRef.

Method Summary

Modifier and Type	Method and Description
akka.actor.ActorRef	actor() Returns the underlying actor with which is communicated
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 path 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.

Method Detail

ask

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.

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

void tell(Object message)

Sends a message asynchronously without a result.

Parameters:

message - Message to be sent

tell

void tell(Object message,
          ActorGateway sender)

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

Parameters:

message - Message to be sent

sender - Sender of the message

forward

void forward(Object message,
             ActorGateway sender)

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

Parameters:

message - Message to be sent

sender - Sender of the forwarded message

retry

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.

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

String path()

Returns the path of the remote instance.

Returns:

Path of the remote instance.

actor

akka.actor.ActorRef actor()

Returns the underlying actor with which is communicated

Returns:

ActorRef of the target actor

leaderSessionID

UUID leaderSessionID()

Returns the leaderSessionID associated with the remote actor or null.

Returns:

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