FOBJ.h

Go to the documentation of this file.

#ifndef INC_FOBJ_H
#define INC_FOBJ_H
#ifdef __cplusplus
   extern "C" {
#endif
 
/**********************************************************************/
 
#include "FLMRTC.h"
 
/**********************************************************************/

#define FOBJ_FUNC_OPN   1U
#define FOBJ_FUNC_CLS   2U
#define FOBJ_FUNC_GET   3U
#define FOBJ_FUNC_PUT   4U
#define FOBJ_FUNC_DEL   5U
#define FOBJ_FUNC_CHK   6U
#define FOBJ_FUNC_DST   7U
#define FOBJ_FUNC_EXS   8U
#define FOBJ_FUNC_NEW   9U
#define FOBJ_FUNC_FRE  10U

#define FOBJ_RTC_OK   0
#define FOBJ_RTC_NFD  1

#define FOBJ_DEFLIB_NAME  "libfsse"
#define FOBJ_DEFFUC_NAME  "FOBJUSR"

#define FOBJ_VERSION        0x0201U
#define FOBJ_VER_MAJOR(v)   ((v) >> 8)
#define FOBJ_VER_MINOR(v)   ((v) & 0xFFU)

#define FOBJ_FLAG_WRITE     0x00000001U
#define FOBJ_FLAG_OVERWRITE 0x00000002U
#define FOBJ_FLAG_LOG       0x00000004U
#define FOBJ_FLAG_DEBUG     0x00000008U
#define FOBJ_FLAG_TRACE     0x00000010U
/* 0x00000020U is reserved for future use; do not define. */
#define FOBJ_FLAG_ACCESS    0x00000040U
#define FOBJ_FLAG_STRONG    0x00000080U
 
/**********************************************************************/


typedef struct FobjOpn {
   unsigned int        uiFlg;
   unsigned int        uiMaxObjLen;
   long long           siVerId;
   unsigned int        uiNamLen;
   unsigned int        uiParLen;
   const char*         pcNamStr;
   const char*         pcParStr;
   const char**        ppcName;
} TsFobjOpn;

typedef struct FobjCls {
   unsigned int        isCommit;
} TsFobjCls;

typedef struct FobjGet {
   unsigned int         uiKeyLen;
   unsigned int         uiDatLen;
   const char*          pcKeyStr;
   const unsigned char* ppDatPtr;
} TsFobjGet;

typedef struct FobjPut {
   unsigned int        uiKeyLen;
   unsigned int        uiDatLen;
   const char*         pcKeyStr;
   const unsigned char* pcDatPtr;
} TsFobjPut;

typedef struct FobjDel {
   unsigned int        uiKeyLen;
   unsigned int        uiRes0;
   const char*         pcKeyStr;
} TsFobjDel;

typedef struct FobjChk {
   unsigned int        uiKeyLen;
   unsigned int        uiMinLen;
   const char*         pcKeyStr;
   unsigned int        isExists;
   unsigned int        isTooShort;
} TsFobjChk;

typedef struct FobjDst {
   unsigned int        uiRes0;
} TsFobjDst;

typedef struct FobjExs {
   unsigned int        uiKeyLen;
   unsigned int        isExists;
   const char*         pcKeyStr;
} TsFobjExs;

typedef struct FobjNew {
   unsigned int        uiNamLen;
   unsigned int        uiParLen;
   const char*         pcNamStr;
   const char*         pcParStr;
   unsigned int        uiMaxObjLen;
} TsFobjNew;

typedef struct FobjFre {
   unsigned int        uiRes0;
} TsFobjFre;

typedef union FobjPar {
   TsFobjOpn   stOpn; 
   TsFobjCls   stCls; 
   TsFobjGet   stGet; 
   TsFobjPut   stPut; 
   TsFobjDel   stDel; 
   TsFobjChk   stChk; 
   TsFobjDst   stDst; 
   TsFobjExs   stExs; 
   TsFobjNew   stNew; 
   TsFobjFre   stFre; 
} TuFobjPar;

 
/**********************************************************************/


typedef void TfFobjExit(
   void*                     pvGbl,
   void**                    ppHdl,
   int*                      piRetco,
   const unsigned int*       piVersion,
   const unsigned int*       piFunc,
   TuFobjPar*                puPara,
   const unsigned int*       piMsgSiz,
   char*                     pcMsg);

 
/**********************************************************************/

#ifdef __cplusplus
   }
#endif
#endif /* INC_FOBJ_H */