Synchronisation Context Task

A sychronisation context across multiple tasks or projects.

Only one task can be in a synchronisation context at any time. This provides a mechanism for locking, either within a project or inbetween projects.

Version

Available from version 1.5

Examples

Minimalist example

1<synchronised>
2  <tasks>
3    <!-- Tasks defined here -->
4  </tasks>
5</synchronised>

Full example

1<synchronised continueOnFailure="true" context="thereCanBeOnlyOne" timeout="1200">
2  <description>Example of how to run multiple tasks in a synchronisation context.</description>
3  <tasks>
4    <!-- Tasks defined here -->
5  </tasks>
6</synchronised>

Configuration Elements

Element Description Type Required Default Version
context The name of the synchronisation context. This is only needed if multiple synchronisation contexts are desired. String No DefaultSynchronisationContext 1.5
continueOnFailure Should the tasks continue to run, even if there is a failure? Boolean No false 1.5
description Description used for the visualisation of the buildstage, if left empty the process name will be shown. String No The task/publisher name. 1.5
dynamicValues The dynamic values to use for the task. Dynamic Values array No None 1.5
environment A set of environment variables set for commands that are executed.
Each variable should be specified as
1<variable name="name" value="value" />

.
Environment Variable array No
tasks The tasks to run within the synchronisation context. These tasks will be run in the order they are defined. Task And Publisher Blocks array Yes n/a 1.5
timeout The timeout period (in seconds).
The time-out is only used for attempting to aquire the context. If the task cannot acquire the context within this period, it will time out and throw an error. Once the context has been acquired, there is no time limit on how long it can be held.
Int32 No 300 1.5

Automatically Generated

Documentation generated on Monday, 26 May 2014 at 7:18:04 AM