OLD | NEW |
| (Empty) |
1 /* | |
2 * Licensed to the Apache Software Foundation (ASF) under one or more | |
3 * contributor license agreements. See the NOTICE file distributed with | |
4 * this work for additional information regarding copyright ownership. | |
5 * The ASF licenses this file to You under the Apache License, Version 2.0 | |
6 * (the "License"); you may not use this file except in compliance with | |
7 * the License. You may obtain a copy of the License at | |
8 * | |
9 * http://www.apache.org/licenses/LICENSE-2.0 | |
10 * | |
11 * Unless required by applicable law or agreed to in writing, software | |
12 * distributed under the License is distributed on an "AS IS" BASIS, | |
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
14 * See the License for the specific language governing permissions and | |
15 * limitations under the License. | |
16 */ | |
17 | |
18 package org.apache.tomcat.jni; | |
19 | |
20 /** Global | |
21 * | |
22 * @author Mladen Turk | |
23 */ | |
24 public class Global { | |
25 | |
26 /** | |
27 * Create and initialize a mutex that can be used to synchronize both | |
28 * processes and threads. Note: There is considerable overhead in using | |
29 * this API if only cross-process or cross-thread mutual exclusion is | |
30 * required. See apr_proc_mutex.h and apr_thread_mutex.h for more | |
31 * specialized lock routines. | |
32 * <br><b>Warning :</b> Check APR_HAS_foo_SERIALIZE defines to see if the pl
atform supports | |
33 * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable. | |
34 * @param fname A file name to use if the lock mechanism requires one. This | |
35 * argument should always be provided. The lock code itself will | |
36 * determine if it should be used. | |
37 * @param mech The mechanism to use for the interprocess lock, if any; one o
f | |
38 * <PRE> | |
39 * APR_LOCK_FCNTL | |
40 * APR_LOCK_FLOCK | |
41 * APR_LOCK_SYSVSEM | |
42 * APR_LOCK_POSIXSEM | |
43 * APR_LOCK_PROC_PTHREAD | |
44 * APR_LOCK_DEFAULT pick the default mechanism for the platfo
rm | |
45 * </PRE> | |
46 * @param pool the pool from which to allocate the mutex. | |
47 * @return Newly created mutex. | |
48 */ | |
49 public static native long create(String fname, int mech, long pool) | |
50 throws Error; | |
51 | |
52 /** | |
53 * Re-open a mutex in a child process. | |
54 * @param fname A file name to use if the mutex mechanism requires one. Thi
s | |
55 * argument should always be provided. The mutex code itself w
ill | |
56 * determine if it should be used. This filename should be the | |
57 * same one that was passed to apr_proc_mutex_create(). | |
58 * @param pool The pool to operate on. | |
59 * This function must be called to maintain portability, even | |
60 * if the underlying lock mechanism does not require it. | |
61 * @return Newly opened mutex. | |
62 */ | |
63 public static native long childInit(String fname, long pool) | |
64 throws Error; | |
65 | |
66 /** | |
67 * Acquire the lock for the given mutex. If the mutex is already locked, | |
68 * the current thread will be put to sleep until the lock becomes available. | |
69 * @param mutex the mutex on which to acquire the lock. | |
70 */ | |
71 public static native int lock(long mutex); | |
72 | |
73 /** | |
74 * Attempt to acquire the lock for the given mutex. If the mutex has already | |
75 * been acquired, the call returns immediately with APR_EBUSY. Note: it | |
76 * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine | |
77 * if the return value was APR_EBUSY, for portability reasons. | |
78 * @param mutex the mutex on which to attempt the lock acquiring. | |
79 */ | |
80 public static native int trylock(long mutex); | |
81 | |
82 /** | |
83 * Release the lock for the given mutex. | |
84 * @param mutex the mutex from which to release the lock. | |
85 */ | |
86 public static native int unlock(long mutex); | |
87 | |
88 /** | |
89 * Destroy the mutex and free the memory associated with the lock. | |
90 * @param mutex the mutex to destroy. | |
91 */ | |
92 public static native int destroy(long mutex); | |
93 | |
94 } | |
OLD | NEW |