akka.remote.transport

Class AbstractTransportAdapter

java.lang.Object

akka.remote.transport.AbstractTransportAdapter

All Implemented Interfaces:

SchemeAugmenter, Transport

Direct Known Subclasses:

ActorTransportAdapter, FailureInjectorTransportAdapter

public abstract class AbstractTransportAdapter
extends java.lang.Object
implements Transport, SchemeAugmenter

An adapter that wraps a transport and provides interception

Nested Class Summary

Nested classes/interfaces inherited from interface akka.remote.transport.Transport

Transport.ActorAssociationEventListener, Transport.ActorAssociationEventListener$, Transport.AssociationEvent, Transport.AssociationEventListener, Transport.InboundAssociation, Transport.InboundAssociation$, Transport.InvalidAssociationException, Transport.InvalidAssociationException$

Constructor Summary

Constructors

Constructor and Description
AbstractTransportAdapter(Transport wrappedTransport, scala.concurrent.ExecutionContext ec)

Method Summary

Modifier and Type	Method and Description
scala.concurrent.Future<AssociationHandle>	associate(akka.actor.Address remoteAddress) Asynchronously opens a logical duplex link between two Transport Entities over a network.
akka.actor.Address	boundAddress()
scala.concurrent.ExecutionContext	ec()
protected abstract void	interceptAssociate(akka.actor.Address remoteAddress, scala.concurrent.Promise<AssociationHandle> statusPromise)
protected abstract scala.concurrent.Future<Transport.AssociationEventListener>	interceptListen(akka.actor.Address listenAddress, scala.concurrent.Future<Transport.AssociationEventListener> listenerFuture)
boolean	isResponsibleFor(akka.actor.Address address) A function that decides whether the specific transport instance is responsible for delivering to a given address.
scala.concurrent.Future<scala.Tuple2<akka.actor.Address,scala.concurrent.Promise<Transport.AssociationEventListener>>>	listen() Asynchronously attempts to setup the transport layer to listen and accept incoming associations.
protected abstract int	maximumOverhead()
int	maximumPayloadBytes() Defines the maximum size of payload this transport is able to deliver.
java.lang.String	schemeIdentifier() Returns a string that will be used as the scheme part of the URLs corresponding to this transport
scala.concurrent.Future<java.lang.Object>	shutdown() Shuts down the transport layer and releases all the corresponding resources.
protected Transport	wrappedTransport()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.remote.transport.Transport

managementCommand

Methods inherited from interface akka.remote.transport.SchemeAugmenter

addedSchemeIdentifier, augmentScheme, augmentScheme, removeScheme, removeScheme

Constructor Detail

AbstractTransportAdapter

public AbstractTransportAdapter(Transport wrappedTransport,
                                scala.concurrent.ExecutionContext ec)

Method Detail

wrappedTransport

protected Transport wrappedTransport()

ec

public scala.concurrent.ExecutionContext ec()

maximumOverhead

protected abstract int maximumOverhead()

interceptListen

protected abstract scala.concurrent.Future<Transport.AssociationEventListener> interceptListen(akka.actor.Address listenAddress,
                                                                                               scala.concurrent.Future<Transport.AssociationEventListener> listenerFuture)

interceptAssociate

protected abstract void interceptAssociate(akka.actor.Address remoteAddress,
                                           scala.concurrent.Promise<AssociationHandle> statusPromise)

schemeIdentifier

public java.lang.String schemeIdentifier()

Description copied from interface: Transport

Returns a string that will be used as the scheme part of the URLs corresponding to this transport

Specified by:

schemeIdentifier in interface Transport

Returns:

the scheme string

isResponsibleFor

public boolean isResponsibleFor(akka.actor.Address address)

Description copied from interface: Transport

A function that decides whether the specific transport instance is responsible for delivering to a given address. The function must be thread-safe and non-blocking.

The purpose of this function is to resolve cases when the scheme part of an URL is not enough to resolve the correct transport i.e. multiple instances of the same transport implementation are loaded. These cases arise when - the same transport, but with different configurations is used for different remote systems - a transport is able to serve one address only (hardware protocols, e.g. Serial port) and multiple instances are needed to be loaded for different endpoints.

Specified by:

isResponsibleFor in interface Transport

Parameters:

address - (undocumented)

Returns:

whether the transport instance is responsible to serve communications to the given address.

maximumPayloadBytes

public int maximumPayloadBytes()

Description copied from interface: Transport

Defines the maximum size of payload this transport is able to deliver. All transports MUST support at least 32kBytes (32000 octets) of payload, but some MAY support larger sizes.

Specified by:

maximumPayloadBytes in interface Transport

Returns:

listen

public scala.concurrent.Future<scala.Tuple2<akka.actor.Address,scala.concurrent.Promise<Transport.AssociationEventListener>>> listen()

Description copied from interface: Transport

Asynchronously attempts to setup the transport layer to listen and accept incoming associations. The result of the attempt is wrapped by a Future returned by this method. The pair contained in the future contains a Promise for an ActorRef. By completing this Promise with an Transport.AssociationEventListener, that listener becomes responsible for handling incoming associations. Until the Promise is not completed, no associations are processed.

Specified by:

listen in interface Transport

Returns:

A Future containing a pair of the bound local address and a Promise of an AssociationListener that must be completed by the consumer of the future.

boundAddress

public akka.actor.Address boundAddress()

Specified by:

boundAddress in interface Transport

Returns:

The address this Transport is listening to.

associate

public scala.concurrent.Future<AssociationHandle> associate(akka.actor.Address remoteAddress)

Description copied from interface: Transport

Asynchronously opens a logical duplex link between two Transport Entities over a network. It could be backed by a real transport-layer connection (TCP), more lightweight connections provided over datagram protocols (UDP with additional services), substreams of multiplexed connections (SCTP) or physical links (serial port).

This call returns a future of an AssociationHandle. A failed future indicates that the association attempt was unsuccessful. If the exception is Transport.InvalidAssociationException then the association request was invalid, and it is impossible to recover.

Specified by:

associate in interface Transport

Parameters:

remoteAddress - The address of the remote transport entity.

Returns:

A status instance representing failure or a success containing an AssociationHandle

shutdown

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

Description copied from interface: Transport

Shuts down the transport layer and releases all the corresponding resources. Shutdown is asynchronous signalling the end of the shutdown by completing the returned future.

The transport SHOULD try flushing pending writes before becoming completely closed.

Specified by:

shutdown in interface Transport

Returns:

Future signalling the completion of shutdown