TROCustomRODLReader
Overview
This is an abstract class to allow RODL reading process to be customized. Such customization is an advanced technique that can be used by either server class or message class or both. RODL reading customization may be necessary if the RODL content access is more complex then just reading a local resource. For example, Hydra enabled applications may consist of several modules and each of those may contain its own RODL resource.
In general this feature is rarely used. The RemoObjects SDK itself has no concrete TROCustomRODLReader descendants implemented, just serving as a base for extensions.
Location
- Unit: uROCustomRODLReader.pas
- Ancestry: TComponent | TROComponent | TROCustomRODLReader
constructor Create override (declared in TROComponent)
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
DoReadRODLResource protected virtual abstract
The method that is actually responsible for reading the resource. Descendant classes implementers must override it and implement some reading procedure there.
procedure DoReadRODLResource(aStream: TStream; aServiceGroup: string)
Parameters:
- aStream: The target stream to place the RODL content into.
- aServiceGroup:
OnAfterReadRODL
This event is fired before the actual RODL reading method called.
property OnAfterReadRODL: TROReadRODLEvent read write
delegate: procedure OnAfterReadRODL(aRODLReader: TROCustomRODLReader; aStream: TStream)
OnBeforeReadRODL
This event is fired after the RODL reading mathod finishes.
property OnBeforeReadRODL: TROReadRODLEvent read write
delegate: procedure OnBeforeReadRODL(aRODLReader: TROCustomRODLReader; aStream: TStream)
ReadRODLResource
The higher level RODL reading method that is callable from outside. Fires before and after reading events and invokes DoReadRODLResource
procedure ReadRODLResource(aStream: TStream; aServiceGroup: string)
Parameters:
- aStream: The target stream to place the RODL content into.
- aServiceGroup:
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
constructor Create override (declared in TROComponent)
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
DoReadRODLResource protected virtual abstract
The method that is actually responsible for reading the resource. Descendant classes implementers must override it and implement some reading procedure there.
procedure DoReadRODLResource(aStream: TStream; aServiceGroup: string)
Parameters:
- aStream: The target stream to place the RODL content into.
- aServiceGroup:
ReadRODLResource
The higher level RODL reading method that is callable from outside. Fires before and after reading events and invokes DoReadRODLResource
procedure ReadRODLResource(aStream: TStream; aServiceGroup: string)
Parameters:
- aStream: The target stream to place the RODL content into.
- aServiceGroup:
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
OnAfterReadRODL
This event is fired before the actual RODL reading method called.
property OnAfterReadRODL: TROReadRODLEvent read write
delegate: procedure OnAfterReadRODL(aRODLReader: TROCustomRODLReader; aStream: TStream)
OnBeforeReadRODL
This event is fired after the RODL reading mathod finishes.
property OnBeforeReadRODL: TROReadRODLEvent read write
delegate: procedure OnBeforeReadRODL(aRODLReader: TROCustomRODLReader; aStream: TStream)