API reference - Class QLockFile

LockFailedError

Signature: [static,const] QLockFile_LockError LockFailedError

Description: Enum constant QLockFile::LockFailedError

Python specific notes:
The object exposes a readable attribute 'LockFailedError'. This is the getter.

NoError

Signature: [static,const] QLockFile_LockError NoError

Description: Enum constant QLockFile::NoError

Python specific notes:
The object exposes a readable attribute 'NoError'. This is the getter.

PermissionError

Signature: [static,const] QLockFile_LockError PermissionError

Description: Enum constant QLockFile::PermissionError

Python specific notes:
The object exposes a readable attribute 'PermissionError'. This is the getter.

UnknownError

Signature: [static,const] QLockFile_LockError UnknownError

Description: Enum constant QLockFile::UnknownError

Python specific notes:
The object exposes a readable attribute 'UnknownError'. This is the getter.

_const_cast

Signature: [const] QLockFile ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

error

Signature: [const] QLockFile_LockError error

Description: Method QLockFile::LockError QLockFile::error()

getLockInfo

Signature: [const] bool getLockInfo (long long ptr pid, string ptr hostname, string ptr appname)

Description: Method bool QLockFile::getLockInfo(qint64 *pid, QString *hostname, QString *appname)

isLocked?

Signature: [const] bool isLocked?

Description: Method bool QLockFile::isLocked()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

lock

Signature: bool lock

Description: Method bool QLockFile::lock()

new

Signature: [static] new QLockFile new (string fileName)

Description: Constructor QLockFile::QLockFile(const QString &fileName)

This method creates an object of class QLockFile.

Python specific notes:
This method is the default initializer of the object.

removeStaleLockFile

Signature: bool removeStaleLockFile

Description: Method bool QLockFile::removeStaleLockFile()

setStaleLockTime

Signature: void setStaleLockTime (int arg1)

Description: Method void QLockFile::setStaleLockTime(int)

Python specific notes:
The object exposes a writable attribute 'staleLockTime'. This is the setter.

staleLockTime

Signature: [const] int staleLockTime

Description: Method int QLockFile::staleLockTime()

Python specific notes:
The object exposes a readable attribute 'staleLockTime'. This is the getter.

staleLockTime=

Signature: void staleLockTime= (int arg1)

Description: Method void QLockFile::setStaleLockTime(int)

Python specific notes:
The object exposes a writable attribute 'staleLockTime'. This is the setter.

tryLock

Signature: bool tryLock (int timeout = 0)

Description: Method bool QLockFile::tryLock(int timeout)

unlock

Signature: void unlock

Description: Method void QLockFile::unlock()