FileDocCategorySizeDatePackage
Lock.javaAPI DocApache Tomcat 6.0.145215Fri Jul 20 04:20:32 BST 2007org.apache.tomcat.jni

Lock

public class Lock extends Object
Lock
author
Mladen Turk
version
$Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $

Fields Summary
public static final int
APR_LOCK_FCNTL
Enumerated potential types for APR process locking methods
Warning : Check APR_HAS_foo_SERIALIZE defines to see if the platform supports APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.
public static final int
APR_LOCK_FLOCK
fcntl()
public static final int
APR_LOCK_SYSVSEM
flock()
public static final int
APR_LOCK_PROC_PTHREAD
System V Semaphores
public static final int
APR_LOCK_POSIXSEM
POSIX pthread process-based locking
public static final int
APR_LOCK_DEFAULT
POSIX semaphore process-based locking
Constructors Summary
Methods Summary
public static native longchildInit(java.lang.String fname, long pool)
Re-open a mutex in a child process. This function must be called to maintain portability, even if the underlying lock mechanism does not require it.

param
fname A file name to use if the mutex mechanism requires one. This argument should always be provided. The mutex code itself will determine if it should be used. This filename should be the same one that was passed to apr_proc_mutex_create().
param
pool The pool to operate on.
return
Newly opened mutex.

public static native longcreate(java.lang.String fname, int mech, long pool)
Create and initialize a mutex that can be used to synchronize processes.
Warning : Check APR_HAS_foo_SERIALIZE defines to see if the platform supports APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.

param
fname A file name to use if the lock mechanism requires one. This argument should always be provided. The lock code itself will determine if it should be used.
param
mech The mechanism to use for the interprocess lock, if any; one of
APR_LOCK_FCNTL
APR_LOCK_FLOCK
APR_LOCK_SYSVSEM
APR_LOCK_POSIXSEM
APR_LOCK_PROC_PTHREAD
APR_LOCK_DEFAULT pick the default mechanism for the platform
param
pool the pool from which to allocate the mutex.
return
Newly created mutex.

public static native java.lang.Stringdefname()
Display the name of the default mutex: APR_LOCK_DEFAULT

public static native intdestroy(long mutex)
Destroy the mutex and free the memory associated with the lock.

param
mutex the mutex to destroy.

public static native intlock(long mutex)
Acquire the lock for the given mutex. If the mutex is already locked, the current thread will be put to sleep until the lock becomes available.

param
mutex the mutex on which to acquire the lock.

public static native java.lang.Stringlockfile(long mutex)
Return the name of the lockfile for the mutex, or NULL if the mutex doesn't use a lock file

public static native java.lang.Stringname(long mutex)
Display the name of the mutex, as it relates to the actual method used. This matches the valid options for Apache's AcceptMutex directive

param
mutex the name of the mutex

public static native inttrylock(long mutex)
Attempt to acquire the lock for the given mutex. If the mutex has already been acquired, the call returns immediately with APR_EBUSY. Note: it is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine if the return value was APR_EBUSY, for portability reasons.

param
mutex the mutex on which to attempt the lock acquiring.

public static native intunlock(long mutex)
Release the lock for the given mutex.

param
mutex the mutex from which to release the lock.