45 #ifndef _CL_NAME_API_H_
46 #define _CL_NAME_API_H_
61 #define CL_NS_MAX_NO_ATTR 5
67 #define CL_NS_MAX_STR_LENGTH 20
72 #define CL_NS_DEFT_GLOBAL_CONTEXT 0xFFFFFFF
78 #define CL_NS_DEFT_LOCAL_CONTEXT 0xFFFFFFE
83 #define CL_NS_DEFT_GLOBAL_MAP_COOKIE 0xFFFFFFF
88 #define CL_NS_DEFT_LOCAL_MAP_COOKIE 0xFFFFFFE
93 #define CL_NS_DEFT_ATTR_LIST 0x0
98 #define CL_NS_GET_OBJ_REF 0xFFFFFFF
103 #define CL_NAME_PUB_CHANNEL "NAME_SVC_PUB_CHANNEL"
109 #define CL_NAME_EVENT_TYPE 0x100
114 # define CL_NAME_VERSION {'B', 0x1, 0x1}
115 # define CL_NAME_VERSION_SET(version) (version).releaseCode = 'B', \
116 (version).majorVersion = 0x1,\
117 (version).minorVersion = 0x1
594 CL_IN ClUint32T contextMapCookie,
595 CL_OUT ClUint32T *contextId);
671 CL_IN ClUint32T attrCount,
673 CL_IN ClUint32T contextMapCookie,
674 CL_OUT ClUint64T* pObjReference);
717 CL_IN ClUint32T attrCount,
719 CL_IN ClUint32T contextMapCookie,
Header file of Buffer Management related APIs.
Header file of EO related APIs.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_INOUT
CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:108
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClUint64T ClEoIdT
The type of the EOId, assigned to an EO as part of registration to the Component Manager.
Definition: clEoConfigApi.h:63
ClUint32T ClIocPortT
The IOC communication port.
Definition: clIocApi.h:348
ClUint32T ClIocNodeAddressT
The IOC node address.
Definition: clIocApi.h:343
ClRcT clNameObjectMappingCleanup(CL_IN ClNameSvcEntryPtrT pObjMapping)
Frees the object mapping entry.
ClNameSvcContextT
Type of context to be created.
Definition: clNameApi.h:126
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.
struct ClNameSvcCompList ClNameSvcCompListT
List of components.
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.
ClRcT clNameServiceDeregister(CL_IN ClUint32T contextId, CL_IN ClUint32T compId, CL_IN ClNameT *serviceName)
De-registers a particular service provided by a component.
ClRcT clNameLibVersionVerify(CL_INOUT ClVersionT *pVersion)
Verifies the version with the name service library.
#define CL_NS_MAX_NO_ATTR
Maximum number of attributes per entry.
Definition: clNameApi.h:61
ClRcT clNameContextDelete(CL_IN ClUint32T contextId)
Deletes a context.
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.
ClNameSvcPriorityT
Component Priority values.
Definition: clNameApi.h:179
ClRcT clNameLibInitialize()
Initializes the name service library.
ClNameSvcOpT
Type of operation that invoked event publish.
Definition: clNameApi.h:144
ClRcT clNameRegister(CL_IN ClUint32T contextId, CL_IN ClNameSvcRegisterT *pNSRegisInfo, CL_INOUT ClUint64T *pObjReference)
Registers name to object reference mapping with Name Service.
#define CL_NS_MAX_STR_LENGTH
Maximum length of strings used in name service.
Definition: clNameApi.h:67
ClRcT clNameLibFinalize(void)
Finalizes the name service library.
@ CL_NS_USER_NODELOCAL
User defined node local context.
Definition: clNameApi.h:131
@ CL_NS_USER_GLOBAL
User defined global context.
Definition: clNameApi.h:136
@ CL_NS_PRIORITY_MEDIUM
Medium priority.
Definition: clNameApi.h:188
@ CL_NS_PRIORITY_LOW
Low priority.
Definition: clNameApi.h:183
@ CL_NS_PRIORITY_HIGH
High priority.
Definition: clNameApi.h:193
@ CL_NS_COMP_DEATH_DEREGISTER_OP
Deregister the entries based on the component death event.
Definition: clNameApi.h:165
@ CL_NS_NODE_DEREGISTER_OP
Deregister entries based on the node IOC address.
Definition: clNameApi.h:170
@ CL_NS_SERVICE_DEREGISTER_OP
Deregistration of service provided by a component.
Definition: clNameApi.h:153
@ CL_NS_EO_DEREGISTER_OP
Deregister the entries based on EoID.
Definition: clNameApi.h:159
@ CL_NS_COMPONENT_DEREGISTER_OP
Deregistration of a component on an API request.
Definition: clNameApi.h:148
A name.
Definition: clCommon.h:197
Version Information for various services.
Definition: clCommon.h:250
Information passed to Name Service users via events whenever there is a change in Name Service databa...
Definition: clNameApi.h:203
ClUint64T objReference
Object Reference.
Definition: clNameApi.h:213
ClNameT name
Name of the serivce.
Definition: clNameApi.h:208
ClUint32T contextMapCookie
Context where service exists.
Definition: clNameApi.h:223
ClNameSvcOpT operation
Operation type.
Definition: clNameApi.h:218
Attribute structure.
Definition: clNameApi.h:231
For attribute related search.
Definition: clNameApi.h:251
ClUint32T attrCount
Number of attributes.
Definition: clNameApi.h:261
The structure ClNameSvcRegisterT contains the name service registration information.
Definition: clNameApi.h:276
ClNameT name
Name of the service.
Definition: clNameApi.h:281
ClUint32T attrCount
Number of attributes associated with the entry.
Definition: clNameApi.h:296
ClNameSvcPriorityT priority
Priority of the Component for the given service.
Definition: clNameApi.h:291
ClUint32T compId
Id of the Component.
Definition: clNameApi.h:286
List of components.
Definition: clNameApi.h:311
ClNameSvcPriorityT priority
Priority of the Component for the service being provided.
Definition: clNameApi.h:336
ClIocNodeAddressT nodeAddress
IOC address of the client.
Definition: clNameApi.h:326
struct ClNameSvcCompList * pNext
Pointer to the next element.
Definition: clNameApi.h:341
ClEoIdT eoID
EoID of the component.
Definition: clNameApi.h:321
ClIocPortT clientIocPort
Client IOC port.
Definition: clNameApi.h:331
ClUint32T compId
Id of the Component.
Definition: clNameApi.h:316
Name Service Entry.
Definition: clNameApi.h:351
ClNameT name
Name of the component.
Definition: clNameApi.h:357
ClUint32T refCount
Count of components providing the service.
Definition: clNameApi.h:367
ClUint64T objReference
Object Reference.
Definition: clNameApi.h:362
ClNameSvcCompListT compId
List of components providing the service.
Definition: clNameApi.h:372
ClUint32T attrCount
Number of attributes associated with the entry.
Definition: clNameApi.h:377