DOF Interface Identifier. More...
Data Structures | |
| struct | DOFInterfaceIDList |
| DOF InterfaceID List structure. More... | |
Macros | |
| #define | DOFINTERFACEID_MAX_SIZE |
| Maximum size of the wire format representation of an Interface Identifier. | |
| #define | DOFINTERFACEID_TEST_REGISTRY |
| Standard testing Interface Registry. | |
Typedefs | |
| typedef struct DOFInterfaceID_t * | DOFInterfaceID |
| DOF Interface Identifier. | |
Functions | |
| DOFInterfaceID | DOFInterfaceID_Create (uint8 registry, uint32 identifier) |
| Create an Interface ID from given registry and identifier. | |
| DOFInterfaceID | DOFInterfaceID_Copy (const DOFInterfaceID self) |
| Create a new copy of an existing DOFInterfaceID. | |
| DOFInterfaceID | DOFInterfaceID_Create_StandardString (const char *data) |
| Create an Interface ID from a string representation of a DOFInterfaceID. | |
| DOFInterfaceID | DOFInterfaceID_Create_Bytes (uint32 dataSize, const uint8 *data) |
| Create an Interface ID from a given Interface ID buffer. | |
| const uint8 * | DOFInterfaceID_GetBytes (const DOFInterfaceID self) |
| Get pointer to the wire-representation bytes of an Interface ID. | |
| uint8 | DOFInterfaceID_GetBytesSize (const DOFInterfaceID self) |
| Get number of bytes of the wire-representation bytes of an Interface ID. | |
| uint8 | DOFInterfaceID_GetRegistry (const DOFInterfaceID self) |
| Get registry value of an Interface ID. | |
| uint32 | DOFInterfaceID_GetIdentifier (const DOFInterfaceID self) |
| Get the numeric identifier of an Interface ID. | |
| void | DOFInterfaceID_Destroy (DOFInterfaceID self) |
| Destroy an Interface ID. | |
| char * | DOFInterfaceID_CreateStandardString (const DOFInterfaceID iid) |
| Convert an Interface ID into its standard string representation. | |
| int32 | DOFInterfaceID_Compare (const DOFInterfaceID iid1, const DOFInterfaceID iid2) |
| Compare two Interface IDs. | |
| boolean | DOFInterfaceID_IsEqual (const DOFInterfaceID iid1, const DOFInterfaceID iid2) |
| Compare two Interface IDs for equality. | |
| void | DOFInterfaceIDList_Destroy (DOFInterfaceIDList iidList) |
| Release resources previously allocated while forming an Interface ID list. | |
| uint32 | DOFInterfaceID_GetMarshalSize (const DOFInterfaceID self) |
| Get the number of bytes required in a buffer to marshal a DOFInterfaceID. | |
| uint8 | DOFInterfaceID_Marshal (const DOFInterfaceID self, uint32 length, uint8 *buffer) |
| Marshal a DOFInterfaceID into an existing buffer. | |
| DOFInterfaceID | DOFInterfaceID_Unmarshal (uint32 *length, const uint8 *buffer) |
| Create a new DOFInterfaceID from a given byte representation of DOFInterfaceID. | |
Variables | |
| DOFInterfaceID | DOFINTERFACEID_WILDCARD |
| The C OAL provides and maintains this broadcast Interface ID, so applications need not create/destroy their own. | |
DOF Interface Identifier.
This class implements a DOF Interface Identifier. It is self descriptive, allowing its registry number, ID length, and ID data field to be identified and extracted.
DOFInterfaceIDs are immutable, and should be treated as such by the application. With the calls of this API, DOFInterfaceIDs are created by the system. It is up to the application to later destroy any DOFInterfaceID that it created.