OpenDOF Project
Macros | Typedefs | Enumerations | Functions
DOFPermission
Distributed Object Framework (DOF)

Macros

#define DOFPERMISSIONTUNNELDOMAIN_ALL
 Tunnel domain identifier that represents all domains.
 

Typedefs

typedef struct DOFPermission_t * DOFPermission
 Immutable Permission.
 
typedef struct
DOFPermissionBuilder_t * 
DOFPermissionBindingBuilder
 Binding Permission Builder.
 

Enumerations

enum  DOFPermissionBindingAction {
  DOFPERMISSIONBINDINGACTION_EXECUTE,
  DOFPERMISSIONBINDINGACTION_WRITE,
  DOFPERMISSIONBINDINGACTION_READ,
  DOFPERMISSIONBINDINGACTION_PROVIDE,
  DOFPERMISSIONBINDINGACTION_SESSION,
  DOFPERMISSIONBINDINGACTION_ALL
}
 The Action flags for a Binding Permission. More...
 
enum  DOFPermissionType
 The type of the permission. More...
 

Functions

DOFPermission DOFPermissionBinding_Create (DOFPermissionBindingAction actions, const DOFObjectID objectID, const DOFInterfaceID interfaceID)
 Create a simple Binding type Permission from a single Object and Interface.
 
DOFPermission DOFPermissionRequestor_Create (void)
 Create an Requestor type Permission.
 
DOFPermission DOFPermissionProvider_Create (void)
 Create a Provider type Permission.
 
DOFPermission DOFPermissionDefine_Create (const DOFInterfaceID interfaceID)
 Create a Define type Permission.
 
DOFPermission DOFPermissionIAm_Create (DOFObjectIDSource sourceID)
 Create a I Am type Permission.
 
DOFPermission DOFPermissionActAs_Create (DOFObjectIDSource sourceID)
 Create a Act As type Permission.
 
DOFPermission DOFPermissionActAsAny_Create (void)
 Create a Act As Any type Permission.
 
DOFPermission DOFPermissionTunnelDomain_Create (uint32 rdid)
 Create a Tunnel Domain type Permission.
 
void DOFPermission_Destroy (DOFPermission self)
 Destroys a permission created from one of the create functions.
 
uint32 DOFPermission_GetMarshalSize (const DOFPermission self)
 Get the number of bytes required in a buffer to marshal a DOFPermission.
 
uint32 DOFPermission_Marshal (const DOFPermission self, uint32 length, uint8 *buffer)
 Marshal a DOFPermission into an existing buffer.
 
DOFPermission DOFPermission_Unmarshal (uint32 size, const uint8 *buffer)
 Create a new DOFPermission from a given byte representation of DOFPermission.
 
DOFPermissionType DOFPermission_GetPermissionType (DOFPermission self)
 Returns the type of the given permission.
 

Binding Permission Builder

DOFPermissionBindingBuilder DOFPermissionBindingBuilder_Create (DOFPermissionBindingAction actions)
 Creates a Permission builder for binding permission.
 
boolean DOFPermissionBindingBuilder_AddObjectID (DOFPermissionBindingBuilder self, DOFObjectID objectID)
 Add an ObjectID to a binding permission builder.
 
boolean DOFPermissionBindingBuilder_AddInterfaceID (DOFPermissionBindingBuilder self, DOFInterfaceID interfaceID)
 Add an InterfaceID to a binding permission builder.
 
boolean DOFPermissionBindingBuilder_SetAllAttributesAllowed (DOFPermissionBindingBuilder self, boolean allowed)
 Sets the builder to allow or not allow all attributes (any type, any data) to a binding permission builder.
 
boolean DOFPermissionBindingBuilder_AddRequiredWildcardAttribute (DOFPermissionBindingBuilder self, const DOFObjectIDAttributeType type)
 Add a wildcard attribute (any data) of a specific type to a binding permission builder.
 
boolean DOFPermissionBindingBuilder_AddRequiredAttribute_Buffer (DOFPermissionBindingBuilder self, const DOFObjectIDAttributeType type, uint32 valueSize, const uint8 *value)
 Add an attribute to a binding permission builder, based on a raw buffer.
 
boolean DOFPermissionBindingBuilder_AddRequiredAttribute_String (DOFPermissionBindingBuilder self, const DOFObjectIDAttributeType type, const char *value)
 Add an attribute to a binding permission builder, based on a C string.
 
boolean DOFPermissionBindingBuilder_AddRequiredAttribute_ObjectID (DOFPermissionBindingBuilder self, const DOFObjectIDAttributeType type, const DOFObjectID value)
 Add an attribute to a binding permission builder, based on a DOFObjectID.
 
boolean DOFPermissionBindingBuilder_AddActions (DOFPermissionBindingBuilder self, DOFPermissionBindingAction actions)
 Add one or more actions to a binding permission builder.
 
boolean DOFPermissionBindingBuilder_SetActions (DOFPermissionBindingBuilder self, DOFPermissionBindingAction actions)
 Sets the binding permission actions to the given actions.
 
DOFPermission DOFPermissionBindingBuilder_Build (DOFPermissionBindingBuilder self)
 Build a binding permission from the given binding permission builder.
 
DOFPermission DOFPermissionBindingBuilder_BuildAndDestroy (DOFPermissionBindingBuilder self)
 Build a binding permission from the given binding permission builder, and destroy the given builder.
 
void DOFPermissionBindingBuilder_Destroy (DOFPermissionBindingBuilder self)
 Destroys a binding permission builder.
 

Detailed Description

core-c-dof-oal Version 8.0.1 Build 0
2018-01-22