Package org.apache.tomcat.jni
Class Lock
java.lang.Object
org.apache.tomcat.jni.Lock
Deprecated.
The scope of the APR/Native Library will be reduced in Tomcat
              10.1.x / Tomcat Native 2.x onwards to only include those
              components required to provide OpenSSL integration with the NIO
              and NIO2 connectors.
Lock
- Author:
- Mladen Turk
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intDeprecated.Use the default process lockstatic final intDeprecated.fcntl()static final intDeprecated.flock()static final intDeprecated.POSIX semaphore process-based lockingstatic final intDeprecated.POSIX pthread process-based lockingstatic final intDeprecated.System V Semaphores
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic longDeprecated.Re-open a mutex in a child process.static longDeprecated.Create and initialize a mutex that can be used to synchronize processes.static Stringdefname()Deprecated.Display the name of the default mutex: APR_LOCK_DEFAULTstatic intdestroy(long mutex) Deprecated.Destroy the mutex and free the memory associated with the lock.static intlock(long mutex) Deprecated.Acquire the lock for the given mutex.static Stringlockfile(long mutex) Deprecated.Return the name of the lockfile for the mutex, or NULL if the mutex doesn't use a lock filestatic Stringname(long mutex) Deprecated.Display the name of the mutex, as it relates to the actual method used.static inttrylock(long mutex) Deprecated.Attempt to acquire the lock for the given mutex.static intunlock(long mutex) Deprecated.Release the lock for the given mutex.
- 
Field Details- 
APR_LOCK_FCNTLpublic static final int APR_LOCK_FCNTLDeprecated.fcntl()- See Also:
 
- 
APR_LOCK_FLOCKpublic static final int APR_LOCK_FLOCKDeprecated.flock()- See Also:
 
- 
APR_LOCK_SYSVSEMpublic static final int APR_LOCK_SYSVSEMDeprecated.System V Semaphores- See Also:
 
- 
APR_LOCK_PROC_PTHREADpublic static final int APR_LOCK_PROC_PTHREADDeprecated.POSIX pthread process-based locking- See Also:
 
- 
APR_LOCK_POSIXSEMpublic static final int APR_LOCK_POSIXSEMDeprecated.POSIX semaphore process-based locking- See Also:
 
- 
APR_LOCK_DEFAULTpublic static final int APR_LOCK_DEFAULTDeprecated.Use the default process lock- See Also:
 
 
- 
- 
Constructor Details- 
Lockpublic Lock()Deprecated.
 
- 
- 
Method Details- 
createDeprecated.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.- Parameters:
- 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.
- 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
- pool- the pool from which to allocate the mutex.
- Returns:
- Newly created mutex.
- Throws:
- Error- An error occurred
 
- 
childInitDeprecated.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.- Parameters:
- 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().
- pool- The pool to operate on.
- Returns:
- Newly opened mutex.
- Throws:
- Error- An error occurred
 
- 
lockpublic static int lock(long mutex) Deprecated.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.- Parameters:
- mutex- the mutex on which to acquire the lock.
- Returns:
- the operation status
 
- 
trylockpublic static int trylock(long mutex) Deprecated.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.- Parameters:
- mutex- the mutex on which to attempt the lock acquiring.
- Returns:
- the operation status
 
- 
unlockpublic static int unlock(long mutex) Deprecated.Release the lock for the given mutex.- Parameters:
- mutex- the mutex from which to release the lock.
- Returns:
- the operation status
 
- 
destroypublic static int destroy(long mutex) Deprecated.Destroy the mutex and free the memory associated with the lock.- Parameters:
- mutex- the mutex to destroy.
- Returns:
- the operation status
 
- 
lockfileDeprecated.Return the name of the lockfile for the mutex, or NULL if the mutex doesn't use a lock file- Parameters:
- mutex- the name of the mutex
- Returns:
- the name of the lock file
 
- 
nameDeprecated.Display the name of the mutex, as it relates to the actual method used. This matches the valid options for Apache's AcceptMutex directive- Parameters:
- mutex- the name of the mutex
- Returns:
- the name of the mutex
 
- 
defnameDeprecated.Display the name of the default mutex: APR_LOCK_DEFAULT- Returns:
- the default name
 
 
-