NAME

JAM_LockMB - Lock message base for exclusive access

SYNOPSIS

#include <jamlib/jam.h>
int JAM_LockMB(s_JamBase* Base_PS);

DESCRIPTION

Locks the currently open message base so that no other programs may modify it. The message base should be locked for only small periods of time, or the performance of tossers and other software may be affected.

Arguments

Base_PS: The message base to lock

RETURN VALUE

0: if successful
JAM_IO_ERROR: if an I/O error occured. see JAM_Errno(3)
JAM_LOCK_FAILED: if the message base is currently locked by another process
JAM_BAD_PARAM: if Base_PS is NULL

EXAMPLES

int        Result_I;
while (1) {
    Result_I = JAM_LockMB(Base_PS);
    if (Result_I) {
       if (Result_I == JAM_LOCK_FAILED)
           /* base locked by someone else, wait for unlock */
           sleep(1);
       else {
           /* error */
           printf("JAM_LockMB returned %d.\n", Result_I);
           return -1;
       }
    }
}

AUTHOR

This manual page was created by Sir Raorn <raorn@altlinux.ru>, based on original JAMlib documentation by Bjorn Stenberg <bjorn@haxx.nu> and Johan Billing <billing@df.lth.se>.