akka.remote.artery

Class Association

java.lang.Object

akka.remote.artery.Association

All Implemented Interfaces:

OutboundContext

public class Association
extends java.lang.Object
implements OutboundContext

INTERNAL API

Thread-safe, mutable holder for association state. Main entry point for remote destined message to a specific remote address.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Association.DisabledQueueWrapper$
static class	Association.LazyQueueWrapper
static class	Association.LazyQueueWrapper$
static class	Association.OutboundStreamMatValues
static class	Association.OutboundStreamMatValues$
static interface	Association.QueueWrapper
static class	Association.QueueWrapperImpl
static class	Association.QueueWrapperImpl$

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	sharedStateOffset

Constructor Summary

Constructors

Constructor and Description
Association(ArteryTransport transport, Materializer materializer, Materializer controlMaterializer, Address remoteAddress, InboundControlJunction.ControlMessageSubject controlSubject, WildcardIndex<NotUsed> largeMessageDestinations, WildcardIndex<NotUsed> priorityMessageDestinations, ObjectPool<ReusableOutboundEnvelope> outboundEnvelopePool)

Method Summary

Modifier and Type	Method and Description
void	associate() Called once after construction when the Association instance wins the CAS in the AssociationRegistry.
AssociationState	associationState()
scala.concurrent.Future<Done>	changeActorRefCompression(CompressionTable<ActorRef> table)
scala.concurrent.Future<Done>	changeClassManifestCompression(CompressionTable<java.lang.String> table)
scala.concurrent.Future<Done>	completeHandshake(UniqueAddress peer)
Materializer	controlMaterializer()
static int	ControlQueueIndex()
InboundControlJunction.ControlMessageSubject	controlSubject() An outbound stage can listen to control messages via this observer subject.
java.util.Queue<OutboundEnvelope>	createQueue(int capacity)
static int	LargeQueueIndex()
UniqueAddress	localAddress() The local inbound address.
Materializer	materializer()
static int	OrdinaryQueueIndex()
OutboundControlJunction.OutboundControlIngress	outboundControlIngress()
void	quarantine(java.lang.String reason)
void	quarantine(java.lang.String reason, scala.Option<java.lang.Object> uid)
Address	remoteAddress() The outbound address for this association.
void	send(java.lang.Object message, OptionVal<ActorRef> sender, OptionVal<RemoteActorRef> recipient)
void	sendControl(ControlMessage message) An inbound stage can send control message, e.g.
int	sendTerminationHint(ActorRef replyTo)
ArterySettings	settings()
scala.concurrent.Future<Done>	streamsCompleted() Exposed for orderly shutdown purposes, can not be trusted except for during shutdown as streams may restart.
java.lang.String	toString()
ArteryTransport	transport()

Methods inherited from class java.lang.Object

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

Field Detail

sharedStateOffset

protected static final long sharedStateOffset

Constructor Detail

Association

public Association(ArteryTransport transport,
                   Materializer materializer,
                   Materializer controlMaterializer,
                   Address remoteAddress,
                   InboundControlJunction.ControlMessageSubject controlSubject,
                   WildcardIndex<NotUsed> largeMessageDestinations,
                   WildcardIndex<NotUsed> priorityMessageDestinations,
                   ObjectPool<ReusableOutboundEnvelope> outboundEnvelopePool)

Method Detail

ControlQueueIndex

public static final int ControlQueueIndex()

LargeQueueIndex

public static final int LargeQueueIndex()

OrdinaryQueueIndex

public static final int OrdinaryQueueIndex()

transport

public ArteryTransport transport()

materializer

public Materializer materializer()

controlMaterializer

public Materializer controlMaterializer()

remoteAddress

public Address remoteAddress()

Description copied from interface: OutboundContext

The outbound address for this association.

Specified by:

remoteAddress in interface OutboundContext

Returns:

(undocumented)

controlSubject

public InboundControlJunction.ControlMessageSubject controlSubject()

Description copied from interface: OutboundContext

An outbound stage can listen to control messages via this observer subject.

Specified by:

controlSubject in interface OutboundContext

Returns:

(undocumented)

settings

public ArterySettings settings()

Specified by:

settings in interface OutboundContext

createQueue

public java.util.Queue<OutboundEnvelope> createQueue(int capacity)

changeActorRefCompression

public scala.concurrent.Future<Done> changeActorRefCompression(CompressionTable<ActorRef> table)

changeClassManifestCompression

public scala.concurrent.Future<Done> changeClassManifestCompression(CompressionTable<java.lang.String> table)

outboundControlIngress

public OutboundControlJunction.OutboundControlIngress outboundControlIngress()

localAddress

public UniqueAddress localAddress()

Description copied from interface: OutboundContext

The local inbound address.

Specified by:

localAddress in interface OutboundContext

Returns:

(undocumented)

associationState

public AssociationState associationState()

Specified by:

associationState in interface OutboundContext

Returns:

Reference to current shared state

completeHandshake

public scala.concurrent.Future<Done> completeHandshake(UniqueAddress peer)

sendControl

public void sendControl(ControlMessage message)

Description copied from interface: OutboundContext

An inbound stage can send control message, e.g. a HandshakeReq, to the remote address of this association. It will be sent over the control sub-channel.

Specified by:

sendControl in interface OutboundContext

Parameters:

message - (undocumented)

send

public void send(java.lang.Object message,
                 OptionVal<ActorRef> sender,
                 OptionVal<RemoteActorRef> recipient)

sendTerminationHint

public int sendTerminationHint(ActorRef replyTo)

quarantine

public void quarantine(java.lang.String reason)

Specified by:

quarantine in interface OutboundContext

quarantine

public final void quarantine(java.lang.String reason,
                             scala.Option<java.lang.Object> uid)

associate

public void associate()

Called once after construction when the Association instance wins the CAS in the AssociationRegistry. It will materialize the streams. It is possible to sending (enqueuing) to the association before this method is called.

Throws:

ShuttingDown - if called while the transport is shutting down

streamsCompleted

public scala.concurrent.Future<Done> streamsCompleted()

Exposed for orderly shutdown purposes, can not be trusted except for during shutdown as streams may restart. Will complete successfully even if one of the stream completion futures failed

Returns:

(undocumented)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object