TROMessageEnvelope

Overview

The base class for "envelopes", a generic method of encoding/decoding messages.

Location


 

constructor Create  override

Standard component constructor

constructor Create(AOwner: TComponent)

Parameters:

  • AOwner: Owner

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

EnvelopeMarker

This text mark can be used to distinguish envelopes.

property EnvelopeMarker: string read write

GetDefaultEnvelopeMarker  protected virtual

Returns EnvelopeMarker used by default.

function GetDefaultEnvelopeMarker: string

IntProcessIncoming  protected virtual

Encodes Source stream to Dest one.

procedure IntProcessIncoming(Source: TStream; Dest: TStream; aMessage: IROMessage)

Parameters:

  • Source: Source stream
  • Dest: Destination stream
  • aMessage: message

IntProcessOutgoing  protected virtual

Encodes Source stream to Dest one.

procedure IntProcessOutgoing(Source: TStream; Dest: TStream; aMessage: IROMessage)

Parameters:

  • Source: Source stream
  • Dest: Destination stream
  • aMessage: message

Notification  protected override    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

  • aComponent: component
  • Operation: operation

OnAfterEnvelopeProcessed

Fires after processing of envelope

property OnAfterEnvelopeProcessed: TROMessageEnvelopeProcessed read write
delegate: procedure OnAfterEnvelopeProcessed(aMessageEnvelope: TROMessageEnvelope; aStream: TStream; aMode: TROMessageEnvelopeMode; aMessage: IROMessage)

OnBeforeEnvelopeProcessed

Fires before processing of envelope

property OnBeforeEnvelopeProcessed: TROMessageEnvelopeProcessed read write
delegate: procedure OnBeforeEnvelopeProcessed(aMessageEnvelope: TROMessageEnvelope; aStream: TStream; aMode: TROMessageEnvelopeMode; aMessage: IROMessage)

ProcessIncoming

Encodes Source stream to Dest one.

function ProcessIncoming(aMessage: TROMessage; Source: TStream): TStream

Parameters:

  • aMessage: outgoing message
  • Source: stream

ProcessOutgoing

Encodes Source stream to Dest one.

function ProcessOutgoing(aMessage: TROMessage; Dest: TStream): TStream

Parameters:

  • aMessage: outgoing message
  • Dest: stream

ReuseOriginalStream  protected

Allows to reuse original stream

property ReuseOriginalStream: Boolean read write

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

SendRemoveNotification  protected    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

 

EnvelopeMarker

This text mark can be used to distinguish envelopes.

property EnvelopeMarker: string read write

ReuseOriginalStream  protected

Allows to reuse original stream

property ReuseOriginalStream: Boolean read write

 

constructor Create  override

Standard component constructor

constructor Create(AOwner: TComponent)

Parameters:

  • AOwner: Owner

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

GetDefaultEnvelopeMarker  protected virtual

Returns EnvelopeMarker used by default.

function GetDefaultEnvelopeMarker: string

IntProcessIncoming  protected virtual

Encodes Source stream to Dest one.

procedure IntProcessIncoming(Source: TStream; Dest: TStream; aMessage: IROMessage)

Parameters:

  • Source: Source stream
  • Dest: Destination stream
  • aMessage: message

IntProcessOutgoing  protected virtual

Encodes Source stream to Dest one.

procedure IntProcessOutgoing(Source: TStream; Dest: TStream; aMessage: IROMessage)

Parameters:

  • Source: Source stream
  • Dest: Destination stream
  • aMessage: message

Notification  protected override    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

  • aComponent: component
  • Operation: operation

ProcessIncoming

Encodes Source stream to Dest one.

function ProcessIncoming(aMessage: TROMessage; Source: TStream): TStream

Parameters:

  • aMessage: outgoing message
  • Source: stream

ProcessOutgoing

Encodes Source stream to Dest one.

function ProcessOutgoing(aMessage: TROMessage; Dest: TStream): TStream

Parameters:

  • aMessage: outgoing message
  • Dest: stream

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

SendRemoveNotification  protected    (declared in TROComponent)

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

  • aComponent: component

 

OnAfterEnvelopeProcessed

Fires after processing of envelope

property OnAfterEnvelopeProcessed: TROMessageEnvelopeProcessed read write
delegate: procedure OnAfterEnvelopeProcessed(aMessageEnvelope: TROMessageEnvelope; aStream: TStream; aMode: TROMessageEnvelopeMode; aMessage: IROMessage)

OnBeforeEnvelopeProcessed

Fires before processing of envelope

property OnBeforeEnvelopeProcessed: TROMessageEnvelopeProcessed read write
delegate: procedure OnBeforeEnvelopeProcessed(aMessageEnvelope: TROMessageEnvelope; aStream: TStream; aMode: TROMessageEnvelopeMode; aMessage: IROMessage)