clEoConfigApi.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  : eo
 * File        : clEoConfigApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 * This header contains Execution Object [EO] config definitions.
 *
 *
 *****************************************************************************/

#ifndef _CL_EO_CONFIG_API_H_
#define _CL_EO_CONFIG_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>


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

typedef ClUint64T               ClEoIdT;

#define CL_EO_MAX_NAME_LEN      32

#define CL_EO_DEFAULT_THREADS   1

#define CL_EO_NAME clEoNameGet()

#define CL_EO_DEFAULT_NAME "3RD_PARTY_COMP"



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

typedef enum {

    CL_EO_STATE_INIT        = 0x1,

    CL_EO_STATE_ACTIVE      = 0x2,

    CL_EO_STATE_STDBY       = 0x4,

    CL_EO_STATE_SUSPEND     = 0x8,

    CL_EO_STATE_STOP        = 0x10,

    CL_EO_STATE_KILL        = 0x20,

    CL_EO_STATE_RESUME      = 0x40,

    CL_EO_STATE_FAILED      = 0x80,

    CL_EO_STATE_THREAD_SAFE = 0x100,

    CL_EO_STATE_BITS        = 9,


} ClEoStateT;

typedef enum {

    CL_EO_USE_THREAD_FOR_RECV   = CL_TRUE,

    CL_EO_USE_THREAD_FOR_APP    = CL_FALSE

}ClEoApplicationTypeT;

typedef enum {

    CL_EO_DONT_POLL    = 0,

    CL_EO_BUSY_POLL    = 1,

    CL_EO_DEFAULT_POLL = 2

} ClEoPollingTypeT;

typedef struct {

    ClEoPollingTypeT   freq;

    ClRcT              status;

}ClEoSchedFeedBackT;

typedef ClRcT  (* ClEoAppCreateCallbackT)(

        CL_IN ClUint32T argc,

        CL_IN char *argv[]);



typedef ClRcT (* ClEoAppStateChgCallbackT)(

    CL_IN ClEoStateT state);

typedef ClRcT   (* ClEoAppDeleteCallbackT)();

typedef ClRcT   (* ClEoAppHealthCheckCallbackT)(

        CL_OUT ClEoSchedFeedBackT  *schFeedback);

typedef ClRcT (*ClEoCustomActionT)(ClCompIdT compId, ClWaterMarkIdT wmId, 
        ClWaterMarkT *pWaterMark, ClEoWaterMarkFlagT wmType, ClEoActionArgListT argList);

typedef struct {

    ClCharT                EOname[CL_EO_MAX_NAME_LEN];

    ClOsalThreadPriorityT   pri;

    ClUint32T               noOfThreads;

    ClIocPortT              reqIocPort;

    ClUint32T               maxNoClients;

    ClEoApplicationTypeT    appType;

    ClEoAppCreateCallbackT  clEoCreateCallout;

    ClEoAppDeleteCallbackT  clEoDeleteCallout;

    ClEoAppStateChgCallbackT    clEoStateChgCallout;

    ClEoAppHealthCheckCallbackT clEoHealthCheckCallout;

    ClEoCustomActionT clEoCustomAction;

    ClBoolT needSerialization;

}ClEoConfigT;

ClRcT clEoProgNameGet(ClCharT *pName,ClUint32T maxSize);

ClCharT* clEoNameGet(void);

/***********************************************************************/
/*                      external symbols we expect here                */
/***********************************************************************/

/*
 * This is the configuration for an EO. Since we can only do one EO
 * per process in RC1, this can be here. But when support for multiple
 * EOs per process shows up, this has to be fixed in some way.
 */

extern ClEoConfigT clEoConfig;

extern ClCharT *clEoProgName;

#ifdef __cplusplus
}

#endif

#endif /* _CL_EO_CONFIG_API_H_ */