//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
#ifndef _FIO_FILE_LOCK_H_
#define _FIO_FILE_LOCK_H_
+#include <FBaseObject.h>
+
namespace Tizen { namespace Io
{
/**
* @enum FileLockType
*
- * Defines the file lock type
+ * Defines the file lock types.
*
* @since 2.1
*/
enum FileLockType
{
- FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region.
+ FILE_LOCK_SHARED, /**< More than one process can hold a shared file lock on a file region @n
A shared lock prevents any other process from setting an exclusive lock on the file
- region . */
- FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region.
+ region. */
+ FILE_LOCK_EXCLUSIVE /**< Only one process can hold an exclusive lock on a file region @n
An exclusive lock prevents any other process from setting both shared and exclusive
lock on the file region. */
};
public:
/**
- * This destructor releases the file lock on the current opened file if acquired
+ * This destructor releases the file lock on the current opened file if acquired.
*
* @since 2.1
*/
/**
* Checks whether the file lock is valid. @n
- * The lock is valid unless the associated %File has been closed.
+ * The lock is valid unless the associated file has been closed.
*
* @since 2.1
*