akka.remote.transport

Class ThrottlerHandle

java.lang.Object

akka.remote.transport.AbstractTransportAdapterHandle

akka.remote.transport.ThrottlerHandle

All Implemented Interfaces:

AssociationHandle, SchemeAugmenter, java.io.Serializable, scala.Equals, scala.Product

public final class ThrottlerHandle
extends AbstractTransportAdapterHandle
implements scala.Product, scala.Serializable

INTERNAL API

See Also:

Serialized Form

Nested Class Summary

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

AssociationHandle.ActorHandleEventListener, AssociationHandle.ActorHandleEventListener$, AssociationHandle.Disassociated, AssociationHandle.Disassociated$, AssociationHandle.DisassociateInfo, AssociationHandle.HandleEvent, AssociationHandle.HandleEventListener, AssociationHandle.InboundPayload, AssociationHandle.InboundPayload$, AssociationHandle.Quarantined$, AssociationHandle.Shutdown$, AssociationHandle.Unknown$

Constructor Summary

Constructors

Constructor and Description
ThrottlerHandle(AssociationHandle _wrappedHandle, ActorRef throttlerActor)

Method Summary

Modifier and Type	Method and Description
AssociationHandle	_wrappedHandle()
static java.lang.String	addedSchemeIdentifier()
protected static Address	augmentScheme(Address address)
protected static java.lang.String	augmentScheme(java.lang.String originalScheme)
abstract static boolean	canEqual(java.lang.Object that)
void	disassociate() Closes the underlying transport link, if needed.
void	disassociateWithFailure(AssociationHandle.DisassociateInfo reason)
abstract static boolean	equals(java.lang.Object that)
static Address	localAddress()
static Address	originalLocalAddress()
static Address	originalRemoteAddress()
java.util.concurrent.atomic.AtomicReference<ThrottlerTransportAdapter.ThrottleMode>	outboundThrottleMode()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
scala.concurrent.Promise<AssociationHandle.HandleEventListener>	readHandlerPromise() The Promise returned by this call must be completed with an AssociationHandle.HandleEventListener to register a listener responsible for handling incoming payload.
static Address	remoteAddress()
protected static Address	removeScheme(Address address)
protected static java.lang.String	removeScheme(java.lang.String scheme)
ActorRef	throttlerActor()
static AssociationHandle	wrappedHandle()
boolean	write(ByteString payload) Asynchronously sends the specified payload to the remote endpoint.

Methods inherited from class akka.remote.transport.AbstractTransportAdapterHandle

addedSchemeIdentifier, localAddress, originalLocalAddress, originalRemoteAddress, remoteAddress, wrappedHandle

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface akka.remote.transport.AssociationHandle

disassociate

Methods inherited from interface akka.remote.transport.SchemeAugmenter

augmentScheme, augmentScheme, removeScheme, removeScheme

Constructor Detail

ThrottlerHandle

public ThrottlerHandle(AssociationHandle _wrappedHandle,
                       ActorRef throttlerActor)

Method Detail

augmentScheme

protected static java.lang.String augmentScheme(java.lang.String originalScheme)

augmentScheme

protected static Address augmentScheme(Address address)

removeScheme

protected static java.lang.String removeScheme(java.lang.String scheme)

removeScheme

protected static Address removeScheme(Address address)

originalLocalAddress

public static Address originalLocalAddress()

originalRemoteAddress

public static Address originalRemoteAddress()

wrappedHandle

public static AssociationHandle wrappedHandle()

addedSchemeIdentifier

public static java.lang.String addedSchemeIdentifier()

localAddress

public static Address localAddress()

remoteAddress

public static Address remoteAddress()

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

_wrappedHandle

public AssociationHandle _wrappedHandle()

throttlerActor

public ActorRef throttlerActor()

outboundThrottleMode

public java.util.concurrent.atomic.AtomicReference<ThrottlerTransportAdapter.ThrottleMode> outboundThrottleMode()

readHandlerPromise

public scala.concurrent.Promise<AssociationHandle.HandleEventListener> readHandlerPromise()

Description copied from interface: AssociationHandle

The Promise returned by this call must be completed with an AssociationHandle.HandleEventListener to register a listener responsible for handling incoming payload. Until the listener is not registered the transport SHOULD buffer incoming messages.

Specified by:

readHandlerPromise in interface AssociationHandle

Returns:

Promise that must be completed with the listener responsible for handling incoming data.

write

public boolean write(ByteString payload)

Description copied from interface: AssociationHandle

Asynchronously sends the specified payload to the remote endpoint. This method MUST be thread-safe as it might be called from different threads. This method MUST NOT block.

Writes guarantee ordering of messages, but not their reception. The call to write returns with a Boolean indicating if the channel was ready for writes or not. A return value of false indicates that the channel is not yet ready for delivery (e.g.: the write buffer is full) and the sender needs to wait until the channel becomes ready again. Returning false also means that the current write was dropped (this MUST be guaranteed to ensure duplication-free delivery).

Specified by:

write in interface AssociationHandle

Parameters:

payload - The payload to be delivered to the remote endpoint.

Returns:

Boolean indicating the availability of the association for subsequent writes.

disassociate

public void disassociate()

Description copied from interface: AssociationHandle

Closes the underlying transport link, if needed. Some transports might not need an explicit teardown (UDP) and some transports may not support it (hardware connections). Remote endpoint of the channel or connection MAY be notified, but this is not guaranteed. The Transport that provides the handle MUST guarantee that disassociate() could be called arbitrarily many times.

Specified by:

disassociate in interface AssociationHandle

disassociateWithFailure

public void disassociateWithFailure(AssociationHandle.DisassociateInfo reason)