|
OpenTAP 9.31
API Reference
|
A resource manager implements this interface to be able to control how resources are opened and closed during a testplan execution. More...
Public Member Functions | |
| void | WaitUntilAllResourcesOpened (CancellationToken cancellationToken) |
| Waits for all the resources that have been signalled to open to be opened. More... | |
| void | WaitUntilResourcesOpened (CancellationToken cancellationToken, params IResource[] targets) |
| Waits for the specific resources to be open. More... | |
| void | BeginStep (TestPlanRun planRun, ITestStepParent item, TestPlanExecutionStage stage, CancellationToken cancellationToken) |
| Signals that an action is beginning. More... | |
| void | EndStep (ITestStepParent item, TestPlanExecutionStage stage) |
| Signals that an action has completed. More... | |
Properties | |
| IEnumerable< IResource > | Resources [get] |
| Get a snapshot of all currently opened resources. | |
| IEnumerable< IResource > | StaticResources [getset] |
| Sets the resources that should always be opened when the testplan is. | |
| List< ITestStep > | EnabledSteps [getset] |
| This property should be set to all teststeps that are enabled to be run. | |
Events | |
| Action< IResource > | ResourceOpened |
| This event is triggered when a resource is opened. The event may block in which case the resource will remain open for the entire call. | |
A resource manager implements this interface to be able to control how resources are opened and closed during a testplan execution.
| void OpenTap.IResourceManager.BeginStep | ( | TestPlanRun | planRun, |
| ITestStepParent | item, | ||
| TestPlanExecutionStage | stage, | ||
| CancellationToken | cancellationToken | ||
| ) |
Signals that an action is beginning.
| planRun | The planrun for the currently executing testplan. |
| item | The item affected by the current action. This can be either a testplan or a teststep. |
| stage | The stage that is beginning. |
| cancellationToken | Used to cancel the step early. |
| void OpenTap.IResourceManager.EndStep | ( | ITestStepParent | item, |
| TestPlanExecutionStage | stage | ||
| ) |
Signals that an action has completed.
| item | The item affected by the current action. This can be either a testplan or a teststep. |
| stage | The stage that was just completed. |
| void OpenTap.IResourceManager.WaitUntilAllResourcesOpened | ( | CancellationToken | cancellationToken | ) |
Waits for all the resources that have been signalled to open to be opened.
| cancellationToken | Used to cancel the wait early. |
| void OpenTap.IResourceManager.WaitUntilResourcesOpened | ( | CancellationToken | cancellationToken, |
| params IResource[] | targets | ||
| ) |
Waits for the specific resources to be open.
| cancellationToken | Used to cancel the wait early. |
| targets |
OpenTAP 9.31 API built Fri Oct 17 2025 07:12:36