[This is preliminary documentation and is subject to change.]
Puts all connected zones into sleep mode.
For each zone in the connected state, a SIF_Sleep message is sent to the
IZone Integration Server to request that this agent's queue be put into
sleep mode for that zone. 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 connect
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.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public virtual void Sleep()
Public Overridable Sub Sleep
public: virtual void Sleep ()
Exceptions| Exception | Condition |
|---|---|
| AdkException | thrown if the SIF_Sleep message is unsuccessful.
The Adk will attempt to send a SIF_Sleep to all connected zones; the
exception describes the zone or zones that failed
|