Difference between revisions of "ProviderLifetimeEventsHandler"
From Virtual World Web Wiki
(Documentation for the ProviderLifetimeEventsHandler class) |
(Documentation for the ProviderLifetimeEventsHandler class) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | This class implements a Layer Two extensibility point as virtual members which can be overriden as needed. Derive from this class to provide your own implementation. | ||
+ | |||
+ | '''See also:''' [[IProviderLifetimeEvents]] | ||
+ | |||
+ | '''See also:''' [[IComponentEvents]] | ||
+ | |||
===Remarks <nowiki>[</nowiki>[{{fullurl:ProviderLifetimeEventsHandler Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:ProviderLifetimeEventsHandler Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
− | {{:ProviderLifetimeEventsHandler Remarks}} | + | {{#ifexist:ProviderLifetimeEventsHandler Remarks|{{:ProviderLifetimeEventsHandler Remarks}}|}} |
===Methods=== | ===Methods=== | ||
− | :{{CSharp|void | + | :{{CSharp|void Check()}} |
+ | :: | ||
+ | ::Called when a component check (validation / reinstall) is requested from the admin | ||
− | :{{CSharp|void | + | :{{CSharp|void Disable()}} |
+ | :: | ||
+ | ::Called when the component is enabled from the admin | ||
− | :{{CSharp|void | + | :{{CSharp|void Enable()}} |
− | + | :: | |
− | : | + | ::Called when the component is enabled from the admin |
:{{CSharp|void Initialize()}} | :{{CSharp|void Initialize()}} | ||
+ | :: | ||
+ | ::Fires when the service provider service starts up and initializes the Layer Two component system | ||
:{{CSharp|bool Install()}} | :{{CSharp|bool Install()}} | ||
+ | :: | ||
+ | ::Called once by the service provider on component install | ||
+ | |||
+ | :{{CSharp|Byte[] PackComponentObject(string objectClass, Guid objectID, ITransferItem item)}} | ||
+ | :: | ||
+ | ::Called by L1 to pack a component object for transfer to a remote system | ||
:{{CSharp|Byte[] PackSeedData(ITransferItem item)}} | :{{CSharp|Byte[] PackSeedData(ITransferItem item)}} | ||
+ | :: | ||
+ | ::Asks the component to package any seed data that should be delivered along with a component install or upgrade. Try to keep this less than a few MB if possible! | ||
:{{CSharp|void Shutdown()}} | :{{CSharp|void Shutdown()}} | ||
+ | :: | ||
+ | ::Fires when the service provider service is shutting down | ||
:{{CSharp|void SystemIntegrityCheckCompleted()}} | :{{CSharp|void SystemIntegrityCheckCompleted()}} | ||
+ | :: | ||
+ | ::Called by L1 after a system-wide layout validation and integrity check | ||
:{{CSharp|void SystemIntegrityCheckStarting()}} | :{{CSharp|void SystemIntegrityCheckStarting()}} | ||
+ | :: | ||
+ | ::Called by L1 before a system-wide layout validation and integrity check | ||
:{{CSharp|bool Uninstall()}} | :{{CSharp|bool Uninstall()}} | ||
+ | :: | ||
+ | ::Called once by the service provider on component uninstall | ||
+ | |||
+ | :{{CSharp|void UnpackComponentObject(string objectClass, Guid objectID, Byte[] data)}} | ||
+ | :: | ||
+ | ::Called by L1 to unpack a component object being transferred from a remote system | ||
:{{CSharp|void UnPackSeedData(Byte[] data)}} | :{{CSharp|void UnPackSeedData(Byte[] data)}} | ||
+ | :: | ||
+ | ::Asks the component to import seed data provided as part of an update or install. This will be the first method called on a component even before Install or Initialize | ||
:{{CSharp|bool Upgrade()}} | :{{CSharp|bool Upgrade()}} | ||
+ | :: | ||
+ | ::Called by the service provider when this component is being upgraded from a previous version | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Latest revision as of 15:24, 27 November 2017
This class implements a Layer Two extensibility point as virtual members which can be overriden as needed. Derive from this class to provide your own implementation.
See also: IProviderLifetimeEvents
See also: IComponentEvents
Remarks [edit]
Methods
- void Check()
- Called when a component check (validation / reinstall) is requested from the admin
- void Disable()
- Called when the component is enabled from the admin
- void Enable()
- Called when the component is enabled from the admin
- void Initialize()
- Fires when the service provider service starts up and initializes the Layer Two component system
- bool Install()
- Called once by the service provider on component install
- Byte[] PackComponentObject(string objectClass, Guid objectID, ITransferItem item)
- Called by L1 to pack a component object for transfer to a remote system
- Byte[] PackSeedData(ITransferItem item)
- Asks the component to package any seed data that should be delivered along with a component install or upgrade. Try to keep this less than a few MB if possible!
- void Shutdown()
- Fires when the service provider service is shutting down
- void SystemIntegrityCheckCompleted()
- Called by L1 after a system-wide layout validation and integrity check
- void SystemIntegrityCheckStarting()
- Called by L1 before a system-wide layout validation and integrity check
- bool Uninstall()
- Called once by the service provider on component uninstall
- void UnpackComponentObject(string objectClass, Guid objectID, Byte[] data)
- Called by L1 to unpack a component object being transferred from a remote system
- void UnPackSeedData(Byte[] data)
- Asks the component to import seed data provided as part of an update or install. This will be the first method called on a component even before Install or Initialize
- bool Upgrade()
- Called by the service provider when this component is being upgraded from a previous version