TheBaseEngine Methods
The TheBaseEngine type exposes the following members.
Methods
Name | Description | |
---|---|---|
AddCapability |
Adds a capability to the Engine
V4: You can send Discovery Messages across a mesh to find nodes with certain Plugins and capabilities
|
|
AddManifestFiles |
Adds a list of all required DLLs and other files that need to be present for the plugin to work
The Plugin-Store will combine all the files when it creates the installer package
|
|
AddPlatforms |
Adds a list of supported platforms
|
|
AddUrl | Obsolete.
RETIRED IN V4: No more channels
|
|
CloneBase |
Clonse an incoming object into this object
(Inherited from TheDataBase.) |
|
CloneTo |
Clones the metadata of the current class to a new class provided to the method
(Inherited from TheMetaDataBase.) |
|
Equals(System.Object) | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
FireEvent(String, Object, Boolean) |
Fires an event with the given name
|
|
FireEvent(String, TheProcessMessage, Boolean, Int32) |
Fire an Event on a property
(Inherited from TheDataBase.) |
|
GetBaseEngine |
Returns this BaseEngine
|
|
GetBaseThing |
Returns MyBaseThing of TheBaseEngine
|
|
GetCDEMinVersion |
Gets the minimal required Version of the C-DEngine
|
|
GetCommunicationCosts |
Returns the cost of the Engine Communication in C-Credits
|
|
GetDashboard |
Gets the main Dashboard of TheBaseEngine
|
|
GetDashboardGuid |
Gest the Guid of the Dashboard of TheBaseEngine
|
|
GetDeviceTypes |
Returns a list of TheDeviceTypeInfos of this plugin
|
|
GetEngineID |
Returns the Plugin GUID of TheBaseEngine
|
|
GetEngineName |
Gets the Name of TheBaseEngine - used for the ENG parameter TSM and corresponding subscriptions
|
|
GetEngineState |
Returns the current Engine State
|
|
GetFirstNode |
Returns the Service Node ID if set. This only applies to Non-Service Plugins (i.e. StorageService Client)
|
|
GetFriendlyName |
Gets the Friendly Name of TheBaseEngine
|
|
GetHashCode | (Inherited from Object.) | |
GetISOLater |
Returns the ISOlater (Isolation Manager)
|
|
GetPluginInfo |
Returns ThePluginInfo of TheBaseEngine
|
|
GetPluginResource(TheRequestData) |
Loads a Resource from the Relay. Load Order:
This method is adding a /L{LCID} to the resource if the requesting User has set a different LCID then zero (Browser Default)
1 - ClientBin Folder under Executable Folder
2 - Embedded Resources of Plug-in/Engine
3 - ClientBin Folder with no /L{LCID}
4 - Embedded Resources of Plug-in/Engine without L{LCID}
The method also adds sets the ResponseMimeType on TheRequestData for js, css, html and pngs
If the requested resource is an HTML File and it cannot be located, the method returns a "Resource not found" error in the ResponseBuffer
AllowStatePush will be set to true and StatusCode will be set to 200.
|
|
GetPluginResource(String) |
Retrieves an embedded Resource from the plugin by name.
|
|
GetThingInterface |
Return the ICDEThing interface of TheBaseThing
|
|
GetType | (Inherited from Object.) | |
GetVersion |
Returns the Version of TheBaseEngine
|
|
HasCapability |
TheBaseEngine can be asked if a certain Capability is supported by the it
|
|
HasChannels |
RETIRED IN V4: returns always FALSE
|
|
InitAndSubscribe |
Sends CDE_INITIALIZE to the Service Node. Only for "Client" Engines
|
|
IsEventRegistered |
Returns true if the requested eThingEvents has registered callbacks
(Inherited from TheDataBase.) |
|
MemberwiseClone | (Inherited from Object.) | |
MessageProcessed |
Fires the eventMessageProcess to all listeners
|
|
NotifyMirror |
If called from a derived class and the class was stored in a StorageMirror, this method will call the "NotifyOfUpdate" method in the StorageMirror to inform all Notification Clients that this record has changed.
This is VERY Expensive! Do not call too often!
This does not work with StorageMirrors that require a PostSalt (unique table name)
(Inherited from TheDataBase.) |
|
OnPropertyChanged | (Inherited from TheBindableBase.) | |
ProcessInitialized |
A service/engine has to call this method when Init() is done and the service/engine is ready to get to work.
|
|
ProcessMessage(TSM) |
Incoming Publish Notification from Service
Handled on the Client
|
|
ProcessMessage(TSM, Action<(Of <<'(TSM>)>>)) |
Incoming Publish Notification from Service
Handled on the Client
|
|
ProcessMessage(TheProcessMessage) |
Incoming Publish Notification from Service
Handled on the Client
|
|
PublishToChannels |
Publishes a TSM to the Active Channel
|
|
RegisterCSS |
Registers a CSS File with the Engine
|
|
RegisterEvent(String, Action<(Of <<'(ICDEThing, Object>)>>)) |
Register a callback with an event of TheBaseEngine
|
|
RegisterEvent(String, Action<(Of <<'(Object, TheProcessMessage>)>>)) |
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.) |
|
RegisterEvent2 |
Register a callback that will be fired on a Property Event
(Inherited from TheDataBase.) |
|
RegisterJSEngine |
Registers a JavaScript Engine with the HttpService.
The JavaScript File must have the same name as returned by "GetEngineName()"
|
|
ReplyInitialized |
If a service/engine gets a call to Initialize, it can reply to the sender that is has been initialized.
|
|
ResetChannel | Obsolete.
RETIRED IN V4: No more channels
|
|
ResurectChannels | Obsolete.
RETIRED IN V4: No more channels
|
|
SetCDEMinVersion |
Sets the minimal required version of the C-DEngine for TheBaseEngine
|
|
SetDashboard |
Sets the main Dashboard of TheBaseEngine
|
|
SetDeviceTypes |
Declares a list of DeviceTypes for this plugins
|
|
SetEngineID |
Sets the EngineID Of TheBaseEngine - this is required by the system.
By default, the Engine will also use this Guid for its main Dashboard ID
|
|
SetEngineName |
Sets the Engine and ClassName of TheBaseEngine.. Recommended is to use "GetType().FullName"
Subscriptions for TheBaseEngine will use this name
|
|
SetEngineReadiness |
Call this method to set the station readiness. It will be called by the system automatically once a channel is up and running
|
|
SetEngineService |
Sets TheBaseEngine as a Service (will be Added to the StationRoles)
|
|
SetEngineType |
Sets the .NET Type of TheBase Engine. Use "GetType()"
|
|
SetFriendlyName |
Sets the Friendly Name of TheBaseEngine
|
|
SetInitialized |
Call this Method to tell the C-DEngine and "EngineInitialized" registrars that the service has been successfully initialized
The Event is fired synchronous and fires BEFORE the EngineState.IsInitialized is set to true. This allows event recceivers to check if the Engine has been initialized before
|
|
SetIsInitializing |
Is set when TheBaseEngine is initializing
|
|
SetIsLicensed |
Plug-in call this from their InitEngineAssets() method to indicate that they require an activated license
|
|
SetIsMiniRelay |
Defines TheBaseEngine as a Mini Relay (Pub/Sub Relaying Only - no Application Code)
|
|
SetIsolationFlags |
Sets the Isolation flags
|
|
SetMultiChannel | Obsolete.
RETIRED IN V4: All Engines now NOT MultiChannel
|
|
SetNewVersion |
If a new Version was found it can be set here
|
|
SetPluginInfo |
Sets the Information of the Plugin
|
|
SetProperty``1 | (Inherited from TheBindableBase.) | |
SetStatusLevel |
Sets the Statuslevel of TheBaseEngine to a new level
If you use -1, the StatusLevel is calculated from all the Things TheBaseEngine is managing
|
|
SetVersion |
Sets the Version of TheBaseEngine
|
|
StartEngine |
This is the main start routine for the engine.
Depending on pURLS and the way the Engine is configured a channel is opened to the first URL in the pURLs
|
|
StopEngine |
Stops all channels and than the engine
Removes all channels from the list - should not be used to stop a particular channel
|
|
Subscribe |
Sends a CDE-SUBSCRIBE telegram to the Active Channel of this engine
|
|
ToString |
Returns a friendly view of the current Engine State
|
|
UnregisterEvent(String, Action<(Of <<'(ICDEThing, Object>)>>)) |
Unregisters the call back with an event. If the callback is null, all callbacks of the event will be removed
|
|
UnregisterEvent(String, Action<(Of <<'(Object, TheProcessMessage>)>>)) |
Unregister a previously registered callback
(Inherited from TheDataBase.) |
|
UnregisterEvent2 |
Unregister a previously registered callback
(Inherited from TheDataBase.) |
|
UnregisterStorageReadiness |
Unregister the StorageReadiness callbacks
|
|
UpdateCosting |
Fires the "CostingWasUpdated" event to add new credits to a TSM
|
|
UpdateEngineScope | Obsolete.
RETIRED IN V4: QSender can have different scopes
|
|
UpdateEngineState |
Updates all list-properties of Service State with the current values
|
|
WaitForEnginesStarted |
Fires when all Engines are Started
|
|
WaitForEnginesStartedAsync |
Async Version of WaitForEnginesStarted
|
|
WaitForStorageReadiness |
Fires the call back when TheStorageService is ready for business
|
|
WaitForStorageReadinessAsync |
Async version of WaitForStorageReadiness
|