OpenDOF Project
Modules | Files | Data Structures | Typedefs | Functions
DOFSystem
Distributed Object Framework (DOF)

Represents a view into the DOF network. More...

Modules

 DOFSystemConfig
 Represents the static configuration of a DOFSystem.
 
 DOFSystemState
 Represents the instantaneous state of a DOFSystem.
 

Files

file  oal.h
 Header file for the C OAL functions, defines and data types.
 

Data Structures

struct  DOFSystemList
 DOF DOFSystem List structure. More...
 

Typedefs

typedef struct DOFSystem_t * DOFSystem
 Represents the DOF System, from the application's perspecitive, including security identification.
 
typedef struct DOFSystemState_t * DOFSystemState
 Provides current information about a DOFSystem.
 
typedef struct DOFSystemConfig_t * DOFSystemConfig
 A type to control certain behavior in a DOFSystem.
 
typedef struct
DOFSystemConfigBuilder_t * 
DOFSystemConfigBuilder
 A type to configure and build a DOFSystemConfig.
 

Functions

DOFOperation DOFSystem_BeginInterest (const DOFSystem sys, const DOFObjectID objectID, const DOFInterfaceID interfaceID, DOFInterestLevel level, DOFOperationControl config, uint32 timeout, const DOFSystemInterestCallback callback, void *context)
 Express interest for an Object ID and an Interface IDs.
 
DOFObjectIDList DOFSystem_Query (const DOFSystem sys, const DOFQuery query)
 Query the system for a list of objects available within the system.
 
DOFOperation DOFSystem_BeginQuery (const DOFSystem sys, const DOFQuery query, uint32 timeout, const DOFSystemQueryCallback callback, void *context)
 Register a set of callbacks for being notified of changes in availability of objects within the system.
 
DOFObject DOFSystem_CreateObject (DOFSystem sys, const DOFObjectID objectID)
 Create a new DOFObject in the system for use by the application.
 
DOFInterfaceIDList DOFSystem_GetProviderInterfaces (const DOFSystem sys, const DOFObjectID objectID)
 Query the system for the list of Interfaces available on the given Object.
 
boolean DOFSystem_AddActivateInterestListener (DOFSystem self, const DOFSystemActivateInterestListener listener)
 Adds a DOFSystemActivateInterestListener to the given DOFSystem, which is used by provider applications to begin providing in response to DOFINTERESTLEVEL_ACTIVATE interest requests.
 
void DOFSystem_RemoveActivateInterestListener (DOFSystem self, const DOFSystemActivateInterestListener listener)
 Remove a listener for when interest changes in the network.
 
boolean DOFSystem_IsInterestRequested (const DOFSystem self, const DOFObjectID objectID, const DOFInterfaceID interfaceID, DOFInterestLevel level)
 Determine if there is interest currently expressed for a given Object and Interface.
 
DOFObject DOFSystem_WaitProvider (const DOFSystem sys, const DOFObjectID objectID, uint32 interfaceIDCount, const DOFInterfaceID interfaceIDs[], uint32 timeout)
 Wait for a provider providing at least the given set of interfaces to become available in the system, and return a new, valid DOFObject for it.
 
DOFRouteInfo DOFSystem_CreateProviderRoute (const DOFSystem sys, const DOFObjectID objectID, const DOFInterfaceID interfaceID)
 Return the current route information for the best, compatible provider (if any) given an Object ID and Interface ID.
 
boolean DOFSystem_AddRouteListener (DOFSystem self, DOFSystemRouteListener listener)
 Add a listener to a system for when a route to a Provider available to the system is added, removed, or changed.
 
void DOFSystem_RemoveRouteListener (DOFSystem self, DOFSystemRouteListener listener)
 Remove the listener on a system added by DOFSystem_AddRouteListener.
 
void DOFSystem_Destroy (DOFSystem sys)
 Destroy a DOFSystem.
 
DOFSystemState DOFSystem_CreateState (DOFSystem self)
 Construct a DOFSystemState.
 
void DOFSystemList_Destroy (DOFSystemList list)
 Release resources of a DOFSystemList.
 

Detailed Description

Represents a view into the DOF network.

core-c-dof-oal Version 7.1.5 Build 0
2017-01-25