Package akka.remote.artery

Class LoggingRemoteInstrument

java.lang.Object

akka.remote.artery.RemoteInstrument

akka.remote.artery.LoggingRemoteInstrument

public class LoggingRemoteInstrument
extends RemoteInstrument

INTERNAL API

Constructor Summary

Constructors

Constructor	Description
LoggingRemoteInstrument(ActorSystem system)

Method Summary

Modifier and Type	Method	Description
byte	identifier()	Instrument identifier.
void	remoteMessageReceived(ActorRef recipient, java.lang.Object message, ActorRef sender, int size, long time)	Called when the message has been deserialized.
void	remoteMessageSent(ActorRef recipient, java.lang.Object message, ActorRef sender, int size, long time)	Called right before putting the message onto the wire.
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.
void	remoteWriteMetadata(ActorRef recipient, java.lang.Object message, ActorRef sender, java.nio.ByteBuffer buffer)	Called while serializing the message.

Methods inherited from class akka.remote.artery.RemoteInstrument

serializationTimingEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoggingRemoteInstrument

public LoggingRemoteInstrument(ActorSystem system)

Method Detail

identifier

public byte identifier()

Description copied from class: RemoteInstrument

Instrument identifier.

MUST be >=1 and <32.

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

Specified by:

identifier in class RemoteInstrument

remoteMessageReceived

public void remoteMessageReceived(ActorRef recipient,
                                  java.lang.Object message,
                                  ActorRef sender,
                                  int size,
                                  long time)

Description copied from class: RemoteInstrument

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.

Specified by:

remoteMessageReceived in class RemoteInstrument

remoteMessageSent

public void remoteMessageSent(ActorRef recipient,
                              java.lang.Object message,
                              ActorRef sender,
                              int size,
                              long time)

Description copied from class: RemoteInstrument

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.

Specified by:

remoteMessageSent in class RemoteInstrument

remoteReadMetadata

public void remoteReadMetadata(ActorRef recipient,
                               java.lang.Object message,
                               ActorRef sender,
                               java.nio.ByteBuffer buffer)

Description copied from class: RemoteInstrument

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

Specified by:

remoteReadMetadata in class RemoteInstrument

remoteWriteMetadata

public void remoteWriteMetadata(ActorRef recipient,
                                java.lang.Object message,
                                ActorRef sender,
                                java.nio.ByteBuffer buffer)

Description copied from class: RemoteInstrument

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

Specified by:

remoteWriteMetadata in class RemoteInstrument