API reference - Class QSystemSemaphore

AlreadyExists

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError AlreadyExists

Description: Enum constant QSystemSemaphore::AlreadyExists

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

Create

Signature: [static,const] QSystemSemaphore_AccessMode Create

Description: Enum constant QSystemSemaphore::Create

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

KeyError

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError KeyError

Description: Enum constant QSystemSemaphore::KeyError

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

NoError

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError NoError

Description: Enum constant QSystemSemaphore::NoError

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

NotFound

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError NotFound

Description: Enum constant QSystemSemaphore::NotFound

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

Open

Signature: [static,const] QSystemSemaphore_AccessMode Open

Description: Enum constant QSystemSemaphore::Open

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

OutOfResources

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError OutOfResources

Description: Enum constant QSystemSemaphore::OutOfResources

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

PermissionDenied

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError PermissionDenied

Description: Enum constant QSystemSemaphore::PermissionDenied

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

UnknownError

Signature: [static,const] QSystemSemaphore_SystemSemaphoreError UnknownError

Description: Enum constant QSystemSemaphore::UnknownError

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

_const_cast

Signature: [const] QSystemSemaphore 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.

acquire

Signature: bool acquire

Description: Method bool QSystemSemaphore::acquire()

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] QSystemSemaphore_SystemSemaphoreError error

Description: Method QSystemSemaphore::SystemSemaphoreError QSystemSemaphore::error()

errorString

Signature: [const] string errorString

Description: Method QString QSystemSemaphore::errorString()

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.

key

Signature: [const] string key

Description: Method QString QSystemSemaphore::key()

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

new

Signature: [static] new QSystemSemaphore new (string key, int initialValue = 0, const QSystemSemaphore_AccessMode mode = QSystemSemaphore::Open)

Description: Constructor QSystemSemaphore::QSystemSemaphore(const QString &key, int initialValue, QSystemSemaphore::AccessMode mode)

This method creates an object of class QSystemSemaphore.

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

release

Signature: bool release (int n = 1)

Description: Method bool QSystemSemaphore::release(int n)

setKey

Signature: void setKey (string key, int initialValue = 0, const QSystemSemaphore_AccessMode mode = QSystemSemaphore::Open)

Description: Method void QSystemSemaphore::setKey(const QString &key, int initialValue, QSystemSemaphore::AccessMode mode)