TROMessageEnvelope

Overview

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

Location

 

constructor Create  override

Creates a new instance.

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

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

Defines the processing of an incoming message.

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

Parameters:

  • aMessage: incoming message
  • aStream: encoded stream

ProcessOutgoing

Defines the processing of an outgoing message.

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

Parameters:

  • aMessage: outgoing message
  • aStream: stream

ReuseOriginalStream  protected

Allows to reuse original stream

property ReuseOriginalStream: boolean read write

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(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

Creates a new instance.

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

ProcessIncoming

Defines the processing of an incoming message.

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

Parameters:

  • aMessage: incoming message
  • aStream: encoded stream

ProcessOutgoing

Defines the processing of an outgoing message.

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

Parameters:

  • aMessage: outgoing message
  • aStream: stream

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(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)

Descendants

See Also