DOFQuery

A DOFQuery represents a way to receive notification of the availability of a set of Objects and/or Interfaces in the DOF network. More...

Typedefs
typedef struct DOFQuery_t *	DOFQuery
	Describes interest for query operations.

Enumerations
enum	DOFQueryMatchStyle_t {   DOFQUERYMATCHSTYLE_AT_LEAST,   DOFQUERYMATCHSTYLE_BASE,   DOFQUERYMATCHSTYLE_EXACT }
	Predefined DOF Query match styles, defining query match behavior. More...

Functions
DOFQueryBuilder	DOFQueryBuilder_Create (void)
	Create a new, empty query specification builder.
DOFQueryBuilder	DOFQueryBuilder_Create_Query (DOFQuery query)
	Create a query specification builder from an existing query.
void	DOFQueryBuilder_Destroy (DOFQueryBuilder self)
	Destroy a query specification builder.
void	DOFQuery_Destroy (DOFQuery self)
	Destroy a query specification.
boolean	DOFQueryBuilder_AddFilter (DOFQueryBuilder self, uint32 objectIDCount, const DOFObjectID objectIDs[], uint32 interfaceIDCount, const DOFInterfaceID interfaceIDs[])
	Add a filter into the query specification builder.
boolean	DOFQueryBuilder_AddRestriction (DOFQueryBuilder self, uint32 interfaceIDCount, const DOFInterfaceID interfaceIDs[])
	Add interfaces to the restriction list.
boolean	DOFQueryBuilder_SetMatchStyle (DOFQueryBuilder self, DOFQueryMatchStyle_t matchStyle)
	Set filter matching style.
DOFQuery	DOFQueryBuilder_Build (DOFQueryBuilder self)
	Build a DOFQuery.
DOFQuery	DOFQueryBuilder_BuildAndDestroy (DOFQueryBuilder self)
	Build a DOFQuery and destroy the builder.

Detailed Description

A DOFQuery represents a way to receive notification of the availability of a set of Objects and/or Interfaces in the DOF network.

A DOFQuery is used by the application to query the DOFSystem to discover available Objects that can be accessed. Queries are always against the current known state of the network, and can only report about Objects and Interfaces that match current Interest operations.

A DOFQueryBuilder is used to construct a DOFQuery. Filter blocks can be added to the builder, indicating the Object IDs and Interface IDs that are desired. A query match style can be used to indicate how Object IDs are matched (see DOFQueryBuilder_SetMatchStyle), and a restriction list can be set so that only the interfaces in the list are passed to the application callback (normally all interfaces available on a matching Object are passed to the callback).