SIFWorks ADK 2.0
IPublisher Interface
NamespacesEdustructures.SifWorksIPublisher

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

The Publisher interface is implemented by classes that respond to queries (SIF_Requests). Implement the Publisher interface on a class that is capable of responding to SIF_Requests for one or more SIF Data Objects, then register your class with a Topic or Zone by calling the
CopyC#
Topic.setPublisher
or
CopyC#
Zone.setPublisher
methods. SIF_Request messages received by the ADK are then dispatched to your Publisher for processing.
Declaration Syntax
C#Visual BasicVisual C++
public interface IPublisher
Public Interface IPublisher
public interface class IPublisher
Members
All MembersMethods



IconMemberDescription
OnRequest(IDataObjectOutputStream, Query, IZone, IMessageInfo)
Respond to a SIF_Request received from a zone. The implementation should evaluate the supplied Query to build a set of SIFDataObjects that satisfy the conditions and field restrictions placed on the query. To return these objects to the ZIS, repeatedly call the
CopyC#
DataObjectOutputStream.write( SIFDataObject )
method. The ADK returns the results of the request to the requestor by sending one or more SIF_Response messages. This is handled in a separate thread managed by the framework. If the number of SIFDataObjects passed to the output stream is too large to fit into a single SIF_Response message, the ADK handles breaking it up into multiple packets. The result data may be temporarily stored on disk until all packets can be returned to the ZIS.

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