Home | History | Annotate | Download | only in lib
      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 
     17 #ifndef BCC_SUPPORT_FILE_MUTEX_H
     18 #define BCC_SUPPORT_FILE_MUTEX_H
     19 
     20 #include <string>
     21 
     22 #include "FileBase.h"
     23 
     24 namespace bcc {
     25 
     26 // This class is used to acquire write locks.
     27 // TODO(jeanluc) More documentation.
     28 class FileMutex : public FileBase {
     29 public:
     30   explicit FileMutex(const std::string &pFileToLock)
     31     : FileBase(pFileToLock + ".lock", O_RDONLY | O_CREAT, kDeleteOnClose) { }
     32 
     33   // Provide a lock() interface filled with default configuration.
     34   inline bool lockMutex() {
     35     return FileBase::lock(FileBase::kWriteLock, true, FileBase::kDefaultMaxRetryLock,
     36                           FileBase::kDefaultRetryLockInterval);
     37   }
     38 };
     39 
     40 } // namespace bcc
     41 
     42 #endif  // BCC_SUPPORT_FILE_MUTEX_H
     43