[This is preliminary documentation and is subject to change.]
Shutdown the agent.
This method should always be called before the application ends. It
closes resources held by the Adk Class Framework and Adk Agent Runtime.
Provisioning messages are sent as follows:
- If the agent is using Adk-managed provisioning, a < SIF_Unregister> message is sent to each zone to which the agent is connected if the AdkFlags.PROV_UNREGISTER flag is specified. <SIF_Unsubscribe> and <SIF_Unprovide> messages are sent to each zone joined to a Topic when the AdkFlags.PROV_UNSUBSCRIBE and AdkFlags.PROV_UNPROVIDE flags are specified, respectively. When Adk-managed provisioning is disabled, no provisioning messages are sent to zones.
- If Agent-managed provisioning is enabled, the ProvisioningOptions flags have no affect. The agent must explicitly call the IZone.sifUnregister, IZone.sifUnsubscribe, and IZone.sifUnprovide methods to manually send those messages to each zone.
- If ZIS-managed provisioning is enabled, no provisioning messages are sent by the agent regardless of the ProvisioningOptions used and the methods are called.
| C# | Visual Basic | Visual C++ |
public virtual void Shutdown( ProvisioningFlags provisioningOptions )
Public Overridable Sub Shutdown ( _ provisioningOptions As ProvisioningFlags _ )
public: virtual void Shutdown ( ProvisioningFlags provisioningOptions )
- provisioningOptions (ProvisioningFlags)