Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2012, The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Zonr Chang | c72c4dd | 2012-04-12 15:38:53 +0800 | [diff] [blame] | 17 | #ifndef BCC_SUPPORT_FILE_MUTEX_H |
| 18 | #define BCC_SUPPORT_FILE_MUTEX_H |
Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 19 | |
| 20 | #include <string> |
| 21 | |
Jean-Luc Brouillet | a2dd52f | 2017-02-16 20:57:26 -0800 | [diff] [blame] | 22 | #include "FileBase.h" |
Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 23 | |
| 24 | namespace bcc { |
| 25 | |
Jean-Luc Brouillet | 8486498 | 2017-02-20 14:19:38 -0800 | [diff] [blame] | 26 | // This class is used to acquire write locks. |
| 27 | // TODO(jeanluc) More documentation. |
Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 28 | class FileMutex : public FileBase { |
| 29 | public: |
Chih-Hung Hsieh | 8a019dd | 2016-08-12 15:49:55 -0700 | [diff] [blame] | 30 | explicit FileMutex(const std::string &pFileToLock) |
Stephen Hines | 331310e | 2012-10-26 19:27:55 -0700 | [diff] [blame] | 31 | : FileBase(pFileToLock + ".lock", O_RDONLY | O_CREAT, kDeleteOnClose) { } |
Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 32 | |
| 33 | // Provide a lock() interface filled with default configuration. |
Jean-Luc Brouillet | 8486498 | 2017-02-20 14:19:38 -0800 | [diff] [blame] | 34 | inline bool lockMutex() { |
| 35 | return FileBase::lock(FileBase::kWriteLock, true, FileBase::kDefaultMaxRetryLock, |
| 36 | FileBase::kDefaultRetryLockInterval); |
Zonr Chang | 4f94c52 | 2012-04-05 15:09:28 +0800 | [diff] [blame] | 37 | } |
| 38 | }; |
| 39 | |
| 40 | } // namespace bcc |
| 41 | |
Zonr Chang | c72c4dd | 2012-04-12 15:38:53 +0800 | [diff] [blame] | 42 | #endif // BCC_SUPPORT_FILE_MUTEX_H |