Akka/akka.remote.artery/RemoteInstrument

RemoteInstrument

@ccompatUsedUntil213
abstract class RemoteInstrument

INTERNAL API

Part of the monitoring SPI which allows attaching metadata to outbound remote messages, and reading in metadata from incoming messages.

Multiple instruments are automatically handled, however they MUST NOT overlap in their idenfitiers.

Instances of RemoteInstrument are created from configuration. A new instance of RemoteInstrument will be created for each encoder and decoder. It's only called from the operator, so if it doesn't delegate to any shared instance it doesn't have to be thread-safe.

Source:
RemoteInstrument.scala
class Object
trait Matchable
class Any

Value members

Abstract methods

def identifier: Byte

Instrument identifier.

Instrument identifier.

MUST be >=1 and <32.

Values between 1 and 7 are reserved for Akka internal use.

Source:
RemoteInstrument.scala
def remoteMessageReceived(recipient: ActorRef, message: Object, sender: ActorRef, size: Int, time: Long): Unit

Called when the message has been deserialized.

Called when the message has been deserialized.

The size is the total serialized size in bytes of the complete message including akka specific headers and any RemoteInstrument metadata. If serializationTimingEnabled returns true, then time will be the total time it took to deserialize all data in the message in nanoseconds, otherwise it is 0.

Source:
RemoteInstrument.scala
def remoteMessageSent(recipient: ActorRef, message: Object, sender: ActorRef, size: Int, time: Long): Unit

Called right before putting the message onto the wire. Parameters MAY be null (except message and buffer)!

Called right before putting the message onto the wire. Parameters MAY be null (except message and buffer)!

The size is the total serialized size in bytes of the complete message including akka specific headers and any RemoteInstrument metadata. If serializationTimingEnabled returns true, then time will be the total time it took to serialize all data in the message in nanoseconds, otherwise it is 0.

Source:
RemoteInstrument.scala
def remoteReadMetadata(recipient: ActorRef, message: Object, sender: ActorRef, buffer: ByteBuffer): Unit

Called while deserializing the message once a message (containing a metadata field designated for this instrument) is found.

Called while deserializing the message once a message (containing a metadata field designated for this instrument) is found.

Source:
RemoteInstrument.scala
def remoteWriteMetadata(recipient: ActorRef, message: Object, sender: ActorRef, buffer: ByteBuffer): Unit

Called while serializing the message. Parameters MAY be null (except message and buffer)!

Called while serializing the message. Parameters MAY be null (except message and buffer)!

Source:
RemoteInstrument.scala

Concrete methods

def serializationTimingEnabled: Boolean

Should the serialization be timed? Otherwise times are always 0.

Should the serialization be timed? Otherwise times are always 0.

Source:
RemoteInstrument.scala