OpenDOF Project
DOFConnectionList DOFRuntime_GetProvidingConnections ( const DOFRuntime  self,
const DOFObjectID  objectID,
const DOFInterfaceID  interfaceID 
)

Gets a list of connections (DOFConnection), both inbound and outbound, over which a provide operation has been sent or received for a specified DOFInterface on a specified DOFObject.

In addition to specifying exact bindings, you can do the following:

  • Pass DOFOBJECTID_BROADCAST to get connections that are providing a specific interface on any object.
  • Pass DOFINTERFACEID_WILDCARD to get connections that are providing any interface on a specific object.
  • Pass both to get all connections that are providing any binding.

Only remote provide operations that have been received over a connection will cause the DOFConnection to appear in the collection. Local provide operations sent over a connection do not.

Resource Management:
This function allocates resources that must later be freed by calling DOFConnectionList_Destroy.
Parameters
selfThe DOFRuntime. This must not be NULL.
objectIDThe object identifier. This should not be NULL.
interfaceIDThe interface identifier. This should not be NULL.
Returns
A list of connections that are currently carrying provide operations.
Exceptions
NULLis returned if an invalid parameter is detected or the list could not be allocated.
See Also
DOFObject_BeginProvide
core-c-dof-oal Version 7.1.5 Build 0
2017-01-25