2 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @brief This is the header file for the %FileLock class.
20 * This header file contains the declarations of the %FileLock class.
23 #ifndef _FIO_FILE_LOCK_H_
24 #define _FIO_FILE_LOCK_H_
26 namespace Tizen { namespace Io
32 * Defines the file lock types.
38 FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region @n
39 A shared lock prevents any other process from setting an exclusive lock on the file
41 FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region @n
42 An exclusive lock prevents any other process from setting both shared and exclusive
43 lock on the file region. */
48 * @brief This class provides methods to check %FileLock type and release it.
52 * @final This class is not intended for extension.
54 * The %FileLock class provides methods to check %FileLock type and release it.
56 * @see Tizen::Io::File
57 * @see Tizen::Io::Registry
59 class _OSP_EXPORT_ FileLock
60 : public Tizen::Base::Object
65 * This destructor releases the file lock on the current opened file if acquired.
69 virtual ~FileLock(void);
72 * Checks whether the file lock is shared.
76 * @return @c true if the file lock is shared, @n
79 bool IsShared(void) const;
82 * Checks whether the file lock is exclusive.
86 * @return @c true if the file lock is exclusive, @n
89 bool IsExclusive(void) const;
92 * Checks whether the file lock is valid. @n
93 * The lock is valid unless the associated file has been closed.
97 * @return @c true if the file lock is valid, @n
100 bool IsValid(void) const;
104 // This default constructor is intentionally declared as private so that only the platform can create an instance.
111 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
115 FileLock(const FileLock& rhs);
118 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
122 FileLock& operator =(const FileLock& rhs);
124 class _FileLockImpl* __pFileLockImpl;
126 friend class _FileLockImpl;
132 #endif // _FIO_FILE_LOCK_H_