Skip to content

Commit 18112c0

Browse files
committed
Rename freeConnectionsRequirement to requestMayBeNested
1 parent 6a9c5fa commit 18112c0

File tree

5 files changed

+208
-219
lines changed

5 files changed

+208
-219
lines changed

python/core/auto_generated/qgsfeaturerequest.sip.in

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -659,36 +659,30 @@ at this moment. A negative value (which is set by default) will wait forever.
659659
.. versionadded:: 3.0
660660
%End
661661

662-
int freeConnectionsRequirement() const;
662+
bool requestMayBeNested() const;
663663
%Docstring
664-
The amount of free connections required to start this request.
665-
The system will block the request until the specified amount of connections
666-
is available for usage.
664+
In case this request may be run nested within another already running
665+
iteration on the same connection, set this to true.
667666

668-
By default this amount is 3. This makes sure, that we have 2 spare connections
669-
that might be used by "nested" requests which are executed while iterating
670-
over the results of this request.
667+
If this flag is true, this request will be able to make use of "spare"
668+
connections to avoid deadlocks.
671669

672-
This number should be changed to one, when we know that no nested requests happen
673-
and that this request might happen in a nested way. This is for example given for
674-
expression functions that do internal requests.
670+
For example, this should be set on requests that are issued from an
671+
expression function.
675672

676673
.. versionadded:: 3.4
677674
%End
678675

679-
void setFreeConnectionsRequirement( int freeConnectionsRequirement );
676+
void setRequestMayBeNested( bool requestMayBeNested );
680677
%Docstring
681-
The amount of free connections required to start this request.
682-
The system will block the request until the specified amount of connections
683-
is available for usage.
678+
In case this request may be run nested within another already running
679+
iteration on the same connection, set this to true.
684680

685-
By default this amount is 3. This makes sure, that we have 2 spare connections
686-
that might be used by "nested" requests which are executed while iterating
687-
over the results of this request.
681+
If this flag is true, this request will be able to make use of "spare"
682+
connections to avoid deadlocks.
688683

689-
This number should be changed to one, when we know that no nested requests happen
690-
and that this request might happen in a nested way. This is for example given for
691-
expression functions that do internal requests.
684+
For example, this should be set on requests that are issued from an
685+
expression function.
692686

693687
.. versionadded:: 3.4
694688
%End

0 commit comments

Comments
 (0)