KamonRemoteInstrument

org.apache.pekko.remote.artery.KamonRemoteInstrument
class KamonRemoteInstrument(system: ExtendedActorSystem) extends RemoteInstrument

Attributes

Graph
Supertypes
class RemoteInstrument
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def identifier: Byte

Instrument identifier.

Instrument identifier.

MUST be >=1 and <32.

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

Attributes

Definition Classes
RemoteInstrument
def of(byteBuffer: ByteBuffer): ByteStreamWriter

Creates a new ByteStreamWriter from a ByteBuffer.

Creates a new ByteStreamWriter from a ByteBuffer.

Attributes

override 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 Pekko 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.

Attributes

Definition Classes
RemoteInstrument
override 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 Pekko 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.

Attributes

Definition Classes
RemoteInstrument
override 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.

Attributes

Definition Classes
RemoteInstrument
override 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)!

Attributes

Definition Classes
RemoteInstrument
override def serializationTimingEnabled: Boolean

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

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

Attributes

Definition Classes
RemoteInstrument