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.

Annotations
@ccompatUsedUntil213()
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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toany2stringadd[RemoteInstrument] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (RemoteInstrument, B)
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toArrowAssoc[RemoteInstrument] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (RemoteInstrument) => Boolean, msg: => Any): RemoteInstrument
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toEnsuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (RemoteInstrument) => Boolean): RemoteInstrument
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toEnsuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): RemoteInstrument
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toEnsuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): RemoteInstrument
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toEnsuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def serializationTimingEnabled: Boolean

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

  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toStringFormat[RemoteInstrument] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (RemoteInstrument, B)
    Implicit
    This member is added by an implicit conversion from RemoteInstrument toArrowAssoc[RemoteInstrument] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRemoteInstrument to any2stringadd[RemoteInstrument]

Inherited by implicit conversion StringFormat fromRemoteInstrument to StringFormat[RemoteInstrument]

Inherited by implicit conversion Ensuring fromRemoteInstrument to Ensuring[RemoteInstrument]

Inherited by implicit conversion ArrowAssoc fromRemoteInstrument to ArrowAssoc[RemoteInstrument]

Ungrouped