FSEG.h

Go to the documentation of this file.

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

#define FSEG_FUNC_OPN   1U
#define FSEG_FUNC_CLS   2U
#define FSEG_FUNC_PUT   3U
#define FSEG_FUNC_GET   4U
#define FSEG_FUNC_DEL   5U
#define FSEG_FUNC_EXS   6U
#define FSEG_FUNC_GMN   7U
#define FSEG_FUNC_SMN   8U
#define FSEG_FUNC_VLS   9U
#define FSEG_FUNC_DVS  10U
#define FSEG_FUNC_DAR  11U
#define FSEG_FUNC_PRN  12U
#define FSEG_FUNC_CBF  13U
#define FSEG_FUNC_FLB  14U
#define FSEG_FUNC_NEW  16U
#define FSEG_FUNC_FRE  17U

#define FSEG_DEFLIB_NAME  "libfsse"
#define FSEG_DEFFUC_NAME  "FSEGUSR"

#define FSEG_VERSION        0x0200U
#define FSEG_VER_MAJOR(v)   ((v) >> 8)
#define FSEG_VER_MINOR(v)   ((v) & 0xFFU)

#define FSEG_FLAG_WRITE     0x00000001U
#define FSEG_FLAG_OVERWRITE 0x00000002U
#define FSEG_FLAG_LOG       0x00000004U
#define FSEG_FLAG_DEBUG     0x00000008U
#define FSEG_FLAG_TRACE     0x00000010U
/* 0x00000020U is reserved for future use; do not define. */
#define FSEG_FLAG_ACCESS    0x00000040U
#define FSEG_FLAG_STRONG    0x00000080U
#define FSEG_FLAG_VERSIONED 0x00000100U

#define FSEG_SEGTYP_DAT   1U
#define FSEG_SEGTYP_MBR   2U
#define FSEG_SEGTYP_DIR   3U

#define FSEG_IDX_INI    (-1LL)
#define FSEG_IDX_EMPTY  (-2LL)
 
/**********************************************************************/


typedef struct FsegOpn {
   unsigned int        uiFlg;
   unsigned int        uiPad0;
   long long           siVerId;
   unsigned int        uiNamLen;
   unsigned int        uiParLen;
   const char*         pcNamStr;
   const char*         pcParStr;
   const char**        ppcName;
   long long           siOpenedVerId;
} TsFsegOpn;

typedef struct FsegCls {
   unsigned int        isCommit;
   unsigned int        uiPad0;
   unsigned long long  uiTotalBytesWritten;
   unsigned long long  uiSegmentBytesWritten;
} TsFsegCls;

typedef struct FsegPut {
   long long           siSegInd;
   unsigned int        uiSegTyp;
   unsigned int        uiSegLen;
   const unsigned char* pcSegDat;
} TsFsegPut;

typedef struct FsegGet {
   long long           siSegInd;
   unsigned int        uiSegLen;
   unsigned int        uiRes0;
   const unsigned char** ppSegDat;
} TsFsegGet;

typedef struct FsegDel {
   long long           siSegInd;
   unsigned int        uiDelLen;
   unsigned int        uiRes0;
} TsFsegDel;

typedef struct FsegExs {
   long long           siSegInd;
   unsigned int        isExists;
   unsigned int        uiRes0;
} TsFsegExs;

typedef struct FsegGmn {
   long long           siSegInd;
} TsFsegGmn;

typedef struct FsegSmn {
   long long           siSegInd;
} TsFsegSmn;

typedef struct FsegVsnEnt {
   long long           siVerId;
   unsigned long long  uiDate;
} TsFsegVsnEnt;

typedef struct FsegVls {
   unsigned int        uiVsnCnt;
   unsigned int        uiRes0;
   TsFsegVsnEnt*       psVsnEnt;
} TsFsegVls;

typedef struct FsegDvs {
   long long           siVerId;
   unsigned int        uiVerDel;
} TsFsegDvs;

typedef struct FsegDar {
   unsigned int        uiVerDel;
} TsFsegDar;

typedef struct FsegPrn {
   unsigned int        uiKeepCnt;
   unsigned int        uiVerDel;
} TsFsegPrn;

typedef struct FsegCbf {
   unsigned int        uiBufId;
   unsigned int        uiMaxSiz;
} TsFsegCbf;

typedef struct FsegFlb {
   unsigned int        uiBufId;
   unsigned int        uiSegCnt;
} TsFsegFlb;

typedef struct FsegNew {
   unsigned int    uiNamLen;
   unsigned int    uiParLen;
   const char*     pcNamStr;
   const char*     pcParStr;
} TsFsegNew;

typedef struct FsegFre {
   unsigned int    uiRes0;
} TsFsegFre;

typedef union FsegPar {
   TsFsegOpn   stOpn; 
   TsFsegCls   stCls; 
   TsFsegPut   stPut; 
   TsFsegGet   stGet; 
   TsFsegDel   stDel; 
   TsFsegExs   stExs; 
   TsFsegGmn   stGmn; 
   TsFsegSmn   stSmn; 
   TsFsegVls   stVls; 
   TsFsegDvs   stDvs; 
   TsFsegDar   stDar; 
   TsFsegPrn   stPrn; 
   TsFsegCbf   stCbf; 
   TsFsegFlb   stFlb; 
   TsFsegNew   stNew; 
   TsFsegFre   stFre; 
} TuFsegPar;

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


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

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

#ifdef __cplusplus
   }
#endif
#endif /* INC_FSEG_H */