envelope

Type Members

1. trait AskSupport extends AnyRef

   

2. final class AskableEnvelopingActorRef extends AnyVal

   

3. case class ComponentPath(path: String) extends Product with Serializable

   

   Defines the identity of the given component (e.g.

   Defines the identity of the given component (e.g. /path/to/MessageForwarder)

4. case class ComponentType(componentType: String) extends Product with Serializable

   

   Defines the "type" of component in a message (e.g.

   Defines the "type" of component in a message (e.g. MessageForwarder)

5. case class Envelope(payload: Any, header: EnvelopeHeader) extends Product with Serializable

   

6. case class EnvelopeHeader(fromComponentType: ComponentType, fromComponentPath: ComponentPath, toComponentPath: ComponentPath, messageType: MessageType, workId: WorkId, messageNumber: MessageNumber, version: EnvelopeVersion, properties: Map[Symbol, Any] = Map(), createdTimeStamp: Long = System.currentTimeMillis) extends Product with Serializable

   

7. implicit final class EnvelopeSending extends AnyVal

   

   This implementation is ported from Derek Wyatt's blog post Parts of this blog post are adapted here for documentation.

   This implementation is ported from Derek Wyatt's blog post Parts of this blog post are adapted here for documentation.

   EnvelopeSending is an implicit value type class that extends the functionality of the ActorRef to provide the hook that wrap messages inside a rich envelope containg meta data about the message.

   With this implicit class in scope, send(..) a message to an ActorRef will result in wrapping the message in an Envelope. send or sendForward must be used rather than the regular ActorRef's tell, forward, and ! methods, which will remain unwrapped with an envelope. It is easy to "drop" the envelope as a result, so as long as the envelope is important care should be taken to use the enveloping methods.

8. case class EnvelopeVersion(version: Int = 1) extends Product with Serializable

   

   The version of the envelope protocol

9. trait Enveloping extends AnyRef

   

10. trait EnvelopingActor extends Actor with ActorStack with Enveloping

    

11. case class MessageNumber(value: Long) extends Product with Serializable

    

    Defines the sequence number of this message within the workId

12. case class MessageType(messageType: String) extends Product with Serializable

    

    Defines the type of message being sent (e.g.

    Defines the type of message being sent (e.g. SendEmail)

13. case class WorkId(workId: ShortUUID = ShortUUID()) extends Product with Serializable

    

    Defines the work identifier that this message is part of