Compounds | |
struct | _pds_entity_id_t_struct |
struct | _pds_context_id_t_struct |
struct | _pds_domain_id_t_struct |
struct | _pds_entity_data_t_struct |
struct | _pds_entity_change_event_struct |
struct | _pds_context_change_event_struct |
struct | _pds_domain_change_event_struct |
Defines | |
#define | PDS_IP_PORT ATL_CHAR_CONS('C','I','P','P') |
#define | PDS_IP_HOST ATL_CHAR_CONS('C','I','P','H') |
#define | PDS_IP_ADDR ATL_CHAR_CONS('C','I','P','A') |
#define | PDS_ID_SIZE 32 |
#define | PDS_ENTITY_CHANGE_BASE_VAL 300 |
#define | PDS_ENTITY_CHANGE_CREATION (PDS_ENTITY_CHANGE_BASE_VAL + 1) |
#define | PDS_ENTITY_CHANGE_ATTRS (PDS_ENTITY_CHANGE_BASE_VAL + 2) |
#define | PDS_ENTITY_CHANGE_BIND (PDS_ENTITY_CHANGE_BASE_VAL + 3) |
#define | PDS_ENTITY_CHANGE_UNBIND (PDS_ENTITY_CHANGE_BASE_VAL + 4) |
#define | PDS_ENTITY_CHANGE_DELETION (PDS_ENTITY_CHANGE_BASE_VAL + 5) |
#define | PDS_ENTITY_CHANGE_DATA (PDS_ENTITY_CHANGE_BASE_VAL + 6) |
#define | PDS_CONTEXT_CHANGE_BASE_VAL 320 |
#define | PDS_CONTEXT_CHANGE_CREATION (PDS_CONTEXT_CHANGE_BASE_VAL + 1) |
#define | PDS_CONTEXT_CHANGE_ATTRS (PDS_CONTEXT_CHANGE_BASE_VAL + 2) |
#define | PDS_CONTEXT_CHANGE_BIND (PDS_CONTEXT_CHANGE_BASE_VAL + 3) |
#define | PDS_CONTEXT_CHANGE_UNBIND (PDS_CONTEXT_CHANGE_BASE_VAL + 4) |
#define | PDS_CONTEXT_CHANGE_DELETION (PDS_CONTEXT_CHANGE_BASE_VAL + 5) |
#define | PDS_DOMAIN_CHANGE_BASE_VAL 350 |
#define | PDS_DOMAIN_CHANGE_CONTEXT_CHANGE (PDS_DOMAIN_CHANGE_BASE_VAL + 1) |
#define | PDS_DOMAIN_CHANGE_ENTITY_CHANGE (PDS_DOMAIN_CHANGE_BASE_VAL + 2) |
#define | OnlyEntityBindings 0x1 |
#define | OnlyContextBindings 0x2 |
#define | GetDataBuffer 0x2 |
#define | GetDataSize 0x4 |
#define | GetDataType 0x8 |
Typedefs | |
typedef _pds_service_struct * | pds_service |
typedef _pds_entity_id_t_struct | pds_entity_id_t |
typedef _pds_entity_id_t_struct * | pds_entity_id_t_ptr |
typedef _pds_context_id_t_struct | pds_context_id_t |
typedef _pds_context_id_t_struct * | pds_context_id_t_ptr |
typedef _pds_domain_id_t_struct | pds_domain_id_t |
typedef _pds_domain_id_t_struct * | pds_domain_id_t_ptr |
typedef _pds_entity_data_t_struct | pds_entity_data_t |
typedef _pds_entity_data_t_struct * | pds_entity_data_t_ptr |
typedef _pds_entity_change_event_struct | pds_entity_change_event |
typedef _pds_entity_change_event_struct * | pds_entity_change_event_ptr |
typedef _pds_context_change_event_struct | pds_context_change_event |
typedef _pds_context_change_event_struct * | pds_context_change_event_ptr |
typedef _pds_domain_change_event_struct | pds_domain_change_event |
typedef _pds_domain_change_event_struct * | pds_domain_change_event_ptr |
Functions | |
pds_service | pds_service_open (attr_list contact_attrs) |
int | pds_service_close (pds_service service_to_close) |
int | pds_shutdown_server (pds_service) |
int | pds_lookup_string (pds_domain_id_t domain_id, const char *fullname, char **value) |
int | pds_bind_string (pds_domain_id_t domain_id, const char *fullname, const char *value) |
int | pds_lookup_int (pds_domain_id_t domain_id, const char *fullname, int *value) |
int | pds_bind_int (pds_domain_id_t domain_id, const char *fullname, int value) |
int | pds_lookup_blob (pds_domain_id_t domain_id, const char *fullname, char **value) |
int | pds_bind_blob (pds_domain_id_t domain_id, const char *fullname, char *value, unsigned int length) |
int | pds_bulk_load_from_URL (pds_service s, const char *url) |
pds_domain_id_t | pds_create_domain (pds_service s, const char *domain_name, const char *domain_type, int domain_version, const char *application_name) |
pds_domain_id_t | pds_open_domain (pds_service s, const char *domain_name, const char *domain_type, int domain_version, const char *application_name) |
int | pds_remove_domain (pds_domain_id_t id) |
int | pds_find_matching_domains (pds_service s, const char *domain_name, const char *domain_type, int domain_version, const char *application_name, pds_domain_id_t **matches) |
int | pds_set_domain_attrs (pds_domain_id_t d_id, attr_list al) |
int | pds_get_domain_attrs (pds_domain_id_t d_id, attr_list al) |
pds_context_id_t | pds_create_context (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id) |
int | pds_remove_context (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id) |
int | pds_remove_context_by_id (pds_domain_id_t d_id, pds_context_id_t c_id) |
pds_context_id_t | pds_get_root_context (pds_domain_id_t d_id) |
char ** | pds_get_binding_list (pds_domain_id_t d_id, const char *name, int opt_mask) |
char ** | pds_get_binding_list_id (pds_domain_id_t d_id, pds_context_id_t c_id, int opt_mask) |
pds_entity_id_t | pds_create_entity (pds_domain_id_t d_id, const char *fullname, pds_context_id_t c_id, pds_entity_data_t *edata, attr_list attribute_list) |
int | pds_remove_entity (pds_domain_id_t d_id, const char *fullname, pds_context_id_t c_id) |
int | pds_remove_entity_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id) |
int | pds_bind_entity_to_name (pds_domain_id_t d_id, const char *source_name, pds_context_id_t source_context, const char *new_name, pds_context_id_t new_name_context) |
int | pds_bind_entity_to_name_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id, const char *new_name, pds_context_id_t new_name_context) |
int | pds_unbind_entity_from_name (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id) |
pds_entity_id_t | pds_resolve_entity_name (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id) |
ECSinkHandle | pds_register_for_domain_changes (CManager cm, pds_domain_id_t d_id, ECTypedHandlerFunction func_ptr, void *client_data) |
ECSinkHandle | pds_register_for_entity_changes (CManager cm, pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, ECTypedHandlerFunction func_ptr, void *client_data) |
ECSinkHandle | pds_register_for_context_changes (CManager cm, pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, ECTypedHandlerFunction func_ptr, void *client_data) |
int | pds_cancel_changes_registration (ECSinkHandle sink_handle) |
int | pds_get_entity_data (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, pds_entity_data_t *edata, int opt_mask) |
int | pds_get_entity_data_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id, pds_entity_data_t *edata, int opt_mask) |
int | pds_set_entity_data (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, pds_entity_data_t *edata, int opt_mask) |
int | pds_set_entity_data_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id, pds_entity_data_t *edata, int opt_mask) |
int | pds_get_entity_attributes (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, attr_list attrs) |
int | pds_get_entity_attributes_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id, attr_list attributes) |
int | pds_set_entity_attributes (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, attr_list attrs, int opt) |
int | pds_set_entity_attributes_by_id (pds_domain_id_t d_id, pds_entity_id_t e_id, attr_list attributes, int opt) |
pds_entity_id_t * | pds_find_matching_entities (pds_domain_id_t d_id, const char *name, pds_context_id_t c_id, attr_list attributes) |
pds_entity_id_t * | pds_find_matching_entities_by_name (pds_domain_id_t d_id, const char *fullname, attr_list attributes) |
CManager | pds_get_CManager () |
Variables | |
pds_entity_id_t | null_pds_entity_id |
pds_context_id_t | null_pds_context_id |
pds_domain_id_t | null_pds_domain_id |
|
UID for the ENTITY_CHANGE_CREATION event. Submitted to the entity's update channel when the entity is created. Note that the semantics of update subscription in PDS allow interest to be registered for entities that don't exist at subscription time. |
|
UID for the ENTITY_CHANGE_ATTRS event. Submitted to the entity's update channel when the attributes of the entity are updated. |
|
UIDs for the ENTITY_CHANGE_BIND/UNBIND events. Submitted to the entity's update channel when the entity is (un)bound (from)to a particular name in a PDS domain. |
|
UID for the ENTITY_CHANGE_DELETION event. Submitted to the entity's update channel when the entity is deleted from its hosting PDS service instance. |
|
UID for the ENTITY_CHANGE_DATA event. Submitted to the entity's update channel when the entity's data is modified. |
|
Opaque structure identifying a remote PDS service instance. |
|
ID for PDS entities |
|
ID for PDS entities |
|
ID for PDS contexts |
|
ID for PDS contexts |
|
ID for PDS domains |
|
ID for PDS domains |
|
Typedef for entity data stored in PDS. The structure contains a pointer to the data buffer, the size of the data buffer, and an attr_value indicating the type of the data. |
|
Typedef for entity data stored in PDS. The structure contains a pointer to the data buffer, the size of the data buffer, and an attr_value indicating the type of the data. |
|
Open a connection to a PDS service instance. The service may be local or remote as specified by the attribute list given as a parameter.
|
|
Close the connection to the given PDS service instance.
|
|
Request that the PDS service instance identified by the parameter shut down. Currently, the service instance is not required to honor the request.
|
|
Look up a string value.
|
|
Bind a string to a name in the given domain. Binding creates an association between the context name and the value which can be queried at a later time.
|
|
Look up an integer (Attr_Int4) value.
|
|
Bind an integer to a name in the given domain. Binding creates an association between the context name and the value which can be queried at a later time.
|
|
Look up a blob (binary large object - Attr_Unknown) value.
|
|
Bind a blob (binary large object) to a name in the given domain. Binding creates an association between the context name and the value which can be queried at a later time.
|
|
Load the directory with a content file found at the given URL. Testing or initialization purposes may require that a service instance contain a known set of information. This function retrieves an XML file containing one or more PDS bulk-load sets and adds its contents to the in-memory state of the instance. The format of the XML file is defined elsewhere (yeah right). The end state of the service instance is the union of any content existing when this function is called and the content of the file. Common context values between pre-existing content and the file are bound to entity values found in the file. Existing event registrations are not affected, and all defined change events are fired. The bulk-load may cause entity placeholders to be promoted to live entities; i.e. there is no way currently to register interest in an entity using the bulk-load process without explicitly creating it (implying that no creation events are fired by the bulk-load). Currently the service instance is not required to honor the request to perform the bulk-load.
|
|
Create a new domain in the given service instance. If a domain matching the given information already exists, its domain ID is returned instead.
|
|
Open an existing domain in the given service instance. If no domain matching the given parameters is found, a new domain is created and its ID returned.
|
|
Remove the indicated domain from its service instance. The handle to the instance is not necessary since domains know what service instance they belong to. All events for context destruction and entity unbinding/destruction are fired.
|
|
Locate domains matching the given characteristics. Limited string-matching is performed; i.e. wildcards are not generally supported. If you do not want to search based on one of the items, do not specify a value for that item (pass NULL for
|
|
Set/get the attributes of a domain. The given attribute list replaces the previous attribute list.
|
|
Create a context in the given domain. The name and c_id parameters are used as follows. String-based naming for contexts and entities in PDS is the preferred method, and results in names like "/path/to/the/entity" being used to identify these objects. In such a name string, "/", "/path", "/path/to", and "/path/to/the" all identify contexts. Each of these contexts has associated with it a context ID. Relative naming applies a "base" context ID to a string-based name. For example, if
|
|
Remove a context from the given domain. All bindings held by the context are unbound and associated context/entity unbinding events fired. See
|
|
Remove a context from the given domain, specifying it directly by its ID. All bindings held by the context are unbound and associated context/entity unbinding events fired.
|
|
Get the context ID of the root context of the domain's namespace.
|
|
Get the binding list of a context. The binding list consists of all names bound to either contexts or entities in that context. This function allocates memory for its return value which the caller must release after use by calling
|
|
Get the binding list of a context. The binding list consists of all names bound to either contexts or entities in that context. This function allocates memory for its return value which the caller must release after use by calling
|
|
Create an entity in the given context in the given domain. Relative/absolute naming applies with the fullname and c_id parameters as described in the context API.
|
|
Remove an entity from the given domain. Relative/absolute naming applies with the fullname and c_id parameters as described in the context API.
|
|
Remove an entity from the given Domain, identifying the entity by its ID.
|
|
Bind an entity to a name in a specific context. This function expects that the entity is already bound to a name in the domain and so can be identified by that name (relative to a context ID if desired). Thus this function serves to create alternate bindings to a single entity.
|
|
Bind an entity to a name in a specific context. This function expects that the entity is identified by its ID.
|
|
Unbind an entity from a name. name and c_id are used to identify an entity, and then that binding to the entity is removed.
|
|
Obtain an entity ID from a name.
|
|
Register for any changes on the given domain. The handler function specified by func_ptr is called with domain update events.
|
|
Register for any changes on the given entity. The handler function specified by func_ptr is called with entity update events.
|
|
Register for any changes on the given context. The handler function specified by func_ptr is called with entity update events.
|
|
Cancel the registration for a particular sink handle.
|
|
Return the entity data for a particular entity.
|
|
Return the entity data for a particular entity. The entity is identified by its entity ID.
|
|
Set the entity data for a particular entity.
|
|
Set the entity data for a particular entity. The entity is identified by its entity ID.
|
|
Get the entity attributes for a particular entity.
|
|
Get the entity attributes for a particular entity. The entity is identified by its entity ID.
|
|
Set the entity attributes for a particular entity.
|
|
Set the entity attributes for a particular entity. The entity is identified by its entity ID.
|
|
Search the domain for entities matching the attributes contained in attributes. This function can be used to search for entities across the entire domain or only those bound in a given context. This context is identified in this function by the absolute/relative naming scheme described in the Context API. If name is NULL and c_id is null_pds_context_id, then the entire domain is searched. Subset-equality is used for the match - if the given attribute list is exactly equal or a subset of the attribute list of an entity, the entity is considered a match.
|
|
Search the domain for entities matching the attributes contained in attributes. This function can be used to search for entities across the entire domain or only those bound in a given context. This context is identified in this function by the absolute name fullname. If fullname is NULL, then the entire domain is searched. Subset-equality is used for the match - if the given attribute list is exactly equal or a subset of the attribute list of an entity, the entity is considered a match.
|
|
Returns the CManager value used by the PDS client-side library.
|
|
A pre-defined NULL entity ID. Conceptually equivalent to a NULL char*. |
|
A pre-defined NULL context ID. Conceptually equivalent to a NULL char*. |
|
A pre-defined NULL domain ID. Conceptually equivalent to a NULL char*. |