clEventExtApi.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  : event
 * File        : clEventExtApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 *
 *****************************************************************************/

#ifndef _CL_EVENT_EXT_API_H_
# define _CL_EVENT_EXT_API_H_


# ifdef __cplusplus
extern "C"
{
# endif

# include "clCommon.h"
# include "clCommonErrors.h"
# include "clOsalApi.h"
# include "clCntApi.h"
# include "clCommon.h"
# include "clEventErrors.h"
# include "clEventApi.h"

# define CL_EVENT_NON_ZERO_MATCH CL_EVENT_PASS_ALL_FILTER+1

/*******************************************************************************
NOTE:-
    The following table depicts the mapping between the normal and wrapper API. 
    The wrapper API is obtained by inserting 'Ext' in the corresponding API. 

    clEventSubscribe        - clEventExtSubscribe
    clEvtEventAttributeSet  - clEvtEventExtAttributeSet
    clEvtEventAttributeGet  - clEvtEventExtAttributeGet
*******************************************************************************/

    ClRcT clEventExtSubscribe(CL_IN ClEventChannelHandleT channelHandle,
                              CL_IN ClUint32T eventType,
                              CL_IN ClEventSubscriptionIdT subscriptionId,
                              CL_IN void *pCookie);





    ClRcT clEventExtWithRbeSubscribe(CL_IN const ClEventChannelHandleT
                                     channelHandle, CL_IN ClRuleExprT *pRbeExpr,
                                     CL_IN ClEventSubscriptionIdT
                                     subscriptionID, CL_IN void *pCookie);





    ClRcT clEventExtAttributesSet(CL_IN ClEventHandleT eventHandle,
                                  CL_IN ClUint32T eventType,
                                  CL_IN ClEventPriorityT priority,
                                  CL_IN ClTimeT retentionTime,
                                  CL_IN const ClNameT *pPublisherName);



    ClRcT clEventExtAttributesGet(CL_IN ClEventHandleT eventHandle,
                                  CL_OUT ClUint32T *pEventType,
                                  CL_OUT ClEventPriorityT * pPriority,
                                  CL_OUT ClTimeT *pRetentionTime,
                                  CL_OUT ClNameT *pPublisherName,
                                  CL_OUT ClTimeT *pPublishTime,
                                  CL_OUT ClEventIdT * pEventId);


# ifdef __cplusplus
}
# endif


#endif                          /* _CL_EVENT_EXT_API_H_ */