Lock API - Revision history

Devdocsbot: Protected "Lock API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-23T23:56:56Z

Protected "Lock API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 23:56, 23 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-23T23:55:14Z

Update migration status and path

← Older revision		Revision as of 23:55, 23 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/core/lock/}}
	{{Moodle 2.7}}		{{Moodle 2.7}}

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:37:05Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:37, 14 July 2021
				
Line 65:
Line 65:
Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.   Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.  



<code php> <syntaxhighlight lang="php">
$CFG->lock_factory = '\local_redis\lock\redis_lock_factory'; $CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
</syntaxhighlight> </syntaxhighlight>



Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory). Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:03:03Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:03, 14 July 2021
Line 54:		Line 54:
	throw new moodle_exception('locktimeout');		throw new moodle_exception('locktimeout');
	}		}
	</~~code~~>		</syntaxhighlight>

	= Use a different lock type from the default =		= Use a different lock type from the default =
Line 67:		Line 67:
	<code php>		<code php>
	$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';		$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
	</~~code~~>		</syntaxhighlight>

	Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).		Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:02:24Z
Text replacement - "<code php>  " to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 26:
Line 26:
The locking API is used by getting an instance of a lock_factory, and then using it to retrieve locks, and eventually releasing them. You are required to release all your locks, even on the event of failures. The locking API is used by getting an instance of a lock_factory, and then using it to retrieve locks, and eventually releasing them. You are required to release all your locks, even on the event of failures.



<code php> <syntaxhighlight lang="php">// 5 seconds.
  
// 5 seconds. 
$timeout = 5; $timeout = 5;
// A namespace for the locks. Must be prefixed with the component name to prevent conflicts. // A namespace for the locks. Must be prefixed with the component name to prevent conflicts.



Mudrd8mz: /* Implementing new lock types */
2019-10-31T08:06:40Z
Implementing new lock types

				
				
				
				
				
				← Older revision
				Revision as of 08:06, 31 October 2019
				
Line 65:
Line 65:



Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory. Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.
Set $config->lock_factory to the full namespaced path to your class e.g.   Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.  
 
<code php> <code php>
$CFG->lock_factory = '\local_redis\lock\redis_lock_factory'; $CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
</code> </code>
Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces. 



Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory). Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).



Brendanheywood: /* Implementing new lock types */
2019-10-30T02:43:57Z
Implementing new lock types

				
				
				
				
				
				← Older revision
				Revision as of 02:43, 30 October 2019
				
Line 67:
Line 67:
Set $config->lock_factory to the full namespaced path to your class e.g.   Set $config->lock_factory to the full namespaced path to your class e.g.  
<code php> <code php>
$config->lock_factory = '\\local_redis\\lock\\redis_lock_factory'; $CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
</code> </code>
Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces. Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.



Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory). Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).



Jan.dagefoerde: /* Usage */
2017-08-17T14:33:10Z
Usage

				
				
				
				
				
				← Older revision
				Revision as of 14:33, 17 August 2017
				
Line 37:
Line 37:



// Get an instance of the currently configured lock_factory. // Get an instance of the currently configured lock_factory.
$lockfactory = \core\lock\lock_config::get_lock_factory('mod_assign_download_submissions'); $lockfactory = \core\lock\lock_config::get_lock_factory($locktype);



// Get a new lock for the resource, wait for it if needed. // Get a new lock for the resource, wait for it if needed.



Mudrd8mz: /* Usage */ Improve the example of how get_lock() should be used.
2017-02-15T10:18:29Z
Usage:  Improve the example of how get_lock() should be used.

				
				
				
				
				
				← Older revision
				Revision as of 10:18, 15 February 2017
				
Line 39:
Line 39:
$lockfactory = \core\lock\lock_config::get_lock_factory('mod_assign_download_submissions'); $lockfactory = \core\lock\lock_config::get_lock_factory('mod_assign_download_submissions');



// Open a lock. // Get a new lock for the resource, wait for it if needed.
$lock = $lockfactory->get_lock($resource, $timeout); if ($lock = $lockfactory->get_lock($resource, $timeout)) {
    // We have exclusive access to the resource, do the slow zip file generation...



// Do slow zip file generation...     if ($someerror) {
        // Always release locks on failure.
        $lock->release();
        print_error('blah');
    }



if ($someerror) {      // Release the lock once finished.
     // Always release locks on failure. 
     $lock->release();      $lock->release();
     print_error('blah');  
} else {
     // We did not get access to the resource in time, give up.
    throw new moodle_exception('locktimeout');
} }

// Release locks 
$lock->release(); 

</code> </code>






TimHunt: /* Implementing new lock types */
2014-02-21T08:46:02Z
Implementing new lock types

				
				
				
				
				
				← Older revision
				Revision as of 08:46, 21 February 2014
				
Line 63:
Line 63:
Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory. Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.
Set $config->lock_factory to the full namespaced path to your class e.g.   Set $config->lock_factory to the full namespaced path to your class e.g.  
<pre> <code php>
$config->lock_factory = '\\local_redis\\lock\\redis_lock_factory'; $config->lock_factory = '\\local_redis\\lock\\redis_lock_factory';
</pre> </code>
Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces. Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.



Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory). Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

← Older revision		Revision as of 13:37, 14 July 2021
Line 65:		Line 65:
	Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.		Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';		$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
	</syntaxhighlight>		</syntaxhighlight>

	Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).		Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

← Older revision		Revision as of 13:02, 14 July 2021
Line 26:		Line 26:
	The locking API is used by getting an instance of a lock_factory, and then using it to retrieve locks, and eventually releasing them. You are required to release all your locks, even on the event of failures.		The locking API is used by getting an instance of a lock_factory, and then using it to retrieve locks, and eventually releasing them. You are required to release all your locks, even on the event of failures.

	<~~code~~ php>		<syntaxhighlight lang="php">// 5 seconds.

	// 5 seconds.
	$timeout = 5;		$timeout = 5;
	// A namespace for the locks. Must be prefixed with the component name to prevent conflicts.		// A namespace for the locks. Must be prefixed with the component name to prevent conflicts.

← Older revision		Revision as of 08:06, 31 October 2019
Line 65:		Line 65:

	Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.		Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.
	Set ~~$config->~~lock_factory to the full namespaced path to your class e.g.		Set the site configuration variable "lock_factory" to the full namespaced path to your class in the config.php e.g.

	<code php>		<code php>
	$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';		$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
	</code>		</code>
	~~Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.~~

	Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).		Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

← Older revision		Revision as of 02:43, 30 October 2019
Line 67:		Line 67:
	Set $config->lock_factory to the full namespaced path to your class e.g.		Set $config->lock_factory to the full namespaced path to your class e.g.
	<code php>		<code php>
	$~~config~~->lock_factory = '\\local_redis\\lock\\redis_lock_factory';		$CFG->lock_factory = '\local_redis\lock\redis_lock_factory';
	</code>		</code>
	Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.		Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.

	Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).		Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

← Older revision		Revision as of 14:33, 17 August 2017
Line 37:		Line 37:

	// Get an instance of the currently configured lock_factory.		// Get an instance of the currently configured lock_factory.
	$lockfactory = \core\lock\lock_config::get_lock_factory(~~'mod_assign_download_submissions'~~);		$lockfactory = \core\lock\lock_config::get_lock_factory($locktype);

	// Get a new lock for the resource, wait for it if needed.		// Get a new lock for the resource, wait for it if needed.

← Older revision		Revision as of 10:18, 15 February 2017
Line 39:		Line 39:
	$lockfactory = \core\lock\lock_config::get_lock_factory('mod_assign_download_submissions');		$lockfactory = \core\lock\lock_config::get_lock_factory('mod_assign_download_submissions');

	// ~~Open~~ a lock.		// Get a new lock for the resource, wait for it if needed.
	$lock = $lockfactory->get_lock($resource, $timeout);		if ($lock = $lockfactory->get_lock($resource, $timeout)) {
			// We have exclusive access to the resource, do the slow zip file generation...

	// ~~Do slow zip file generation..~~.		if ($someerror) {
			// Always release locks on failure.
			$lock->release();
			print_error('blah');
			}

	~~if ($someerror) {~~		// Release the lock once finished.
	// ~~Always release locks on failure~~.
	$lock->release();		$lock->release();
	~~print_error~~('~~blah~~');
			} else {
			// We did not get access to the resource in time, give up.
			throw new moodle_exception('locktimeout');
	}		}

	~~// Release locks~~
	~~$lock->release();~~

	</code>		</code>

← Older revision		Revision as of 08:46, 21 February 2014
Line 63:		Line 63:
	Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.		Add a new local_XXX plugin with an autoloaded class that implements \core\lock\lock_factory.
	Set $config->lock_factory to the full namespaced path to your class e.g.		Set $config->lock_factory to the full namespaced path to your class e.g.
	<~~pre~~>		<code php>
	$config->lock_factory = '\\local_redis\\lock\\redis_lock_factory';		$config->lock_factory = '\\local_redis\\lock\\redis_lock_factory';
	</~~pre~~>		</code>
	Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.		Note: the extra backslashes are just required because it's a string and php insists on moronic syntax for namespaces.

	Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).		Note: lib/tests/lock_test.php has unit tests that can be run on a custom lock instance to verify it for correctness (run_on_lock_factory).

Lock API - Revision history

Devdocsbot: Protected "Lock API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - " " to ""

Mudrd8mz: /* Implementing new lock types */

Brendanheywood: /* Implementing new lock types */

Jan.dagefoerde: /* Usage */

Mudrd8mz: /* Usage */ Improve the example of how get_lock() should be used.

TimHunt: /* Implementing new lock types */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`