akka.remote.artery

Class ArteryTransport

java.lang.Object

akka.remote.RemoteTransport

akka.remote.artery.ArteryTransport

All Implemented Interfaces:

InboundContext

public class ArteryTransport
extends RemoteTransport
implements InboundContext

INTERNAL API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArteryTransport.AeronTerminated
static class	ArteryTransport.InboundStreamMatValues
static class	ArteryTransport.InboundStreamMatValues$
static class	ArteryTransport.ShutdownSignal$
static class	ArteryTransport.ShuttingDown$

Constructor Summary

Constructors

Constructor and Description
ArteryTransport(ExtendedActorSystem _system, RemoteActorRefProvider _provider)

Method Summary

Modifier and Type	Method and Description
scala.collection.immutable.Set<Address>	addresses() Address to be used in RootActorPath of refs generated for this transport.
Sink<EnvelopeBuffer,scala.concurrent.Future<Done>>	aeronSink(OutboundContext outboundContext)
Source<EnvelopeBuffer,AeronSource.ResourceLifecycle>	aeronSource(int streamId, EnvelopeBufferPool pool)
scala.Option<java.nio.file.Path>	afrFile()
scala.Option<java.nio.channels.FileChannel>	afrFileChannel()
Association	association(Address remoteAddress) Lookup the outbound association for a given address.
OptionVal<Association>	association(long uid) Lookup the outbound association for a given UID.
static int	autoSelectPort(java.lang.String hostname)
UniqueAddress	bindAddress()
scala.concurrent.Future<Done>	completeHandshake(UniqueAddress peer)
Flow<EnvelopeBuffer,InboundEnvelope,Decoder.InboundCompressionAccess>	createDecoder(ArterySettings settings, InboundCompressions compressions, EnvelopeBufferPool bufferPool)
Flow<InboundEnvelope,InboundEnvelope,NotUsed>	createDeserializer(EnvelopeBufferPool bufferPool)
Flow<OutboundEnvelope,EnvelopeBuffer,Encoder.OutboundCompressionAccess>	createEncoder(EnvelopeBufferPool pool)
EventSink	createFlightRecorderEventSink(boolean synchr)
Address	defaultAddress() The default transport address of the ActorSystem
scala.Option<FlightRecorder>	flightRecorder()
OptionVal<Decoder.InboundCompressionAccess>	inboundCompressionAccess() Only access compression tables via the CompressionAccess
Sink<InboundEnvelope,scala.Tuple2<InboundControlJunction.ControlMessageSubject,scala.concurrent.Future<Done>>>	inboundControlSink()
Flow<EnvelopeBuffer,InboundEnvelope,Decoder.InboundCompressionAccess>	inboundFlow(ArterySettings settings, InboundCompressions compressions)
Flow<EnvelopeBuffer,InboundEnvelope,NotUsed>	inboundLargeFlow(ArterySettings settings)
Sink<InboundEnvelope,scala.concurrent.Future<Done>>	inboundSink(EnvelopeBufferPool bufferPool)
boolean	isShutdown()
boolean	largeMessageChannelEnabled()
UniqueAddress	localAddress() The local inbound address.
Address	localAddressForRemote(Address remote) Resolves the correct local address to be used for contacting the given remote address
LoggingAdapter	log() A Logger that can be used to log issues that may occur
scala.concurrent.Future<java.lang.Object>	managementCommand(java.lang.Object cmd) Sends a management command to the underlying transport stack.
Sink<InboundEnvelope,scala.concurrent.Future<Done>>	messageDispatcherSink()
Sink<OutboundEnvelope,scala.Tuple2<Encoder.OutboundCompressionAccess,scala.concurrent.Future<Done>>>	outbound(OutboundContext outboundContext)
Sink<OutboundEnvelope,scala.Tuple2<OutboundControlJunction.OutboundControlIngress,scala.concurrent.Future<Done>>>	outboundControl(OutboundContext outboundContext)
Flow<OutboundEnvelope,EnvelopeBuffer,Encoder.OutboundCompressionAccess>	outboundLane(OutboundContext outboundContext)
Sink<OutboundEnvelope,scala.concurrent.Future<Done>>	outboundLarge(OutboundContext outboundContext)
Flow<OutboundEnvelope,OutboundEnvelope,NotUsed>	outboundTestFlow(OutboundContext outboundContext)
static java.lang.String	ProtocolName()
static RemoteActorRefProvider	provider()
void	quarantine(Address remoteAddress, scala.Option<java.lang.Object> uid, java.lang.String reason) Marks a remote system as out of sync and prevents reconnects until the quarantine timeout elapses.
void	send(java.lang.Object message, OptionVal<ActorRef> sender, RemoteActorRef recipient) Sends the given message to the recipient supplying the sender() if any
void	sendControl(Address to, ControlMessage message) An inbound stage can send control message, e.g.
ArterySettings	settings()
scala.concurrent.Future<Done>	shutdown() Shuts down the remoting
void	start() Start up the transport, i.e.
static ExtendedActorSystem	system()
Flow<InboundEnvelope,InboundEnvelope,NotUsed>	terminationHintReplier()
void	triggerCompressionAdvertisements(boolean actorRef, boolean manifest) INTERNAL API: for testing only.
static byte	Version()

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

ArteryTransport

public ArteryTransport(ExtendedActorSystem _system,
                       RemoteActorRefProvider _provider)

Method Detail

ProtocolName

public static java.lang.String ProtocolName()

Version

public static byte Version()

autoSelectPort

public static int autoSelectPort(java.lang.String hostname)

system

public static ExtendedActorSystem system()

provider

public static RemoteActorRefProvider provider()

log

public 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)

afrFileChannel

public scala.Option<java.nio.channels.FileChannel> afrFileChannel()

afrFile

public scala.Option<java.nio.file.Path> afrFile()

flightRecorder

public scala.Option<FlightRecorder> flightRecorder()

inboundCompressionAccess

public OptionVal<Decoder.InboundCompressionAccess> inboundCompressionAccess()

Only access compression tables via the CompressionAccess

bindAddress

public UniqueAddress bindAddress()

localAddress

public UniqueAddress localAddress()

Description copied from interface: InboundContext

The local inbound address.

Specified by:

localAddress in interface InboundContext

Returns:

(undocumented)

defaultAddress

public 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

addresses

public scala.collection.immutable.Set<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)

localAddressForRemote

public Address localAddressForRemote(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

largeMessageChannelEnabled

public boolean largeMessageChannelEnabled()

createFlightRecorderEventSink

public EventSink createFlightRecorderEventSink(boolean synchr)

settings

public ArterySettings settings()

Specified by:

settings in interface InboundContext

start

public void start()

Description copied from class: RemoteTransport

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

Specified by:

start in class RemoteTransport

shutdown

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

Description copied from class: RemoteTransport

Shuts down the remoting

Specified by:

shutdown in class RemoteTransport

Returns:

(undocumented)

isShutdown

public boolean isShutdown()

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.

sendControl

public void sendControl(Address to,
                        ControlMessage message)

Description copied from interface: InboundContext

An inbound stage can send control message, e.g. a reply, to the origin address with this method. It will be sent over the control sub-channel.

Specified by:

sendControl in interface InboundContext

Parameters:

to - (undocumented)

message - (undocumented)

send

public void send(java.lang.Object message,
                 OptionVal<ActorRef> sender,
                 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)

sender - (undocumented)

recipient - (undocumented)

association

public Association association(Address remoteAddress)

Description copied from interface: InboundContext

Lookup the outbound association for a given address.

Specified by:

association in interface InboundContext

Parameters:

remoteAddress - (undocumented)

Returns:

(undocumented)

association

public OptionVal<Association> association(long uid)

Description copied from interface: InboundContext

Lookup the outbound association for a given UID. Will return OptionVal.None if the UID is unknown, i.e. handshake not completed.

Specified by:

association in interface InboundContext

Parameters:

uid - (undocumented)

Returns:

(undocumented)

completeHandshake

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

Specified by:

completeHandshake in interface InboundContext

quarantine

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

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

reason - (undocumented)

outboundLarge

public Sink<OutboundEnvelope,scala.concurrent.Future<Done>> outboundLarge(OutboundContext outboundContext)

outbound

public Sink<OutboundEnvelope,scala.Tuple2<Encoder.OutboundCompressionAccess,scala.concurrent.Future<Done>>> outbound(OutboundContext outboundContext)

aeronSink

public Sink<EnvelopeBuffer,scala.concurrent.Future<Done>> aeronSink(OutboundContext outboundContext)

outboundLane

public Flow<OutboundEnvelope,EnvelopeBuffer,Encoder.OutboundCompressionAccess> outboundLane(OutboundContext outboundContext)

outboundControl

public Sink<OutboundEnvelope,scala.Tuple2<OutboundControlJunction.OutboundControlIngress,scala.concurrent.Future<Done>>> outboundControl(OutboundContext outboundContext)

createEncoder

public Flow<OutboundEnvelope,EnvelopeBuffer,Encoder.OutboundCompressionAccess> createEncoder(EnvelopeBufferPool pool)

aeronSource

public Source<EnvelopeBuffer,AeronSource.ResourceLifecycle> aeronSource(int streamId,
                                                                        EnvelopeBufferPool pool)

messageDispatcherSink

public Sink<InboundEnvelope,scala.concurrent.Future<Done>> messageDispatcherSink()

createDecoder

public Flow<EnvelopeBuffer,InboundEnvelope,Decoder.InboundCompressionAccess> createDecoder(ArterySettings settings,
                                                                                           InboundCompressions compressions,
                                                                                           EnvelopeBufferPool bufferPool)

createDeserializer

public Flow<InboundEnvelope,InboundEnvelope,NotUsed> createDeserializer(EnvelopeBufferPool bufferPool)

terminationHintReplier

public Flow<InboundEnvelope,InboundEnvelope,NotUsed> terminationHintReplier()

inboundSink

public Sink<InboundEnvelope,scala.concurrent.Future<Done>> inboundSink(EnvelopeBufferPool bufferPool)

inboundFlow

public Flow<EnvelopeBuffer,InboundEnvelope,Decoder.InboundCompressionAccess> inboundFlow(ArterySettings settings,
                                                                                         InboundCompressions compressions)

inboundLargeFlow

public Flow<EnvelopeBuffer,InboundEnvelope,NotUsed> inboundLargeFlow(ArterySettings settings)

inboundControlSink

public Sink<InboundEnvelope,scala.Tuple2<InboundControlJunction.ControlMessageSubject,scala.concurrent.Future<Done>>> inboundControlSink()

outboundTestFlow

public Flow<OutboundEnvelope,OutboundEnvelope,NotUsed> outboundTestFlow(OutboundContext outboundContext)

triggerCompressionAdvertisements

public void triggerCompressionAdvertisements(boolean actorRef,
                                             boolean manifest)

INTERNAL API: for testing only.