IOlympiaSessionManager Interface (Delphi)

This is a Library topic for RemObjects SDK for Delphi
This page is generated from external data, please do not update

Interfaces — Classes — Aliases — Implements

Overview

The IOlympiaSessionManager interface is an important part of every Olympia server; it manages all client's sessions and represents the complete information about the configuration of the Olympia server.

The IOlympiaSessionManager interface is implemented by the TOlympiaSessionManager_Proxy class, which is used as part of the TOlympia_Proxy server.

You will usually not deal with the IOlympiaSessionManager interface directly.

Location

ROOlympia_Intf.pas IOlympiaSessionManager | Descendants

Implemented in

• TOlympiaSessionManager_Proxy

Required Methods

CheckSession
Checks the client session with the specified GUID. Returns true if the session has checked and false if it hasn't. function CheckSession(const SessionID: AnsiString): Boolean Parameters: SessionID: Specified client GUID
ClearSessions
Clears all sessions from the application with the specified GUID. procedure ClearSessions(const ApplicationID: AnsiString) Parameters: ApplicationID: Specified application GUID
CreateSession
Creates a new client session with the specified GUID in the specified application. Returns true if the client session was successfully created, otherwise returns false. function CreateSession(const SessionID: AnsiString; const ApplicationID: AnsiString; const SessionData: Binary): Boolean Parameters: SessionID: Specified client GUID ApplicationID: Specified application GUID SessionData: Input data that is associated with the client session
DeleteSession
Deletes the client session with the specified GUID and returns true if the session was successfully deleted, otherwise returns false. When the given exception was not found, no exception will be thrown. function DeleteSession(const SessionID: AnsiString): Boolean Parameters: SessionID: Client session with the specified GUID
GetAllSessions
Gets all sessions from the application with the specified GUID and returns the array with the client's GUIDs. function GetAllSessions(const ApplicationID: AnsiString): GuidArray Parameters: ApplicationID: Specified application GUID
GetMessages
Returns messages (in binary format) that are associated with the specified session and returns the size of the MessageData stream. function GetMessages(const SessionID: AnsiString; out MessageData: Binary): Integer Parameters: SessionID: Specified session GUID MessageData: Output messages in binary format
GetSessionCount
Gets the count of sessions in the specified application. function GetSessionCount(const ApplicationID: AnsiString): Integer Parameters: ApplicationID: Specified application GUID
GetTimeout
Gets the timeout for the client sessions. function GetTimeout: Integer
ReadConfiguration
Returns the OlympiaSessionManagerConfiguration object that represents the configuration of the specified Olympia server. function ReadConfiguration: OlympiaSessionManagerConfiguration
ReadSession
Reads the client session with the specified GUID and returns the session characteristics in the OlympiaUserSession object. function ReadSession(const SessionID: AnsiString): OlympiaUserSession Parameters: SessionID: Specified session GUID
RegisterForSessionEvents
Registers all events that are related with the specified application procedure RegisterForSessionEvents(const aApplicationID: AnsiString) Parameters: aApplicationID: Specified application GUID
SetTimeout
Sets the timeout for the client sessions. procedure SetTimeout(const value: Integer) Parameters: value: Specified timeout in milliseconds
StoreMessage
Stores the message data to the specified client session. procedure StoreMessage(const SourceSessionID: AnsiString; const MessageData: Binary) Parameters: SourceSessionID: Specified session GUID MessageData: Specified input message data
UpdateConfiguration
Updates the configuration of the current Olympia server with the OlympiaSessionManagerConfiguration object. procedure UpdateConfiguration(const Configuration: OlympiaSessionManagerConfiguration) Parameters: Configuration: Input object that includes the configuration of the Olympia server
UpdateSession
Updates the session data that is related with the specified client session. procedure UpdateSession(const SessionID: AnsiString; const SessionData: Binary) Parameters: SessionID: Specified session GUID SessionData: New input session data

Descendants

• IOlympia

See Also

• Olympia FAQs (RemObjects SDK)
• Session Managers (Delphi)
• OlympiaSessionManagerConfiguration
• OlympiaUserSession
• TOlympia_Proxy
• TOlympiaSessionManager_Proxy
• IOlympiaSessionManager Interface
  • .NET
  • Delphi
• Lists
  • RemObjects SDK for Delphi:   Interfaces — Classes — Aliases — Implements
  • RemObjects SDK shared:   Data Types – File Types
  • other editions
    • RemObjects SDK for .NET:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for Xcode:   Protocols — Classes — Enums — Aliases — Implements
    • RemObjects SDK for Java:   Namespaces — Interfaces — Classes — Enums — Implements
    • RemObjects SDK for JavaScript:   Objects

Product: RemObjects SDK
Available Editions: RemObjects SDK for .NET, Xcode, Delphi, Java and JavaScript

Glossary — Articles — Library — Samples