saf-env.h

Go to the documentation of this file.

/****************************************************************************
 *
 * Copyright (C) 2006-2007 Micro Focus (IP) Limited.
 * All rights reserved.
 *
 * The software and information contained herein are proprietary to, and
 * comprise valuable trade secrets of, Micro Focus International Ltd., 
 * which intends to preserve as trade secrets such software and 
 * information. This software is an unpublished copyright of Micro Focus  
 * and may not be used, copied, transmitted, or stored in any manner.  
 * This software and information or any other copies thereof may not be
 * provided or otherwise made available to any other person.
 *
 *      Enterprise Server SAF (Security) Manager
 *      Processing Environment
 *
 *      @(#)saf-env.h   $Revision: 1.8 $     
 *
 *      $Date: 2009/04/07 14:56:53 $
 *
 ****************************************************************************/

/* Start of source module saf-env.h */
#if !defined(SafENV_H)
#define SafENV_H

#include <stdarg.h>

/* Declare structures defined elsewhere */
struct SafInit;
struct SafPTab;
struct SafACEE;
struct SafStore;


enum SafMsgLvl
{
   SafMsgINFO,       
   SafMsgWARN,       
   SafMsgERR,        
   SafMsgCRIT,       
   SafMsgInvalid
};


#define SafESM_LCK_CHG    0  
#define SafESM_LCK_HAVE   1  
#define SafESM_LCK_TEST   2  
#define SafESM_LCK_USE    3  
#define SafESM_LCK_NOWAIT 3  
#define SafESM_LCK_NONE   4  


#define SafESM_LCK_UOW    11 
#define SafESM_LCK_TASK   12 
#define SafESM_LCK_PROC   13 


#define SafESM_LCK_SHR   0   
#define SafESM_LCK_EXCL  1   


typedef enum
{
   SafLockOK      =  0,    
   SafLockOWN     =  1,    
   SafLockHELD    =  2,    
   SafLockNHELD   =  3,    
   SafLockNEXIST  =  4,    
   SafLockDENY    =  5,    
   SafLockERR     =  6,    
   SafLockPARAM   =  7,    
   SafLockInvalid
} SafLockRet;


/* Processing Environment Interface */
mf_uns32 SafEnvInit(struct SafInit *);


/* Processing Environment Functions */
SafRet SafShmOpen(const char *Name, size_t *Size, void **Area);
SafRet SafModLoad(const char *ModPath, struct SafPTab * (**Entry)(void));
SafRet SafModUnload(const char *ModPath);
SafRet SafGetInstPath(char *Path, size_t MaxLen);
SafRet SafLog(int Num, enum SafMsgLvl, const char *DefaultText, ...);
SafRet SafLogLit(int Num, enum SafMsgLvl Level, const char *Text);
SafRet SafAceeAlloc(const char *Name, const char *Group,
                    struct SafACEE **AceeP, int *IsNew);
SafRet SafAceeIterate(void *Data, int (*Callback)(struct SafACEE *Acee,
                                                  void *Data));

SafLockRet SafLockEnq(const char *QName, const char *RName, int Type,
                      int Exclusive, int Lifetime);
SafLockRet SafThrLock(const char *Name, int Exclusive);
SafLockRet SafShmLock(const char *Name, int Exclusive);
SafLockRet SafLockDeq(const char *QName, const char *RName);
SafLockRet SafThrUnlock(const char *Name);
SafLockRet SafShmUnlock(const char *Name);

int SafIsMT(void);
int SafIsSharedMemory(void);
int SafStrcmpCI(const char *, const char *);
int SafStrcmpCIN(const char *, const char *, size_t);
char *SafDupStr(const char *);

/* Associative Store Functions (saf-store.c) */
SafRet SafAllocStore(struct SafStore **StoreP);
SafRet SafFreeStore(struct SafStore *Store);
SafRet SafClearStore(struct SafStore *Store);
SafRet SafStoreRemove(struct SafStore *Store, const char *C, const char *N);
SafRet SafStoreIterate(struct SafStore *Store, const char *Class,
                       SafRet (*Visitor)(const char *Class, const char *Name,
                                         void *Value, void *Data),
                       void *Data, SafRet *VisitorErrP);
SafRet SafStoreAdd(struct SafStore *S, const char *C, const char *N, void *P);
SafRet SafStoreFind(struct SafStore *S, const char *C, const char *N, void **P);
SafRet SafStoreLoad(struct SafStore *Store, const char *Text);


/* Utility functions */
int SafVSnprintf(char *Buffer, size_t BufLen, const char *Format, va_list Args);
int SafSnprintf(char *Buffer, size_t BufLen, const char *Format, ...);


/* Internal Environment Functions */
SafRet SafGetEnvFunc(int (**FuncP)(), const char *Name, const char *Env);

#endif

/* End of saf-env.h */