[This is preliminary documentation and is subject to change.]
Puts this zone into sleep mode.
A SIF_Sleep message is sent to the Zone Integration Server to request
that this agent's queue be put into sleep mode. If successful, the ZIS
should not deliver further messages to this agent until it is receives
a SIF_Register or SIF_Wakeup message from the agent. Note the Adk keeps
an internal sleep flag for each zone, which is initialized when the
CopyC# method is called by sending a SIF_Ping to the ZIS.
This flag is set so that the Adk will return a Status Code 8 ("Receiver
is sleeping") in response to any message received by the ZIS for the
duration of the session.
If the SIF_Sleep message is not successful, an exception is thrown and
the Adk's internal sleep flag for this zone is not changed.
connect
| C# | Visual Basic | Visual C++ |
void Sleep()
Sub Sleep
void Sleep ()
| Exception | Condition |
|---|---|
| AdkException | thrown if the SIF_Sleep message is unsuccessful
|