---

pds.h

#ifndef _PDS_H_
#define _PDS_H_

/*
 *
 *  $Id: pds.h,v 1.11 2003/10/20 17:06:47 pmw Exp $
 *
 */
#ifdef __cplusplus
extern "C" {
#endif

#include <sys/types.h>

#include "atl.h"

#include "cm.h"
#include "echo.h"

#include "pdsdefs.h"


#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')

extern pds_entity_id_t null_pds_entity_id;
extern pds_context_id_t null_pds_context_id;
extern pds_domain_id_t null_pds_domain_id;
  

/*
 * Server API
 */

pds_service pds_service_open (attr_list contact_attrs);

int pds_service_close (pds_service service_to_close);

int pds_shutdown_server (pds_service);

/*
 * High level API
 */

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);

/*
 * Domain API
 */
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);
  /* @} */


/*
 *  Context API
 */

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);



/*
 *  Entity API
 */

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();

#ifdef __cplusplus
} // matches extern "C"
#endif

#endif


/*
 *
 *  $Log: pds.h,v $
 *  Revision 1.11  2003/10/20 17:06:47  pmw
 *  Changed documentation to reflect the impending demise of pds_create_domain
 *
 *  Revision 1.10  2003/10/05 12:10:23  pmw
 *  Changes to make utils a C module instead of C++, allowing people to
 *  link against its functions more easily
 *
 *  Revision 1.9  2003/03/19 03:49:27  pmw
 *  more documentation tweaks
 *
 *  Revision 1.8  2003/03/18 20:47:32  pmw
 *  added some more documentation stuff
 *
 *  Revision 1.7  2002/10/30 03:52:50  pmw
 *  added parameter to get_binding_list functions to optionally get only entities
 *  or contexts
 *
 *  Revision 1.6  2002/10/22 02:38:12  pmw
 *  Finished Doxygen comments for API.
 *
 *  Revision 1.5  2002/10/21 22:40:21  pmw
 *  Still more comments
 *
 *  Revision 1.4  2002/10/16 21:27:30  pmw
 *  More comments.
 *
 *  Revision 1.3  2002/10/16 04:58:37  pmw
 *  added initial Doxygen comments
 *
 *  Revision 1.2  2002/08/07 18:51:43  eisen
 *  Widespread changes to modify how attribute handling works.  Stop using
 *  attr_atom_from_string() to get atom values.  Instead, those are set by the
 *  application.  Stop using get_attr() (api has changes).  Stop using
 *  xmit_object and start using the ATL-supplied encode/decode routines.
 *
 *  Revision 1.1  2001/10/09 21:37:53  pmw
 *  configuration changes
 *
 *  Revision 1.5  2001/09/23 22:55:54  pmw
 *  Contexts now support attributes of their own.  Practically, this is supported
 *  by having ContextBindable host the attribute list instead of Entity/Context.  Also
 *  added the usual functions on the client side and handlers for getting/setting
 *  this attr list for Contexts.
 *
 *  Revision 1.4  2001/09/10 03:55:43  pmw
 *  client lib is now libpdsagent, and is compiled entirely with gcc.  libpdsutil no
 *  longer exists.
 *
 *  Revision 1.3  2001/09/03 20:09:10  pmw
 *  changes to deal with string-marshaled attr lists
 *
 *  Revision 1.2  2001/07/02 15:07:43  pmw
 *  removed ContextBindable class def and impl to their own source files
 *
 *  Revision 1.1.1.1  2000/12/13 22:14:21  pmw
 *  imported sources
 *
 *  Revision 1.16  2000/12/05 00:24:20  pmw
 *  Added server_shutdown message
 *
 *  Revision 1.15  2000/11/30 01:47:55  pmw
 *  rearranged include files to fix inappropriate inclusions
 *
 *  Revision 1.14  2000/11/29 04:37:37  pmw
 *  changed channel-handling again, Entity now performs most of its own
 *  change event sends
 *
 *  Revision 1.13  2000/11/22 21:42:36  pmw
 *  proactivity based on entity events now appears to work correctly.  In particular,
 *  creation events based on the prior registration of placeholder entities and their
 *  later "creation" as real entities works.
 *
 *  Revision 1.12  2000/11/21 21:35:28  pmw
 *  Domain change events now work correctly.  moved event transmission
 *  responsibilities to Proactive class.
 *
 *  Revision 1.11  2000/11/21 00:23:56  pmw
 *  Since I didn't have enough to do, a little code reorganization to keep
 *  things from getting dramatically out of hand.  Fixed a couple of
 *  bugs-in-waiting.
 *
 *  Revision 1.10  2000/11/20 05:08:53  pmw
 *  added pds_open_domain call.  semantics are such that a domain id is always
 *  returned, either because one matching the criteria was found or a new one
 *  was created because no matches were found.
 *
 *  Revision 1.9  2000/11/19 23:28:31  pmw
 *  pds_server now supports bulk load of data with -f command-line option.  Also added
 *  command message so bulk loads can happen on-line.
 *
 *  Revision 1.8  2000/10/25 21:44:49  pmw
 *  Compiles after major revisions to support multiple WP services on
 *  client-side.  This should eventually allow a client to use services by
 *  linking in the library directly or by communicating using CMRPC.
 *
 *  Revision 1.7  2000/09/19 21:12:12  pmw
 *  revised for new cmrpc handler interface
 *
 *  Revision 1.6  2000/04/10 20:00:13  pmw
 *  completed port to CM from DataExchange
 *
 *  Revision 1.5  2000/01/06 04:59:06  pmw
 *  changed id scheme so java side is simpler
 *
 *  Revision 1.4  1999/12/21 18:47:56  pmw
 *  Too many changes - really shouldn't have done this many
 *
 *  Revision 1.3  1999/12/09 22:35:15  pmw
 *  added client_priv header, RCS comments
 *
 *
 */

---