OpenClovis Logo

Classes | Macros | Typedefs | Enumerations | Functions
clNameApi.h File Reference

Header file of Name Service Related APIs. More...

#include "clBufferApi.h"
#include <clEoApi.h>

Go to the source code of this file.

Classes

struct  ClNameSvcAttrEntryT
 Attribute structure. More...
struct  ClNameSvcAttrSearchT
 For attribute related search. More...
struct  ClNameSvcCompList
 List of components. More...
struct  ClNameSvcEntryT
 Name Service Entry. More...
struct  ClNameSvcEventInfoT
 Information passed to Name Service users via events whenever there is a change in Name Service database. More...
struct  ClNameSvcRegisterT
 The structure ClNameSvcRegisterT contains the name service registration information. More...

Macros

#define CL_NAME_EVENT_TYPE   0x100
 Id of the event published by Name Service.
#define CL_NAME_PUB_CHANNEL   "NAME_SVC_PUB_CHANNEL"
 Name Service event channel name.
#define CL_NAME_VERSION   {'B', 0x1, 0x1}
 Latest Supported Version for Name Service.
#define CL_NS_DEFT_ATTR_LIST   0x0
 For getting service from highest priority service provider.
#define CL_NS_DEFT_GLOBAL_CONTEXT   0xFFFFFFF
 Id of default global context.
#define CL_NS_DEFT_GLOBAL_MAP_COOKIE   0xFFFFFFF
 Context map cookie for default global scope context.
#define CL_NS_DEFT_LOCAL_CONTEXT   0xFFFFFFE
 Id of default node local context.
#define CL_NS_DEFT_LOCAL_MAP_COOKIE   0xFFFFFFE
 Context map cookie for default local scope context.
#define CL_NS_GET_OBJ_REF   0xFFFFFFF
 For getting service from highest priority service provider.
#define CL_NS_MAX_NO_ATTR   5
 Maximum number of attributes per entry.
#define CL_NS_MAX_STR_LENGTH   20
 Maximum length of strings used in name service.

Typedefs

typedef struct ClNameSvcCompList ClNameSvcCompListT
 List of components.

Enumerations

enum  ClNameSvcContextT {
  CL_NS_USER_NODELOCAL,
  CL_NS_USER_GLOBAL
}
 Type of context to be created. More...
enum  ClNameSvcOpT {
  CL_NS_COMPONENT_DEREGISTER_OP,
  CL_NS_SERVICE_DEREGISTER_OP,
  CL_NS_EO_DEREGISTER_OP,
  CL_NS_COMP_DEATH_DEREGISTER_OP,
  CL_NS_NODE_DEREGISTER_OP
}
 Type of operation that invoked event publish. More...
enum  ClNameSvcPriorityT {
  CL_NS_PRIORITY_LOW,
  CL_NS_PRIORITY_MEDIUM,
  CL_NS_PRIORITY_HIGH
}
 Component Priority values. More...

Functions

ClRcT clNameComponentDeregister (CL_IN ClUint32T compId)
 De-registers all entries of a component with Name Service.
ClRcT clNameContextCreate (CL_IN ClNameSvcContextT contextType, CL_IN ClUint32T contextMapCookie, CL_OUT ClUint32T *contextId)
 Creates a context.
ClRcT clNameContextDelete (CL_IN ClUint32T contextId)
 Deletes a context.
ClRcT clNameLibFinalize (void)
 Finalizes the name service library.
ClRcT clNameLibInitialize ()
 Initializes the name service library.
ClRcT clNameLibVersionVerify (CL_INOUT ClVersionT *pVersion)
 Verifies the version with the name service library.
ClRcT clNameObjectMappingCleanup (CL_IN ClNameSvcEntryPtrT pObjMapping)
 Frees the object mapping entry.
ClRcT clNameRegister (CL_IN ClUint32T contextId, CL_IN ClNameSvcRegisterT *pNSRegisInfo, CL_INOUT ClUint64T *pObjReference)
 Registers name to object reference mapping with Name Service.
ClRcT clNameServiceDeregister (CL_IN ClUint32T contextId, CL_IN ClUint32T compId, CL_IN ClNameT *serviceName)
 De-registers a particular service provided by a component.
ClRcT clNameToObjectMappingGet (CL_IN ClNameT *pName, CL_IN ClUint32T attrCount, CL_IN ClNameSvcAttrEntryT *pAttr, CL_IN ClUint32T contextMapCookie, CL_OUT ClNameSvcEntryPtrT *pOutBuff)
 Returns the entry of the service.
ClRcT clNameToObjectReferenceGet (CL_IN ClNameT *pName, CL_IN ClUint32T attrCount, CL_IN ClNameSvcAttrEntryT *pAttr, CL_IN ClUint32T contextMapCookie, CL_OUT ClUint64T *pObjReference)
 Returns the object reference for a service.

Detailed Description

Header file of Name Service Related APIs.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen