KIPI::FileReadWriteLock Class Reference

#include <interface.h>

Public Member Functions
virtual	~FileReadWriteLock ()
virtual void	lockForRead ()=0
virtual void	lockForWrite ()=0
virtual bool	tryLockForRead ()=0
virtual bool	tryLockForRead (int timeout)=0
virtual bool	tryLockForWrite ()=0
virtual bool	tryLockForWrite (int timeout)=0
virtual void	unlock ()=0

Detailed Description

Definition at line 122 of file interface.h.

Constructor & Destructor Documentation

virtual KIPI::FileReadWriteLock::~FileReadWriteLock ( )

inlinevirtual

A Kipi FileReadWriteLock refers to application-wide reading/writing to a file on disk; it is created with createReadWriteLock for a URL.

All semantics are identical to a recursive QReadWriteLock. You must unlock as often as you locked.

Note: locking will incur a mutex wait if the file is not free. Therefore, calling the lock methods, especially lockForWrite, from the UI thread shall be done with care, or rather avoided.

Note that you must not keep a lock for a longer time, but only for the imminent low-level reading or writing on disk.

See reserveForAction() API for longer lasting reservation which do not incur waits.

It is strongly recommended to use the FileReadLocker or FileWriteLocker convenience locks instead of creating and locking a FileReadWriteLock directly.

Definition at line 146 of file interface.h.

Member Function Documentation

virtual void KIPI::FileReadWriteLock::lockForRead ( )

pure virtual

virtual void KIPI::FileReadWriteLock::lockForWrite ( )

pure virtual

virtual bool KIPI::FileReadWriteLock::tryLockForRead ( )

pure virtual

virtual bool KIPI::FileReadWriteLock::tryLockForRead ( int  timeout )

pure virtual

virtual bool KIPI::FileReadWriteLock::tryLockForWrite ( )

pure virtual

virtual bool KIPI::FileReadWriteLock::tryLockForWrite ( int  timeout )

pure virtual

virtual void KIPI::FileReadWriteLock::unlock ( )

pure virtual

---

The documentation for this class was generated from the following file:

• interface.h