TROInMemoryEventRepository

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Registers aSessionID as an event sink with an aActiveEventServer instance of the IROActiveEventServer as an event dispatcher.

function AddActiveListener(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer): Boolean

Parameters:

• aSessionID: Unique session GUID
• aActiveEventServer: Custom event dispatcher

---

Performs registration of a given session.

procedure AddSession(aSessionID: TGUID)

Parameters:

• aSessionID: Session ID

---

Performs registration of a given session and event dispatcher.

procedure AddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer)

Parameters:

• aSessionID: Unique session GUID
• aActiveEventServer: Custom event dispatcher

---

Performs registration of a given session and event dispatcher.

procedure AddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aActiveEventServer: Custom event dispatcher
• aEventSinkId: Event sink

---

Performs registration of a given session.

procedure AddSession(aSessionID: TGUID; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the event repository properties.

procedure CheckProperties

---

Critical section

property Critical: TCriticalSection read

---

Performs registration of a given session and event dispatcher.

procedure DoAddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aActiveEventServer: Custom event dispatcher
• aEventSinkId: Event sink

---

Performs registration of a given session.

procedure DoAddSession(aSessionID: TGUID; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Retrieves data of an event for a given session.

function DoGetEventData(SessionID: TGUID; var TargetStream: TROBinaryMemoryStream): Integer

Parameters:

• SessionID: Unique session GUID
• TargetStream: Event data container

---

Retrieves data of an event for a given session.

function DoGetEventData2(SessionID: TGUID; out Target: TROEventDataArray; aMaxEvents: Integer; out aEventsLeft: Integer): Integer

Parameters:

• SessionID: Session ID
• Target: Array of events
• aMaxEvents: Max possible count of eventsMax count of events per request
• aEventsLeft: Rest of events

---

Removes a given session from the list of registered sessions.

procedure DoRemoveSession(aSessionID: TGUID; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Stores event data from a given session.

procedure DoStoreEventData(SourceSessionID: TGUID; Data: TROBinaryMemoryStream; const ExcludeSender: Boolean; const ExcludeSessionList: Boolean; const SessionList: string; const EventSinkId: string)

Parameters:

• SourceSessionID: Unique session GUID
• Data: Event data container
• ExcludeSender: If true, the SourceSessionID will be excluded from the destination list.
• ExcludeSessionList: If true, the SessionList will be used as an exclusion list, otherwise as an inclusion list.
• SessionList: Comma delimited list of session GUIDs
• EventSinkId: Event sink

---

Finds session

function FindSession(aSessionID: TGUID): TROSessionReference

Parameters:

• aSessionID: Session ID

---

Implements IROEventRepository to retrieve data of events for a given session via %#DoGetEventData%.

function GetEventData(SessionID: TGUID; var TargetStream: TROBinaryMemoryStream): Integer

Parameters:

• SessionID: Session ID
• TargetStream: Target stream

---

Implements IROEventRepository to retrieve data of events for a given session via %#DoGetEventData2%.

function GetEventData2(SessionID: TGUID; out Target: TROEventDataArray; aMaxEvents: Integer; out aEventsLeft: Integer): Integer

Parameters:

• SessionID: Session ID
• Target: Array of events
• aMaxEvents: Max count of events per request
• aEventsLeft: Rest of events

---

Retrieves data of events for a given session.

procedure GetEventDataEx(SessionID: TGUID; out Target: TROEventDataArray)

Parameters:

• SessionID: Session ID
• Target: Array of events

---

Retrieves an event proxy registered by the generated RODL Files.

function GetEventWriter(const IID: TGUID): IROEventWriter

Parameters:

• IID: GUID of the required interface

---

Checks given session id in SessionManager

function IsSessionPresentinSessionManager(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID: Session ID.

---

The message format used to encode event data. This must match the message format used on the client-side TROEventReceiver.

property Message: TROMessage read write

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Fired by AddSession after addition.

property OnAfterAddSession: TROSessionEvent read write
delegate:  procedure OnAfterAddSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by RemoveSession after removing.

property OnAfterRemoveSession: TROSessionEvent read write
delegate:  procedure OnAfterRemoveSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by AddSession before addition.

property OnBeforeAddSession: TROSessionEvent read write
delegate:  procedure OnBeforeAddSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by RemoveSession before removing.

property OnBeforeRemoveSession: TROSessionEvent read write
delegate:  procedure OnBeforeRemoveSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Removes a given session from the list of registered sessions.

procedure RemoveSession(aSessionID: TGUID)

Parameters:

• aSessionID: Session ID

---

Removes a given session from the list of registered sessions.

procedure RemoveSession(aSessionID: TGUID; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Removes session active listener.

procedure RemoveSessionActiveListener(Sender: TObject; aSessionID: TGUID)

Parameters:

• Sender: IROActiveEventServer instance
• aSessionID: Session ID

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

List of Session ID

property SessionIDs: TStringList read

---

The session manager that maintains the server's user sessions. Remoting SDK events are tied to user sessions. Fired events are stored in the session until delivered to clients, while undelivered events expire and are discarded when the session expires. Therefore, to function, every Event Repository must have a session manager assigned.

property SessionManager: TROCustomSessionManager read write

---

Count of session references

property SessionReferenceCount: Integer read

---

Returns session reference

property SessionReferences[Index: Integer]: TROSessionReference read

---

Stores the provided event data in the repository.

procedure StoreEventData(SourceSessionID: TGUID; Data: TROBinaryMemoryStream; const ExcludeSender: Boolean; const ExcludeSessionList: Boolean; const SessionList: string; const EventSinkId: string)

Parameters:

• SourceSessionID: Session ID
• Data: Event data container
• ExcludeSender: If true, the SourceSessionID will be excluded from the destination list.
• ExcludeSessionList: If true, the SessionList will be used as an exclusion list, otherwise as an inclusion list.
• SessionList: Comma delimited list of session GUIDs
• EventSinkId: Event sink

 

Critical section

property Critical: TCriticalSection read

---

The message format used to encode event data. This must match the message format used on the client-side TROEventReceiver.

property Message: TROMessage read write

---

List of Session ID

property SessionIDs: TStringList read

---

The session manager that maintains the server's user sessions. Remoting SDK events are tied to user sessions. Fired events are stored in the session until delivered to clients, while undelivered events expire and are discarded when the session expires. Therefore, to function, every Event Repository must have a session manager assigned.

property SessionManager: TROCustomSessionManager read write

---

Count of session references

property SessionReferenceCount: Integer read

---

Returns session reference

property SessionReferences[Index: Integer]: TROSessionReference read

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Registers aSessionID as an event sink with an aActiveEventServer instance of the IROActiveEventServer as an event dispatcher.

function AddActiveListener(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer): Boolean

Parameters:

• aSessionID: Unique session GUID
• aActiveEventServer: Custom event dispatcher

---

Performs registration of a given session.

procedure AddSession(aSessionID: TGUID)

Parameters:

• aSessionID: Session ID

---

Performs registration of a given session and event dispatcher.

procedure AddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer)

Parameters:

• aSessionID: Unique session GUID
• aActiveEventServer: Custom event dispatcher

---

Performs registration of a given session and event dispatcher.

procedure AddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aActiveEventServer: Custom event dispatcher
• aEventSinkId: Event sink

---

Performs registration of a given session.

procedure AddSession(aSessionID: TGUID; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the event repository properties.

procedure CheckProperties

---

Performs registration of a given session and event dispatcher.

procedure DoAddSession(aSessionID: TGUID; aActiveEventServer: IROActiveEventServer; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aActiveEventServer: Custom event dispatcher
• aEventSinkId: Event sink

---

Performs registration of a given session.

procedure DoAddSession(aSessionID: TGUID; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Retrieves data of an event for a given session.

function DoGetEventData(SessionID: TGUID; var TargetStream: TROBinaryMemoryStream): Integer

Parameters:

• SessionID: Unique session GUID
• TargetStream: Event data container

---

Retrieves data of an event for a given session.

function DoGetEventData2(SessionID: TGUID; out Target: TROEventDataArray; aMaxEvents: Integer; out aEventsLeft: Integer): Integer

Parameters:

• SessionID: Session ID
• Target: Array of events
• aMaxEvents: Max possible count of eventsMax count of events per request
• aEventsLeft: Rest of events

---

Removes a given session from the list of registered sessions.

procedure DoRemoveSession(aSessionID: TGUID; const aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Stores event data from a given session.

procedure DoStoreEventData(SourceSessionID: TGUID; Data: TROBinaryMemoryStream; const ExcludeSender: Boolean; const ExcludeSessionList: Boolean; const SessionList: string; const EventSinkId: string)

Parameters:

• SourceSessionID: Unique session GUID
• Data: Event data container
• ExcludeSender: If true, the SourceSessionID will be excluded from the destination list.
• ExcludeSessionList: If true, the SessionList will be used as an exclusion list, otherwise as an inclusion list.
• SessionList: Comma delimited list of session GUIDs
• EventSinkId: Event sink

---

Finds session

function FindSession(aSessionID: TGUID): TROSessionReference

Parameters:

• aSessionID: Session ID

---

Implements IROEventRepository to retrieve data of events for a given session via %#DoGetEventData%.

function GetEventData(SessionID: TGUID; var TargetStream: TROBinaryMemoryStream): Integer

Parameters:

• SessionID: Session ID
• TargetStream: Target stream

---

Implements IROEventRepository to retrieve data of events for a given session via %#DoGetEventData2%.

function GetEventData2(SessionID: TGUID; out Target: TROEventDataArray; aMaxEvents: Integer; out aEventsLeft: Integer): Integer

Parameters:

• SessionID: Session ID
• Target: Array of events
• aMaxEvents: Max count of events per request
• aEventsLeft: Rest of events

---

Retrieves data of events for a given session.

procedure GetEventDataEx(SessionID: TGUID; out Target: TROEventDataArray)

Parameters:

• SessionID: Session ID
• Target: Array of events

---

Retrieves an event proxy registered by the generated RODL Files.

function GetEventWriter(const IID: TGUID): IROEventWriter

Parameters:

• IID: GUID of the required interface

---

Checks given session id in SessionManager

function IsSessionPresentinSessionManager(const aSessionID: TGUID): Boolean

Parameters:

• aSessionID: Session ID.

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Removes a given session from the list of registered sessions.

procedure RemoveSession(aSessionID: TGUID)

Parameters:

• aSessionID: Session ID

---

Removes a given session from the list of registered sessions.

procedure RemoveSession(aSessionID: TGUID; aEventSinkId: string)

Parameters:

• aSessionID: Session ID
• aEventSinkId: Event sink

---

Removes session active listener.

procedure RemoveSessionActiveListener(Sender: TObject; aSessionID: TGUID)

Parameters:

• Sender: IROActiveEventServer instance
• aSessionID: Session ID

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Stores the provided event data in the repository.

procedure StoreEventData(SourceSessionID: TGUID; Data: TROBinaryMemoryStream; const ExcludeSender: Boolean; const ExcludeSessionList: Boolean; const SessionList: string; const EventSinkId: string)

Parameters:

• SourceSessionID: Session ID
• Data: Event data container
• ExcludeSender: If true, the SourceSessionID will be excluded from the destination list.
• ExcludeSessionList: If true, the SessionList will be used as an exclusion list, otherwise as an inclusion list.
• SessionList: Comma delimited list of session GUIDs
• EventSinkId: Event sink

 

Fired by AddSession after addition.

property OnAfterAddSession: TROSessionEvent read write
delegate:  procedure OnAfterAddSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by RemoveSession after removing.

property OnAfterRemoveSession: TROSessionEvent read write
delegate:  procedure OnAfterRemoveSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by AddSession before addition.

property OnBeforeAddSession: TROSessionEvent read write
delegate:  procedure OnBeforeAddSession(Sender: TROEventRepository; const SessionID: TGUID)

---

Fired by RemoveSession before removing.

property OnBeforeRemoveSession: TROSessionEvent read write
delegate:  procedure OnBeforeRemoveSession(Sender: TROEventRepository; const SessionID: TGUID)