DOF Interface Definition. More...
Modules | |
| DOFInterfaceEvent | |
| DOFInterfaceException | |
| DOFInterfaceMethod | |
| DOFInterfaceProperty | |
Data Structures | |
| struct | DOFInterfacePropertyList |
| DOF Interface Property List structure. More... | |
| struct | DOFInterfaceEventList |
| DOF Interface Event List structure. More... | |
| struct | DOFInterfaceMethodList |
| DOF Interface Method List structure. More... | |
| struct | DOFInterfaceExceptionList |
| DOF Interface Exception List structure. More... | |
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. | |
| typedef struct DOFInterfaceBuilder_t * | DOFInterfaceBuilder |
| The DOFInterface builder used to build a DOFInterface. | |
Functions | |
| DOFInterface | DOFInterface_Create (const DOFInterfaceID iid, uint32 dataSize, const uint8 *data) |
| Construct a DOFInterface from its serialized byte array form. | |
| DOFInterface | DOFInterface_Copy (DOFInterface self) |
| Create a new copy of an existing DOFInterface. | |
| 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. | |
| uint32 | DOFInterface_GetMarshalSize (const DOFInterface self) |
| Get the number of bytes required in a buffer to marshal a DOFInterface. | |
| uint32 | DOFInterface_Marshal (const DOFInterface self, uint32 length, uint8 *buffer) |
| Marshal a DOFInterface into an existing buffer. | |
| DOFInterface | DOFInterface_Unmarshal (const DOFInterfaceID iid, uint32 *length, uint8 *buffer) |
| Create a new DOFInterface from a given byte representation of a DOFInterface. | |
| DOFInterfacePropertyList | DOFInterface_CreatePropertyList (const DOFInterface self) |
| Create a list of DOFInterfaceProperty objects based on the properties from the interface. | |
| DOFInterfaceEventList | DOFInterface_CreateEventList (const DOFInterface self) |
| Create a list of DOFInterfaceEvent objects based on the events from the interface. | |
| DOFInterfaceMethodList | DOFInterface_CreateMethodList (const DOFInterface self) |
| Create a list of DOFInterfaceMethod objects based on the methods from the interface. | |
| DOFInterfaceExceptionList | DOFInterface_CreateExceptionList (const DOFInterface self) |
| Create a list of DOFInterfaceException objects based on the exceptions from the interface. | |
| DOFInterfaceBuilder | DOFInterfaceBuilder_Create (const DOFInterfaceID iid) |
| Create an interface builder given only the DOFInterfaceID. | |
| boolean | DOFInterfaceBuilder_AddProperty (DOFInterfaceBuilder self, DOFItemID itemID, DOFPropertyAccessPermission accessLevel, DOFType type) |
| Add a property to the interface builder. | |
| boolean | DOFInterfaceBuilder_AddEvent (DOFInterfaceBuilder self, DOFItemID itemID, uint16 parameterCount, DOFType parameters[]) |
| Add an event to the interface builder. | |
| boolean | DOFInterfaceBuilder_AddMethod (DOFInterfaceBuilder self, DOFItemID itemID, uint16 inParameterCount, DOFType inParameters[], uint16 outParameterCount, DOFType outParameters[]) |
| Add a method to the interface builder. | |
| boolean | DOFInterfaceBuilder_AddException (DOFInterfaceBuilder self, DOFItemID itemID, uint16 parameterCount, DOFType parameters[]) |
| Add an exception to the interface builder. | |
| DOFInterface | DOFInterfaceBuilder_Build (DOFInterfaceBuilder self) |
| Build an immutable DOFInterface from this DOFInterfaceBuilder instance and its current set of properties, methods, events and exceptions. | |
| DOFInterface | DOFInterfaceBuilder_BuildAndDestroy (DOFInterfaceBuilder self) |
| Build an immutable DOFInterface from this DOFInterfaceBuilder instance, then destroy this DOFInterfaceBuilder instance. | |
| void | DOFInterfaceBuilder_Destroy (DOFInterfaceBuilder self) |
| Destroy a DOFInterfaceBuilder instance. | |
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.