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
- Alphabetic
- By Inheritance
- RemoteInstrument
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RemoteInstrument()
Abstract Value Members
-
abstract
def
identifier: Byte
Instrument identifier.
Instrument identifier.
MUST be >=1 and <32.
Values between 1 and 7 are reserved for Akka internal use.
-
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 anyRemoteInstrument
metadata. IfserializationTimingEnabled
returns true, thentime
will be the total time it took to deserialize all data in the message in nanoseconds, otherwise it is 0. -
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
(exceptmessage
andbuffer
)!The
size
is the total serialized size in bytes of the complete message including akka specific headers and anyRemoteInstrument
metadata. IfserializationTimingEnabled
returns true, thentime
will be the total time it took to serialize all data in the message in nanoseconds, otherwise it is 0. -
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.
-
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
(exceptmessage
andbuffer
)!
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to any2stringadd[RemoteInstrument] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (RemoteInstrument, B)
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to ArrowAssoc[RemoteInstrument] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
ensuring(cond: (RemoteInstrument) ⇒ Boolean, msg: ⇒ Any): RemoteInstrument
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to Ensuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (RemoteInstrument) ⇒ Boolean): RemoteInstrument
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to Ensuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): RemoteInstrument
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to Ensuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): RemoteInstrument
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to Ensuring[RemoteInstrument] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to StringFormat[RemoteInstrument] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
serializationTimingEnabled: Boolean
Should the serialization be timed? Otherwise times are always 0.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (RemoteInstrument, B)
- Implicit
- This member is added by an implicit conversion from RemoteInstrument to ArrowAssoc[RemoteInstrument] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc