constructor

• new MmrpEnvelope(eventName: string, messages: MmrpEnvelopeMessage[], route?: MmrpEnvelopeRoute, returnRoute?: MmrpEnvelopeRoute, flags?: MmrpEnvelopeFlag | MmrpEnvelopeFlag[]): MmrpEnvelope

• Parameters

  • eventName: string

  • messages: MmrpEnvelopeMessage[]

  • Optional route: MmrpEnvelopeRoute

  • Optional returnRoute: MmrpEnvelopeRoute

  • Optional flags: MmrpEnvelopeFlag | MmrpEnvelopeFlag[]

  Returns MmrpEnvelope

messages

Optional returnRoute

addMessage

• addMessage(message: MmrpEnvelopeMessage): void

• Parameters

  • message: MmrpEnvelopeMessage

  Returns void

consumeRoute

• consumeRoute(identity?: string): void

• Parameters

  • Optional identity: string

  Returns void

getFinalDestination

• getFinalDestination(): string

• Returns string

getFlags

• getFlags(): string[]

• Returns string[]

getInitialSource

• getInitialSource(): string

• Returns string

hasReturnRoute

• hasReturnRoute(): boolean

• Returns boolean

injectRoute

• injectRoute(route: MmrpEnvelopeRoute): void

• Parameters

  • route: MmrpEnvelopeRoute

  Returns void

injectSender

• injectSender(route: string): void

• Parameters

  • route: string

  Returns void

isFlagged

• isFlagged(): boolean

• Returns boolean

routeRemains

• routeRemains(): boolean

• Returns boolean

setFlag

• setFlag(flag: MmrpEnvelopeFlag): boolean

• Parameters

  • flag: MmrpEnvelopeFlag

  Returns boolean

setMessage

• setMessage(eventName: string, message: MmrpEnvelopeMessage): void

• Parameters

  • eventName: string

  • message: MmrpEnvelopeMessage

  Returns void

setMeta

• setMeta(flags: MmrpEnvelopeFlag | MmrpEnvelopeFlag[]): void

• Parameters

  • flags: MmrpEnvelopeFlag | MmrpEnvelopeFlag[]

  Returns void

setReturnRoute

• setReturnRoute(route: MmrpEnvelopeRoute): void

• Parameters

  • route: MmrpEnvelopeRoute

  Returns void

setRoute

• setRoute(route: MmrpEnvelopeRoute): void

• Parameters

  • route: MmrpEnvelopeRoute

  Returns void