clCorNotifyApi.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  : cor                                                           
 * File        : clCorNotifyApi.h
 *******************************************************************************/

/*****************************************************************************
 * Description :                                                                
 *
 * The files contains APIs for subscribing/unsubscribing to the events
 * on a Managed Objects. and associated datastrucutes.
 *
 *
 *****************************************************************************/

/****************************************************************************************/
/******************************** COR APIs **********************************************/
/****************************************************************************************/
/*                                                                                      */
/* clCorEventSubscribe                                                          */
/* clCorEventUnsubscribe                                                   */
/* clCorNotifyEventToOperationGet < -- OBSOLETE -- >                       */
/* clCorNotifyEventToMoIdGet      < -- OBSOLETE -- >                       */
/* clCorNotifyEventToAttrPathGet  < -- OBSOLTE -- >                         */
/* clCorNotifyEventToTransactionHandleGet <CHGD TO> clCorEventToCorTxnIdGet */
/*                                                                                       */
/*****************************************************************************************/

#ifndef _CL_COR_NOTIFY_API_H_
#define _CL_COR_NOTIFY_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>
#include <clEoApi.h>
#include <clEoConfigApi.h>
#include <clEventApi.h>
#include "clCorMetaData.h"
#include "clCorServiceId.h"
#include <clCorTxnApi.h>

/******************************************************************************
 *  Constant and Macro Definitions
 *****************************************************************************/

/******************************************************************************
 *  Data Types 
 *****************************************************************************/

typedef struct ClCorAttrList {
  ClUint32T attrCnt;

  ClInt32T attr[1];
} ClCorAttrListT;

typedef ClCorAttrListT * ClCorAttrListPtrT;

typedef struct ClCorMOIdList
{
    ClUint32T moIdCnt;

    ClCorMOIdT moId[1];

}ClCorMOIdListT;

typedef ClCorMOIdListT* ClCorMOIdListPtrT;

typedef ClHandleT  ClCorNotifyHandleT;


#define clCorEventName "COR_EVT_CHANNEL"
#define CL_COR_EVT_CHANGE_NOTIFICATION 0x1

/* This is an IPI which is only used by alarm client to susbscribe for multiple moIds. */
extern ClRcT
clCorMOListEventSubscribe(ClEventChannelHandleT     channelHandle,
                                ClCorMOIdListPtrT   pMoIdList,
                                ClCorAttrPathPtrT   pAttrPath,
                                ClCorAttrListPtrT   pAttrList,
                                ClCorOpsT           ops,
                                void*               cookie,
                                ClEventSubscriptionIdT subscriptionID);

extern ClRcT clCorEventSubscribe(ClEventChannelHandleT channelHandle,
                                ClCorMOIdPtrT      changedObj,
                                ClCorAttrPathPtrT  pAttrPath,
                                ClCorAttrListPtrT attrList,
                                ClCorOpsT    flags,
                                void * cookie,
                                ClEventSubscriptionIdT subscriptionId);
extern ClRcT clCorEventUnsubscribe(ClEventChannelHandleT channelHandle, ClEventSubscriptionIdT subscriptionId);

extern ClRcT
clCorEventHandleToCorTxnIdGet(ClEventHandleT evtH, ClSizeT size,  ClCorTxnIdT *corTxnId);

#ifdef __cplusplus
}
#endif

#endif  /*  _CL_COR_NOTIFY_API_H_ */