locks.h

/* locks.h */
/* $Id: locks.h,v 1.10 2007/08/30 07:26:58 ibadm Exp $ */

/*********************************************************************
 *
 * UNIVERS
 * (C) ¾¾¾ "³µ¾²µÀÁ", 2001
 *
 * ²áÕ ßàÐÒÐ ×ÐéØéÕÝë *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾
 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __locks_h
#define __locks_h

#include <mix/Types.h>
#include <mix/wenv.h>
#include <mix/misc.h>


/***********************************************************************
 *
 *                      Simple exclusive lock API.
 *
 ***********************************************************************/


/** If some lock can't be made due to ERROR__SHARED_REFUSED, given
    numbers of attempts will be made. */
#define EXCL_LOCK_TRIES     5

/** Between attemps a delay take place (in seconds). */
#define EXCL_LOCK_DELAY     1

/** Between attemps a delay take place (in microseconds). */
#define EXCL_LOCK_DELAY_US  50000


/** Type for identifying the lock. */
typedef Int4    LockId;


/** Default value of project id for IPC (see ftok(3C)). Alternative
    project id lay in VSPIPCID env. variable + 1 */
#define PROCESS_LOCK_IPC_ID 168

/** Number used for building semaphore key using also
    PROCESS_LOCK_IPC_ID */
#define PROCESS_LOCK_SEM_KEY    1


/** Reasons for process lock due to inter-process and
    process-exclusive communications. */
typedef enum {
  plrHardKeyAccess = 0, /**< hard key access is exclusive */
  plrSessionManagement, /**< session management operations are exclusive */
  plrKeysourcerCell,    /**< access to cell with PEP IPC counter */

  __plrNumber       /**< number of reasons - not a reason truely */

}   ProcessLockReason;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** Test lock for existance.  Returns TRUE or FALSE. */
Logic   LockCheck (LockId lid);

/** Make exclusive lock of the file object.  In opposition to class
    FileLock this routine trys to lock an object several times with
    small delays. */
ErrCode LockResourceExclusive (LockId* plid, const char* path);

/** Make process lock for given reason. */
ErrCode LockProcess (LockId* plid, ProcessLockReason reason);

/** Register reliable at-exit handler. */
ErrCode LockAtExit (LockId* plid, weAtExitHandlerProc proc);

/** Delete given lock of resource. */
ErrCode UnlockResourceById (LockId lid);


/** Delete all locks, made by the program.  DANGER!!! Use with
    considerable care and only just before program end! */
void    UnlockAllResources ();


/*
 * Special lock supervisor operations.  They operate over other
 * application's locks and may cause unreliable simultaneous access
 * to the same file/db objects.
 */

/** Check for locked file object.  Do not care about very time
    dependence of lock state information.  Returns TRUE if lock is set
    and FALSE otherwise. */
Logic   CheckLockedResource (const char* path);

/** Get list of locks in given directory. */
ErrCode ListLockedResources (const char* dirpath, unsigned* n,
                 STRLIST* list);

/** Unlock file object.  DANGER! The function doesn't respect living
    lock.  Returns OK if lock was released and error code
    otherwise. */
ErrCode ReleaseLockedResource (const char* path);

/** Unlock all file objects in given directory.  DANGER!  The function
    doesn't respect living and sharable locks!.  Returns OK if all
    locks were released and error code otherwise.  n contains number
    of locks which can't be released.  Error code matches the last
    failed release. */
ErrCode ReleaseAllLockedResources (const char* dirpath, unsigned* failed);



#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* locks.h */

 *
 * ¸áßÞÛì×ÞÒÐÝØÕ, ÚÞßØàÞÒÐÝØÕ ØÛØ ßÕàÕÔÐçÐ àÕÓãÛØàãîâáï ×ÐÚÞÝÐÜØ
 * ÀÞááØÙáÚÞÙ ÄÕÔÕàÐæØØ "¾Ñ ÐÒâÞàáÚÞÜ ßàÐÒÕ Ø áÜÕÖÝëå ßàÐÒÐå", "¾ * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ×
 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __locks_h
#define __locks_h

#include <mix/Types.h>
#include <mix/wenv.h>
#include <mix/misc.h>


/***********************************************************************
 *
 *                      Simple exclusive lock API.
 *
 ***********************************************************************/


/** If some lock can't be made due to ERROR__SHARED_REFUSED, given
    numbers of attempts will be made. */
#define EXCL_LOCK_TRIES     5

/** Between attemps a delay take place (in seconds). */
#define EXCL_LOCK_DELAY     1

/** Between attemps a delay take place (in microseconds). */
#define EXCL_LOCK_DELAY_US  50000


/** Type for identifying the lock. */
typedef Int4    LockId;


/** Default value of project id for IPC (see ftok(3C)). Alternative
    project id lay in VSPIPCID env. variable + 1 */
#define PROCESS_LOCK_IPC_ID 168

/** Number used for building semaphore key using also
    PROCESS_LOCK_IPC_ID */
#define PROCESS_LOCK_SEM_KEY    1


/** Reasons for process lock due to inter-process and
    process-exclusive communications. */
typedef enum {
  plrHardKeyAccess = 0, /**< hard key access is exclusive */
  plrSessionManagement, /**< session management operations are exclusive */
  plrKeysourcerCell,    /**< access to cell with PEP IPC counter */

  __plrNumber       /**< number of reasons - not a reason truely */

}   ProcessLockReason;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** Test lock for existance.  Returns TRUE or FALSE. */
Logic   LockCheck (LockId lid);

/** Make exclusive lock of the file object.  In opposition to class
    FileLock this routine trys to lock an object several times with
    small delays. */
ErrCode LockResourceExclusive (LockId* plid, const char* path);

/** Make process lock for given reason. */
ErrCode LockProcess (LockId* plid, ProcessLockReason reason);

/** Register reliable at-exit handler. */
ErrCode LockAtExit (LockId* plid, weAtExitHandlerProc proc);

/** Delete given lock of resource. */
ErrCode UnlockResourceById (LockId lid);


/** Delete all locks, made by the program.  DANGER!!! Use with
    considerable care and only just before program end! */
void    UnlockAllResources ();


/*
 * Special lock supervisor operations.  They operate over other
 * application's locks and may cause unreliable simultaneous access
 * to the same file/db objects.
 */

/** Check for locked file object.  Do not care about very time
    dependence of lock state information.  Returns TRUE if lock is set
    and FALSE otherwise. */
Logic   CheckLockedResource (const char* path);

/** Get list of locks in given directory. */
ErrCode ListLockedResources (const char* dirpath, unsigned* n,
                 STRLIST* list);

/** Unlock file object.  DANGER! The function doesn't respect living
    lock.  Returns OK if lock was released and error code
    otherwise. */
ErrCode ReleaseLockedResource (const char* path);

/** Unlock all file objects in given directory.  DANGER!  The function
    doesn't respect living and sharable locks!.  Returns OK if all
    locks were released and error code otherwise.  n contains number
    of locks which can't be released.  Error code matches the last
    failed release. */
ErrCode ReleaseAllLockedResources (const char* dirpath, unsigned* failed);



#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* locks.h */

 * ßàÐÒÞÒÞÙ ÞåàÐÝÕ ßàÞÓàÐÜÜ ÔÛï íÛÕÚâàÞÝÝëå ÒëçØáÛØâÕÛìÝëå ÜÐèØÝ Ø ÑÐ× * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __locks_h
#define __locks_h

#include <mix/Types.h>
#include <mix/wenv.h>
#include <mix/misc.h>


/***********************************************************************
 *
 *                      Simple exclusive lock API.
 *
 ***********************************************************************/


/** If some lock can't be made due to ERROR__SHARED_REFUSED, given
    numbers of attempts will be made. */
#define EXCL_LOCK_TRIES     5

/** Between attemps a delay take place (in seconds). */
#define EXCL_LOCK_DELAY     1

/** Between attemps a delay take place (in microseconds). */
#define EXCL_LOCK_DELAY_US  50000


/** Type for identifying the lock. */
typedef Int4    LockId;


/** Default value of project id for IPC (see ftok(3C)). Alternative
    project id lay in VSPIPCID env. variable + 1 */
#define PROCESS_LOCK_IPC_ID 168

/** Number used for building semaphore key using also
    PROCESS_LOCK_IPC_ID */
#define PROCESS_LOCK_SEM_KEY    1


/** Reasons for process lock due to inter-process and
    process-exclusive communications. */
typedef enum {
  plrHardKeyAccess = 0, /**< hard key access is exclusive */
  plrSessionManagement, /**< session management operations are exclusive */
  plrKeysourcerCell,    /**< access to cell with PEP IPC counter */

  __plrNumber       /**< number of reasons - not a reason truely */

}   ProcessLockReason;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/** Test lock for existance.  Returns TRUE or FALSE. */
Logic   LockCheck (LockId lid);

/** Make exclusive lock of the file object.  In opposition to class
    FileLock this routine trys to lock an object several times with
    small delays. */
ErrCode LockResourceExclusive (LockId* plid, const char* path);

/** Make process lock for given reason. */
ErrCode LockProcess (LockId* plid, ProcessLockReason reason);

/** Register reliable at-exit handler. */
ErrCode LockAtExit (LockId* plid, weAtExitHandlerProc proc);

/** Delete given lock of resource. */
ErrCode UnlockResourceById (LockId lid);


/** Delete all locks, made by the program.  DANGER!!! Use with
    considerable care and only just before program end! */
void    UnlockAllResources ();


/*
 * Special lock supervisor operations.  They operate over other
 * application's locks and may cause unreliable simultaneous access
 * to the same file/db objects.
 */

/** Check for locked file object.  Do not care about very time
    dependence of lock state information.  Returns TRUE if lock is set
    and FALSE otherwise. */
Logic   CheckLockedResource (const char* path);

/** Get list of locks in given directory. */
ErrCode ListLockedResources (const char* dirpath, unsigned* n,
                 STRLIST* list);

/** Unlock file object.  DANGER! The function doesn't respect living
    lock.  Returns OK if lock was released and error code
    otherwise. */
ErrCode ReleaseLockedResource (const char* path);

/** Unlock all file objects in given directory.  DANGER!  The function
    doesn't respect living and sharable locks!.  Returns OK if all
    locks were released and error code otherwise.  n contains number
    of locks which can't be released.  Error code matches the last
    failed release. */
ErrCode ReleaseAllLockedResources (const char* dirpath, unsigned* failed);



#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* locks.h */

 * ÔÐÝÝëå"
 *
 * Encoding: ISO-8859-5 (GOST)
 *
 *********************************************************************/

#ifndef __locks_h
#define __locks_h

#include <mix/Types.h>
#include <mix/wenv.h>
#include <mix/misc.h>


/***********************************************************************
 *
 *                      Simple exclusive lock API.
 *
 ***********************************************************************/


#define EXCL_LOCK_TRIES     5

#define EXCL_LOCK_DELAY     1

#define EXCL_LOCK_DELAY_US  50000


typedef Int4    LockId;


#define PROCESS_LOCK_IPC_ID 168

#define PROCESS_LOCK_SEM_KEY    1


typedef enum {
  plrHardKeyAccess = 0, 
  plrSessionManagement, 
  plrKeysourcerCell,    
  __plrNumber       
}   ProcessLockReason;


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

Logic   LockCheck (LockId lid);

ErrCode LockResourceExclusive (LockId* plid, const char* path);

ErrCode LockProcess (LockId* plid, ProcessLockReason reason);

ErrCode LockAtExit (LockId* plid, weAtExitHandlerProc proc);

ErrCode UnlockResourceById (LockId lid);


void    UnlockAllResources ();


/*
 * Special lock supervisor operations.  They operate over other
 * application's locks and may cause unreliable simultaneous access
 * to the same file/db objects.
 */

Logic   CheckLockedResource (const char* path);

ErrCode ListLockedResources (const char* dirpath, unsigned* n,
                 STRLIST* list);

ErrCode ReleaseLockedResource (const char* path);

ErrCode ReleaseAllLockedResources (const char* dirpath, unsigned* failed);



#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* locks.h */