Packages

c

akka.remote.artery

RemoteInstrument

abstract class RemoteInstrument extends AnyRef

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
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoteInstrument
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RemoteInstrument()

Abstract Value Members

  1. abstract def identifier: Byte

    Instrument identifier.

    Instrument identifier.

    MUST be >=1 and <32.

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

  2. abstract def remoteMessageReceived(recipient: ActorRef, message: AnyRef, 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.

  3. abstract def remoteMessageSent(recipient: ActorRef, message: AnyRef, sender: ActorRef, size: Int, time: Long): Unit

    Called right before putting the message onto the wire.

    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.

  4. abstract def remoteReadMetadata(recipient: ActorRef, message: AnyRef, sender: ActorRef, buffer: ByteBuffer): Unit

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

  5. abstract def remoteWriteMetadata(recipient: ActorRef, message: AnyRef, sender: ActorRef, buffer: ByteBuffer): Unit

    Called while serializing the message.

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

Concrete Value Members

  1. def serializationTimingEnabled: Boolean

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