Engine
Overview
The Engine static class is used by the Data Abstract server infrastructure to store link t one of its core objects - the ConnectionManager instance. This class also provides methods used by local data adapters to acquire and release data service instances.
Location
- Reference: RemObjects.DataAbstract.Server.dll
- Namespace: RemObjects.DataAbstract.Server
AcquireLocalService
Instantiates a service named serviceName. This method is used by local data adapters to acquire data services.
Service instance is activated using the sessionId arument value as session identifier.
class method AcquireLocalService(serviceName: String; sessionId: Guid): Object
static Object AcquireLocalService(String serviceName, Guid sessionId)
Shared Function AcquireLocalService(serviceName As String, sessionId As Guid) As Object
Parameters:
- serviceName: Servcie name
- sessionId: Session Id
ActivateLocalService
class method ActivateLocalService(serviceInstance: Object; sessionId: Guid)
static void ActivateLocalService(Object serviceInstance, Guid sessionId)
Shared Sub ActivateLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
ConnectionManager
Provides access to the previously registered (via theRegisterConnectionManager method) ConnectionManager.
This property always returns a non-null object or raises an exception if no ConnectionManager is registered.
class property ConnectionManager: ConnectionManager read;
class ConnectionManager ConnectionManager { get; }
Shared ReadOnly Property ConnectionManager() As ConnectionManager
DeactivateLocalService
class method DeactivateLocalService(serviceInstance: Object; sessionId: Guid)
static void DeactivateLocalService(Object serviceInstance, Guid sessionId)
Shared Sub DeactivateLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
IsConnectionManagerRegistered
Returns a flag indicating whether there is a globally registered ConnectionManager instance present.
class property IsConnectionManagerRegistered: Boolean read;
class Boolean IsConnectionManagerRegistered { get; }
Shared ReadOnly Property IsConnectionManagerRegistered() As Boolean
Load
class method Load
static void Load()
Shared Sub Load()
Loaded
class property Loaded: Boolean read;
class Boolean Loaded { get; }
Shared ReadOnly Property Loaded() As Boolean
RegisterConnectionManager
Registers the global Connection Manager. An exception will be raised if another ConnectionManager is already registered.
This method is called by default by the ConnectionManager constructor.
class method RegisterConnectionManager(manager: ConnectionManager)
static void RegisterConnectionManager(ConnectionManager manager)
Shared Sub RegisterConnectionManager(manager As ConnectionManager)
Parameters:
- manager: ConnectionManager instance to register as global ConnectionManager
ReleaseLocalService
Deactivates and releases the service instance previously acquired by the AcquireLocalService method.
class method ReleaseLocalService(serviceInstance: Object; sessionId: Guid)
static void ReleaseLocalService(Object serviceInstance, Guid sessionId)
Shared Sub ReleaseLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance: Servcie instance
- sessionId: Session Id
UnRegisterConnectionManager
Tries to unregister the global ConnectionManager.
This method returns false if the ConnectionManager instance provided as parameter is not the one registered as global ConnectionManager. In this case the currently registered global ConnectionManager is not unregistered.
class method UnRegisterConnectionManager(manager: ConnectionManager): Boolean
static Boolean UnRegisterConnectionManager(ConnectionManager manager)
Shared Function UnRegisterConnectionManager(manager As ConnectionManager) As Boolean
Parameters:
- manager: ConnectionManager instance to unregister as global ConnectionManager
ConnectionManager
Provides access to the previously registered (via theRegisterConnectionManager method) ConnectionManager.
This property always returns a non-null object or raises an exception if no ConnectionManager is registered.
class property ConnectionManager: ConnectionManager read;
class ConnectionManager ConnectionManager { get; }
Shared ReadOnly Property ConnectionManager() As ConnectionManager
IsConnectionManagerRegistered
Returns a flag indicating whether there is a globally registered ConnectionManager instance present.
class property IsConnectionManagerRegistered: Boolean read;
class Boolean IsConnectionManagerRegistered { get; }
Shared ReadOnly Property IsConnectionManagerRegistered() As Boolean
Loaded
class property Loaded: Boolean read;
class Boolean Loaded { get; }
Shared ReadOnly Property Loaded() As Boolean
AcquireLocalService
Instantiates a service named serviceName. This method is used by local data adapters to acquire data services.
Service instance is activated using the sessionId arument value as session identifier.
class method AcquireLocalService(serviceName: String; sessionId: Guid): Object
static Object AcquireLocalService(String serviceName, Guid sessionId)
Shared Function AcquireLocalService(serviceName As String, sessionId As Guid) As Object
Parameters:
- serviceName: Servcie name
- sessionId: Session Id
ActivateLocalService
class method ActivateLocalService(serviceInstance: Object; sessionId: Guid)
static void ActivateLocalService(Object serviceInstance, Guid sessionId)
Shared Sub ActivateLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
DeactivateLocalService
class method DeactivateLocalService(serviceInstance: Object; sessionId: Guid)
static void DeactivateLocalService(Object serviceInstance, Guid sessionId)
Shared Sub DeactivateLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance:
- sessionId:
Load
class method Load
static void Load()
Shared Sub Load()
RegisterConnectionManager
Registers the global Connection Manager. An exception will be raised if another ConnectionManager is already registered.
This method is called by default by the ConnectionManager constructor.
class method RegisterConnectionManager(manager: ConnectionManager)
static void RegisterConnectionManager(ConnectionManager manager)
Shared Sub RegisterConnectionManager(manager As ConnectionManager)
Parameters:
- manager: ConnectionManager instance to register as global ConnectionManager
ReleaseLocalService
Deactivates and releases the service instance previously acquired by the AcquireLocalService method.
class method ReleaseLocalService(serviceInstance: Object; sessionId: Guid)
static void ReleaseLocalService(Object serviceInstance, Guid sessionId)
Shared Sub ReleaseLocalService(serviceInstance As Object, sessionId As Guid)
Parameters:
- serviceInstance: Servcie instance
- sessionId: Session Id
UnRegisterConnectionManager
Tries to unregister the global ConnectionManager.
This method returns false if the ConnectionManager instance provided as parameter is not the one registered as global ConnectionManager. In this case the currently registered global ConnectionManager is not unregistered.
class method UnRegisterConnectionManager(manager: ConnectionManager): Boolean
static Boolean UnRegisterConnectionManager(ConnectionManager manager)
Shared Function UnRegisterConnectionManager(manager As ConnectionManager) As Boolean
Parameters:
- manager: ConnectionManager instance to unregister as global ConnectionManager