SIFWorks ADK 2.0
Disconnect Method (flags)
NamespacesEdustructures.SifWorksIZoneDisconnect(ProvisioningFlags)

[This is preliminary documentation and is subject to change.]

Disconnects the agent from this zone.
Declaration Syntax
C#Visual BasicVisual C++
void Disconnect(
	ProvisioningFlags flags
)
Sub Disconnect ( _
	flags As ProvisioningFlags _
)
void Disconnect (
	ProvisioningFlags flags
)
Parameters
Remarks
Resources held by the Class Framework, including the Agent Local Queue, are closed. To ensure these resources are properly closed, agents should disconnect from zones even when not planning on sending a
CopyC#
<
            SIF_Unregister>
provisioning message. Provisioning messages are sent as follows:
  • If the agent is using Adk-managed provisioning, a
    CopyC#
    <
                SIF_Unregister>
    message is sent to the ZIS when the AdkFlags.PROV_UNREGISTER flag is specified. When Adk-managed provisioning is disabled, no messages are sent to the zone.
  • If Agent-managed provisioning is enabled, the flags flags have no affect. The agent must explicitly call the sifUnregister method to manually send those message to the zone.
  • If ZIS-managed provisioning is enabled, no provisioning messages are sent by the agent regardless of the flags used and the methods are called.
Note that SIF Agent sessions are long-lived and therefore an agent may remain registered with a ZIS even when it is "disconnected" from the perspective of the Adk Class Framework. Disconnecting a zone also places the agent's server queue in sleep mode. This functionality can be disabled via the zone properties.
Exceptions
ExceptionCondition
AdkException is thrown if there is an error sending a
CopyC#
<SIF_Unregister>
message
See Also

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10