akka.remote

Class Remoting

java.lang.Object

akka.remote.RemoteTransport

akka.remote.Remoting

public class Remoting
extends RemoteTransport

INTERNAL API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Remoting.RegisterTransportActor
static class	Remoting.RegisterTransportActor$
static class	Remoting.TransportSupervisor

Constructor Summary

Constructors

Constructor and Description
Remoting(akka.actor.ExtendedActorSystem _system, RemoteActorRefProvider _provider)

Method Summary

Modifier and Type	Method and Description
scala.collection.immutable.Set<akka.actor.Address>	addresses() Address to be used in RootActorPath of refs generated for this transport.
scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<akka.actor.Address>>	boundAddresses()
akka.actor.Address	defaultAddress() The default transport address of the actorsystem
static java.lang.String	EndpointManagerName()
EventPublisher	eventPublisher()
akka.actor.Address	localAddressForRemote(akka.actor.Address remote) Resolves the correct local address to be used for contacting the given remote address
akka.event.LoggingAdapter	log() A Logger that can be used to log issues that may occur
protected boolean	logRemoteLifeCycleEvents() When this method returns true, RemoteLifeCycleEvents will be logged as well as be put onto the eventStream.
scala.concurrent.Future<java.lang.Object>	managementCommand(java.lang.Object cmd) Sends a management command to the underlying transport stack.
void	quarantine(akka.actor.Address remoteAddress, scala.Option<java.lang.Object> uid) Marks a remote system as out of sync and prevents reconnects until the quarantine timeout elapses.
void	send(java.lang.Object message, scala.Option<akka.actor.ActorRef> senderOption, RemoteActorRef recipient) Sends the given message to the recipient supplying the sender() if any
scala.concurrent.Future<scala.runtime.BoxedUnit>	shutdown() Shuts down the remoting
void	start() Start up the transport, i.e.
akka.actor.ActorRef	transportSupervisor()
protected boolean	useUntrustedMode() When this method returns true, some functionality will be turned off for security purposes.

Methods inherited from class akka.remote.RemoteTransport

provider, system

Methods inherited from class java.lang.Object

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

Constructor Detail

Remoting

public Remoting(akka.actor.ExtendedActorSystem _system,
                RemoteActorRefProvider _provider)

Method Detail

EndpointManagerName

public static final java.lang.String EndpointManagerName()

addresses

public scala.collection.immutable.Set<akka.actor.Address> addresses()

Description copied from class: RemoteTransport

Address to be used in RootActorPath of refs generated for this transport.

Specified by:

addresses in class RemoteTransport

Returns:

(undocumented)

defaultAddress

public akka.actor.Address defaultAddress()

Description copied from class: RemoteTransport

The default transport address of the actorsystem

Specified by:

defaultAddress in class RemoteTransport

Returns:

The listen address of the default transport

transportSupervisor

public akka.actor.ActorRef transportSupervisor()

localAddressForRemote

public akka.actor.Address localAddressForRemote(akka.actor.Address remote)

Description copied from class: RemoteTransport

Resolves the correct local address to be used for contacting the given remote address

Specified by:

localAddressForRemote in class RemoteTransport

Parameters:

remote - the remote address

Returns:

the local address to be used for the given remote address

log

public akka.event.LoggingAdapter log()

Description copied from class: RemoteTransport

A Logger that can be used to log issues that may occur

Specified by:

log in class RemoteTransport

Returns:

(undocumented)

eventPublisher

public EventPublisher eventPublisher()

shutdown

public scala.concurrent.Future<scala.runtime.BoxedUnit> shutdown()

Description copied from class: RemoteTransport

Shuts down the remoting

Specified by:

shutdown in class RemoteTransport

Returns:

(undocumented)

start

public void start()

Description copied from class: RemoteTransport

Start up the transport, i.e. enable incoming connections.

Specified by:

start in class RemoteTransport

send

public void send(java.lang.Object message,
                 scala.Option<akka.actor.ActorRef> senderOption,
                 RemoteActorRef recipient)

Description copied from class: RemoteTransport

Sends the given message to the recipient supplying the sender() if any

Specified by:

send in class RemoteTransport

Parameters:

message - (undocumented)

senderOption - (undocumented)

recipient - (undocumented)

managementCommand

public scala.concurrent.Future<java.lang.Object> managementCommand(java.lang.Object cmd)

Description copied from class: RemoteTransport

Sends a management command to the underlying transport stack. The call returns with a Future that indicates if the command was handled successfully or dropped.

Overrides:

managementCommand in class RemoteTransport

Parameters:

cmd - Command message to send to the transports.

Returns:

A Future that indicates when the message was successfully handled or dropped.

quarantine

public void quarantine(akka.actor.Address remoteAddress,
                       scala.Option<java.lang.Object> uid)

Description copied from class: RemoteTransport

Marks a remote system as out of sync and prevents reconnects until the quarantine timeout elapses.

Specified by:

quarantine in class RemoteTransport

Parameters:

remoteAddress - Address of the remote system to be quarantined

uid - UID of the remote system, if the uid is not defined it will not be a strong quarantine but the current endpoint writer will be stopped (dropping system messages) and the address will be gated

useUntrustedMode

protected boolean useUntrustedMode()

Description copied from class: RemoteTransport

When this method returns true, some functionality will be turned off for security purposes.

Specified by:

useUntrustedMode in class RemoteTransport

Returns:

(undocumented)

boundAddresses

public scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.Set<akka.actor.Address>> boundAddresses()

logRemoteLifeCycleEvents

protected boolean logRemoteLifeCycleEvents()

When this method returns true, RemoteLifeCycleEvents will be logged as well as be put onto the eventStream. NOTE: This is currently not called anywhere.

Specified by:

logRemoteLifeCycleEvents in class RemoteTransport

Returns:

(undocumented)