DOF Interface Definition. More...
Modules | |
| DOFInterfaceEvent | |
| DOFInterfaceException | |
| DOFInterfaceMethod | |
| DOFInterfaceProperty | |
Files | |
| file | oal.h |
| Header file for the C OAL functions, defines and data types. | |
Typedefs | |
| typedef struct DOFInterface_t * | DOFInterface |
| DOF Interface representation. | |
| typedef struct DOFInterfaceProperty_t * | DOFInterfaceProperty |
| Definition of a Property within a DOF Interface. | |
| typedef struct DOFInterfaceEvent_t * | DOFInterfaceEvent |
| Definition of an Event within a DOF Interface. | |
| typedef struct DOFInterfaceMethod_t * | DOFInterfaceMethod |
| Definition of a Method within a DOF Interface. | |
| typedef struct DOFInterfaceException_t * | DOFInterfaceException |
| Definition of an Exception within a DOF Interface. | |
Functions | |
| DOFInterface | DOFInterface_Create (const DOFInterfaceID iid, uint32 dataSize, const uint8 *data) |
| Construct a DOFInterface from its serialized byte array form. | |
| void | DOFInterface_Destroy (DOFInterface self) |
| Destroy a DOFInterface. | |
| DOFInterfaceEvent | DOFInterface_GetEvent (const DOFInterface self, DOFItemID itemID) |
| Get an Event from the Interface, given its identifier (a DOFItemID). | |
| DOFInterfaceException | DOFInterface_GetException (const DOFInterface self, DOFItemID itemID) |
| Get an Exception from the Interface, given its identifier (a DOFItemID). | |
| DOFInterfaceMethod | DOFInterface_GetMethod (const DOFInterface self, DOFItemID itemID) |
| Get a Method from the Interface, given its identifier (a DOFItemID). | |
| DOFInterfaceProperty | DOFInterface_GetProperty (const DOFInterface self, DOFItemID itemID) |
| Get a Property from the Interface, given its identifier (a DOFItemID). | |
| const uint8 * | DOFInterface_GetBytes (const DOFInterface self) |
| Get the serialized form of the Interface definition. | |
| uint32 | DOFInterface_GetBytesSize (const DOFInterface self) |
| Get the size of the serialized form of the Interface definition. | |
| DOFInterfaceID | DOFInterface_GetInterfaceID (const DOFInterface self) |
| Get the Interface ID associated with the Interface. | |
DOF Interface Definition.
A DOFInterface defines a set of possible interactions with a DOFObject, which is typically remote (across the network). Conceptually it is similar to interfaces in object-oriented programming languages such as Java or C#. It is composed of a set of Properties, Methods, Events and Exceptions with their parameter and type information.
A DOFObject that provides (or implements) a DOFInterface is called a Provider, while a DOFObject that makes requests (such as invoking a method or setting a property value) is called a Requestor.