[This is preliminary documentation and is subject to change.]
Declaration Syntax| C# | Visual Basic | Visual C++ |
public interface IZone
Public Interface IZone
public interface class IZone
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | AddMessagingListener(IMessagingListener) | Register a MessagingListener to listen to messages received by the
message handlers of this class.
NOTE: Agents may register a MessagingListener with the Agent or Zone
classes. When a listener is registered with both classes, it will be
called twice. Consequently, it is recommended that most implementations
choose to register MessagingListeners with only one of these classes
depending on whether the agent is interested in receiving global
notifications or notifications on only a subset of zones.
|
 | Agent | Gets the Agent object |
| Connect(ProvisioningFlags) | Connects the agent with this zone. |
| Connected | Gets the connection state of this zone |
| ConnectWarnings | Gets a list of any SIF Errors that resulted from the sending of provisioning
messages to the zone. Only access control errors (Category 4) are treated as
warnings rather than errors; all other SIF Errors result in an exception
thrown by the  CopyC#connect |
| Disconnect(ProvisioningFlags) | Disconnects the agent from this zone. |
| ErrorHandler | Sets the UndeliverableMessageHandler to be called when a dispatching
error occurs on this zone. For more information, please refer to the
UnderliverableMessageHandler class comments.
|
| GetZoneStatus()() | Gets the SIF_ZoneStatus object from the ZIS managing this zone. The
method blocks until a result is received.
|
| GetZoneStatus(TimeSpan) | Gets the SIF_ZoneStatus object from the ZIS managing this zone. The
method blocks for the specified timeout period.
|
| IsSleeping(AdkQueueLocation) | Determines if the agent's queue for this zone is in sleep mode.
|
| Log | Gets the root logging framework Category for this agent. |
| Properties | |
| PurgeQueue(Boolean, Boolean) | |
| Query(Query) | Query the zone.
|
| Query(Query, IMessagingListener) | Query the zone and notify a MessagingListener
|
| Query(Query, AdkQueryOptions) | Query the zone with options.
|
| Query(Query, IMessagingListener, AdkQueryOptions) | Query the zone with options and notify a MessagingListener
|
| Query(Query, String, AdkQueryOptions) | Query a specific agent registered with this zone (a directed query).
Directed queries are used primarily when the source of data is known
because of a message previously received from that agent. For example,
if your agent receives a SIF_Event and you wish to query the author of
that event for additional data, a directed query is appropriate.
In addition, some kinds of SIF Data Objects in SIF 1.5 and later may be
designed to require agents to send directed queries if more than one
agent in a zone typically offers support for the object. This is necessary
because only one agent can be the authoritative provider of a given object
type in each zone.
|
| Query(Query, IMessagingListener, String, AdkQueryOptions) | Query a specific agent registered with this zone (a directed query)
and notify a MessagingListener.
Directed queries are used primarily when the source of data is known
because of a message previously received from that agent. For example,
if your agent receives a SIF_Event and you wish to query the author of
that event for additional data, a directed query is appropriate.
In addition, some kinds of SIF Data Objects in SIF 1.5 and later may be
designed to require agents to send directed queries if more than one
agent in a zone typically offers support for the object. This is necessary
because only one agent can be the authoritative provider of a given object
type in each zone.
|
| RemoveMessagingListener(IMessagingListener) | Remove a MessagingListener previously registered with the
CopyC#addMessagingListener |
| ReportEvent(Event) | Report a SIF Event to the zone |
| ReportEvent(SifDataObject, EventAction) | Report a SIF Event to the zone |
| ReportEvent(SifDataObject, EventAction, String) | Report a directed SIF Event to the agent in the zone identified by
CopyC#destinationId |
| ServerLog | Gets the ServerLog for this zone. |
| SetPublisher(IPublisher) | Register a Publisher message handler with this zone to process SIF_Request
messages for all object types.
|
| SetPublisher(IPublisher, IElementDef, ProvisioningFlags) | Register a Publisher message handler with this zone to process SIF_Requests
for the specified object type. This method may be called repeatedly for
each SIF Data Object type the agent will publish on this zone.
|
| SetQueryResults(IQueryResults) | Register a QueryResults message handler with this zone to process
SIF_Response messages for all object types.
|
| SetQueryResults(IQueryResults, IElementDef) | Register a QueryResults object with this zone for the specified SIF object type.
|
| SetReportPublisher(IReportPublisher, ProvisioningFlags) | Register a ReportPublisher message handler with this zone to respond to
SIF_Requests for SIF_ReportObject objects. ReportPublisher is implemented
by Vertical Reporting applications that publish report data via the
SIF_ReportObject object introduced in SIF 1.5.
|
| SetSubscriber(ISubscriber, IElementDef, ProvisioningFlags) | Register a Subscriber message handler with this zone to process SIF_Event
messages for the specified object type. This method may be called
repeatedly for each SIF Data Object type the agent subscribes to on
this zone.
|
| SifPing()() | Sends a SIF_Ping message to the ZIS that manages this zone. |
| SifProvide(array<String>[]()) | Sends a SIF_Provide message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| SifRegister()() | Sends a SIF_Register message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| SifSend(String) | Sends arbitrary SIF_Message content to the zone. This method does not
alter the message or wrap it in an envelope prior to sending it.
|
| SifSubscribe(array<String>[]()) | Sends a SIF_Subscribe message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| SifUnprovide(array<String>[]()) | Sends a SIF_Unprovide message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| SifUnregister()() | Sends a SIF_Unregister message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| SifUnsubscribe(array<String>[]()) | Sends a SIF_Unsubscribe message to the ZIS. This method can be called by
agents that have chosen to use Agent-managed provisioning. If ZIS-managed
or Adk-managed provisioning is enabled for this zone, the method has no
effect.
|
| Sleep()() | 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#connect |
| ToString()() | Returns the string representation of this zone as "zoneId@zoneUrl" |
| UserData | Gets or Sets an application-supplied object to this Zone |
| WakeUp()() | Wakes up this zone if currently in sleep mode.
A SIF_Wakeup message is sent to the Zone Integration Server to request
that sleep mode be removed from this agent's queue. Note the Adk keeps
an internal sleep flag for each zone, which is initialized when the
CopyC#connect |
| ZoneId | Gets the zone identifier |
| ZoneUrl | Gets the URL of the Zone Integration Server that manages this zone |