clNameApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : name
 * File        : clNameApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * This file contains Name Service Client Library related
 * datastructures and APIs.
 *
 *
 *****************************************************************************/

#ifndef _CL_NAME_API_H_
#define _CL_NAME_API_H_

#include "clBufferApi.h"
#include <clEoApi.h>
#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/******************************** Defines/constants **************************/
/*****************************************************************************/

#define CL_NS_MAX_NO_ATTR          5


#define CL_NS_MAX_STR_LENGTH       20

#define CL_NS_DEFT_GLOBAL_CONTEXT     0xFFFFFFF


#define CL_NS_DEFT_LOCAL_CONTEXT      0xFFFFFFE

#define CL_NS_DEFT_GLOBAL_MAP_COOKIE  0xFFFFFFF

#define CL_NS_DEFT_LOCAL_MAP_COOKIE   0xFFFFFFE

#define CL_NS_DEFT_ATTR_LIST          0x0

#define CL_NS_GET_OBJ_REF             0xFFFFFFF

#define CL_NAME_PUB_CHANNEL  "NAME_SVC_PUB_CHANNEL"


#define CL_NAME_EVENT_TYPE   0x100

# define CL_NAME_VERSION {'B', 0x1, 0x1}
# define CL_NAME_VERSION_SET(version) (version).releaseCode = 'B', \
                                      (version).majorVersion = 0x1,\
                                      (version).minorVersion = 0x1

/********************* Name Service related data structures **********************/
/*********************************************************************************/

typedef enum
{

  CL_NS_USER_NODELOCAL,

    CL_NS_USER_GLOBAL,
}ClNameSvcContextT;


typedef enum
{
    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

}ClNameSvcOpT;


typedef enum
{
    CL_NS_PRIORITY_LOW,

    CL_NS_PRIORITY_MEDIUM,

    CL_NS_PRIORITY_HIGH,

}ClNameSvcPriorityT;


typedef struct
{

 ClNameT       name;

    ClUint64T    objReference;

    ClNameSvcOpT  operation;

    ClUint32T     contextMapCookie;
}ClNameSvcEventInfoT;


typedef struct
{

ClUint8T        type[CL_NS_MAX_STR_LENGTH];

ClUint8T        value[CL_NS_MAX_STR_LENGTH];
}ClNameSvcAttrEntryT;

typedef ClNameSvcAttrEntryT* ClNameSvcAttrEntryPtrT;


typedef struct
{

    ClNameSvcAttrEntryT  attrList[CL_NS_MAX_NO_ATTR];

    ClUint32T          attrCount;

    ClUint32T          opCode[CL_NS_MAX_NO_ATTR-1];
}ClNameSvcAttrSearchT;

typedef ClNameSvcAttrSearchT * ClNameSvcAttrSearchPtrT ;


typedef struct
{

    ClNameT           name;

    ClUint32T         compId;

    ClNameSvcPriorityT priority;

    ClUint32T         attrCount;

    ClNameSvcAttrEntryT attr[1];
}ClNameSvcRegisterT;

typedef ClNameSvcRegisterT* ClNameSvcRegisterPtrT;


typedef struct ClNameSvcCompList
{
   ClUint32T                  dsId;
  ClUint32T                   compId;

  ClEoIdT                    eoID;
  
  ClIocNodeAddressT         nodeAddress;
   
  ClIocPortT                clientIocPort;
  
  ClNameSvcPriorityT          priority;

    struct ClNameSvcCompList*   pNext;
}ClNameSvcCompListT;

typedef ClNameSvcCompListT* ClNameSvcCompListPtrT;


typedef struct
{


    ClNameT             name;

    ClUint64T          objReference;

    ClUint32T           refCount;

    ClNameSvcCompListT  compId;

    ClUint32T         attrCount;

    ClNameSvcAttrEntryT attr[1];
}ClNameSvcEntryT;

typedef ClNameSvcEntryT* ClNameSvcEntryPtrT;

/*********************************************************************************/
/**************************    Client side APIs  *********************************/
/*********************************************************************************/

/*********************************************************************************/
/************************** API to Core Module ***********************************/

ClRcT clNameLibInitialize();


ClRcT clNameLibFinalize(void);


ClRcT clNameRegister(CL_IN ClUint32T contextId,
                     CL_IN ClNameSvcRegisterT* pNSRegisInfo,
                     CL_INOUT ClUint64T *pObjReference);



ClRcT clNameComponentDeregister(CL_IN ClUint32T compId);



ClRcT clNameServiceDeregister(CL_IN ClUint32T contextId,
                              CL_IN ClUint32T compId,
                              CL_IN ClNameT* serviceName);


ClRcT clNameContextCreate(CL_IN  ClNameSvcContextT contextType,
                          CL_IN  ClUint32T contextMapCookie,
                          CL_OUT ClUint32T *contextId);


ClRcT clNameContextDelete(CL_IN ClUint32T contextId);

/**********************************************************************************/
/************************** API to Query Module ***********************************/


ClRcT clNameToObjectReferenceGet(CL_IN  ClNameT* pName,
                                 CL_IN  ClUint32T attrCount,
                                 CL_IN  ClNameSvcAttrEntryT *pAttr,
                                 CL_IN  ClUint32T contextMapCookie,
                                 CL_OUT ClUint64T* pObjReference);


ClRcT clNameToObjectMappingGet(CL_IN  ClNameT* pName,
                               CL_IN  ClUint32T attrCount,
                               CL_IN  ClNameSvcAttrEntryT *pAttr,
                               CL_IN  ClUint32T contextMapCookie,
                               CL_OUT ClNameSvcEntryPtrT* pOutBuff);


ClRcT clNameObjectMappingCleanup(CL_IN ClNameSvcEntryPtrT pObjMapping);

ClRcT clNameLibVersionVerify(CL_INOUT ClVersionT *pVersion);
/**************************************************************************************/

#ifdef __cplusplus
}
#endif

#endif /* _CL_NAME_API_H_ */