OpenClovis Logo

Classes | Macros | Typedefs | Enumerations | Functions

Typical defines found in any software project. More...

#include <clArchHeaders.h>

Go to the source code of this file.

Classes

struct  ClNameT
 A name. More...
 
struct  ClVersionT
 Version Information for various services. More...
 

Macros

#define CL_DISABLE   0
 define Disable
 
#define CL_ENABLE   1
 define Enable
 
#define CL_FALSE   0
 define the False
 
#define CL_IN
 CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
 
#define CL_INOUT
 CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
 
#define CL_MAX(a, b)   ( (a) > (b) ? (a) : (b) )
 Maximum macro.
 
#define CL_MAX_NAME_LENGTH   256
 The Maximum length of most string names in the OpenClovis ASP framework.
 
#define CL_MICRO_TO_NANO   1000ULL
 nanoseconds in a microsecond
 
#define CL_MILLI_TO_MICRO   1000ULL
 microseconds in a millisecond
 
#define CL_MILLI_TO_NANO   (CL_MICRO_TO_NANO * CL_MILLI_TO_MICRO)
 nanoseconds in a millisecond
 
#define CL_MIN(a, b)   ( (a) < (b) ? (a) : (b) )
 Mininum macro.
 
#define CL_NO   0
 define No
 
#define CL_OUT
 CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
 
#define CL_ROUNDDOWN(VAL, BASE)   ((VAL)/(BASE) * (BASE))
 Rounddown macro assumes integers - char, short, int and long as argument.
 
#define CL_ROUNDUP(VAL, BASE)   (((VAL) + (BASE) - 1)/(BASE) * (BASE))
 Roundup macro assumes integers - char, short, int and long as argument.
 
#define CL_SEC_TO_MILLI   1000ULL
 milliseconds in a second
 
#define CL_SEC_TO_NANO   (CL_MILLI_TO_NANO * CL_SEC_TO_MILLI)
 nanoseconds in a second
 
#define CL_SIZEOF_ARRAY(__ArrayName__)   sizeof((__ArrayName__)) / sizeof((__ArrayName__)[0])
 The following macros returns the number of items in the given array.
 
#define CL_TIME_END   0x7fffffffffffffffULL
 In practice, this will never time out, since it is 292 years.
 
#define CL_TIME_FOREVER   0x7fffffffffffffffULL
 In practice, this will never time out, since it is 292 years.
 
#define CL_TRUE   1
 define the Truth
 
#define CL_YES   1
 define Yes
 
#define clNamePrintf(name, ...)
 Load the ClNameT structure. More...
 

Typedefs

typedef ClRcT(* ClCallbackT) (CL_IN ClPtrT invocation)
 Definition of a generic single argument callback function. More...
 
typedef ClPtrT * ClEoActionArgListT
 The argument list that can be provided to the custom action taken on water mark hit.
 
typedef ClInt64T ClOffsetT
 Offset of a buffer or object within another

 
typedef ClUint32T ClRcT
 Clovis return code type. More...
 
typedef ClUint64T ClSizeT
 
typedef ClInt64T ClTimeT
 Time duration specified in nanoseconds.
 

Enumerations

enum  ClCompIdT {
  CL_CID_UNSPECIFIED = 0x0 ,
  CL_CID_OSAL = 0x01 ,
  CL_CID_HAL = 0x02 ,
  CL_CID_DBAL = 0x03 ,
  CL_CID_EO = 0x04 ,
  CL_CID_IOC = 0x05 ,
  CL_CID_RMD = 0x06 ,
  CL_CID_NAMES = 0x07 ,
  CL_CID_TIMER = 0x08 ,
  CL_CID_SHM = 0x09 ,
  CL_CID_DSHM = 0x0a ,
  CL_CID_LOG = 0x0b ,
  CL_CID_MSG = 0x0c ,
  CL_CID_DIAG = 0x0d ,
  CL_CID_DEBUG = 0x0e ,
  CL_CID_CPM = 0x0f ,
  CL_CID_CAP = 0x10 ,
  CL_CID_RES = 0x11 ,
  CL_CID_GMS = 0x12 ,
  CL_CID_EVENTS = 0x13 ,
  CL_CID_DLOCK = 0x14 ,
  CL_CID_TXN = 0x15 ,
  CL_CID_CKPT = 0x16 ,
  CL_CID_COR = 0x17 ,
  CL_CID_CNT = 0x18 ,
  CL_CID_DCNT = 0x19 ,
  CL_CID_RCNT = 0x1a ,
  CL_CID_ALARMS = 0x1b ,
  CL_CID_POLICY = 0x1c ,
  CL_CID_RULE = 0x1d ,
  CL_CID_SCRIPTING = 0x1e ,
  CL_CID_CM = 0x1f ,
  CL_CID_HPI = 0x20 ,
  CL_CID_FAULTS = 0x21 ,
  CL_CID_AMS = 0x22 ,
  CL_CID_MED = 0x23 ,
  CL_CID_BUFFER = 0x24 ,
  CL_CID_QUEUE = 0x25 ,
  CL_CID_CLIST = 0x26 ,
  CL_CID_SNMP = 0x27 ,
  CL_CID_NS = 0x28 ,
  CL_CID_OM = 0x29 ,
  CL_CID_POOL = 0x2a ,
  CL_CID_CD = 0x2b ,
  CL_CID_DM = 0x2c ,
  CL_CID_OAMP_RT = 0x2d ,
  CL_CID_PROV = 0x2e ,
  CL_CID_UM = 0x2f ,
  CL_CID_HANDLE = 0x30 ,
  CL_CID_VERSION = 0x31 ,
  CL_CID_XDR = 0x32 ,
  CL_CID_IDL = 0x33 ,
  CL_CID_HEAP = 0x34 ,
  CL_CID_MEM = 0x35 ,
  CL_CID_PARSER = 0x36 ,
  CL_CID_BACKING_STORAGE = 0x37 ,
  CL_CID_JOB = 0x38 ,
  CL_CID_JOBQUEUE = 0x38 ,
  CL_CID_THREADPOOL = 0x39 ,
  CL_CID_TASKPOOL = 0x39 ,
  CL_CID_BITMAP = 0x3a ,
  CL_CID_LEAKY_BUCKET = 0x3b ,
  CL_CID_MSO = 0x3c ,
  CL_CID_PM = 0x3d ,
  CL_CID_NF = 0x3e ,
  CL_CID_MAX
}
 Clovis Component Ids. More...
 
enum  ClDispatchFlagsT
 Dispatch flags.
 
enum  ClStatusT {
  CL_STATUS_DOWN = 0 ,
  CL_STATUS_UP = 1
}
 These define all the possible states that a component/node can be in. More...
 

Functions

void clNameConcat (ClNameT *nameOut, const ClNameT *prefix, const char *separator, const ClNameT *suffix)
 Join ClNameT structures. More...
 
void clNameCopy (ClNameT *nameOut, const ClNameT *nameIn)
 Load the ClNameT structure. More...
 
void clNameSet (ClNameT *name, const char *str)
 Load the ClNameT structure. More...
 
ClCharT * clStrdup (const ClCharT *str)
 Duplicate a string. More...
 

Detailed Description

Typical defines found in any software project.


Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen