Skip to content
Permalink
Browse files

Rename `freeConnectionsRequirement` to `requestMayBeNested`

  • Loading branch information
m-kuhn committed Aug 8, 2018
1 parent 6a9c5fa commit 18112c0c74456ed08527c9b09bb44a31f3e31d8f
@@ -659,36 +659,30 @@ at this moment. A negative value (which is set by default) will wait forever.
.. versionadded:: 3.0
%End

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

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

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

.. versionadded:: 3.4
%End

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

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

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

.. versionadded:: 3.4
%End

0 comments on commit 18112c0

Please sign in to comment.
You can’t perform that action at this time.