public abstract class RemoteInstrument
extends java.lang.Object
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 stage, so if it doesn't
delegate to any shared instance it doesn't have to be thread-safe.
Constructor and Description |
---|
RemoteInstrument() |
Modifier and Type | Method and Description |
---|---|
abstract byte |
identifier()
Instrument identifier.
|
abstract void |
remoteMessageReceived(ActorRef recipient,
java.lang.Object message,
ActorRef sender,
int size,
long time)
Called when the message has been deserialized.
|
abstract void |
remoteMessageSent(ActorRef recipient,
java.lang.Object message,
ActorRef sender,
int size,
long time)
Called right before putting the message onto the wire.
|
abstract void |
remoteReadMetadata(ActorRef recipient,
java.lang.Object message,
ActorRef sender,
java.nio.ByteBuffer buffer)
Called while deserializing the message once a message (containing a metadata field designated for this instrument) is found.
|
abstract void |
remoteWriteMetadata(ActorRef recipient,
java.lang.Object message,
ActorRef sender,
java.nio.ByteBuffer buffer)
Called while serializing the message.
|
boolean |
serializationTimingEnabled()
Should the serialization be timed? Otherwise times are always 0.
|
public abstract byte identifier()
MUST be >=1 and <32.
Values between 1 and 7 are reserved for Akka internal use.
public boolean serializationTimingEnabled()
public abstract void remoteWriteMetadata(ActorRef recipient, java.lang.Object message, ActorRef sender, java.nio.ByteBuffer buffer)
null
(except message
and buffer
)!recipient
- (undocumented)message
- (undocumented)sender
- (undocumented)buffer
- (undocumented)public abstract void remoteMessageSent(ActorRef recipient, java.lang.Object message, ActorRef sender, int size, long time)
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.
recipient
- (undocumented)message
- (undocumented)sender
- (undocumented)size
- (undocumented)time
- (undocumented)public abstract void remoteReadMetadata(ActorRef recipient, java.lang.Object message, ActorRef sender, java.nio.ByteBuffer buffer)
recipient
- (undocumented)message
- (undocumented)sender
- (undocumented)buffer
- (undocumented)public abstract void remoteMessageReceived(ActorRef recipient, java.lang.Object message, ActorRef sender, int size, long time)
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.
recipient
- (undocumented)message
- (undocumented)sender
- (undocumented)size
- (undocumented)time
- (undocumented)