OpenTAP 9.24
API Reference
Public Member Functions | List of all members
OpenTap.ILockManager Interface Reference

Implementing this interface will enable hooks before and after resources are opened and closed. More...

Inheritance diagram for OpenTap.ILockManager:
OpenTap.ITapPlugin

Public Member Functions

void BeforeOpen (IEnumerable< IResourceReferences > resources, CancellationToken abortToken)
 This hook is triggered before IResource.Open is executed. Only called once when e.g. a TestStep with mulitple resources starts. More...
 
void AfterClose (IEnumerable< IResourceReferences > resources, CancellationToken abortToken)
 This hook is triggered after the TestStep or TestPlan is done executing. If triggered by a TestStep, defered actions may still be running. More...
 

Detailed Description

Implementing this interface will enable hooks before and after resources are opened and closed.

Member Function Documentation

◆ AfterClose()

void OpenTap.ILockManager.AfterClose ( IEnumerable< IResourceReferences resources,
CancellationToken  abortToken 
)

This hook is triggered after the TestStep or TestPlan is done executing. If triggered by a TestStep, defered actions may still be running.

Parameters
resourcesThis will contain the same resources as given to BeforeOpen".</param> <param name="abortToken">A token that will be signalled if the locking action should be cancelled.

◆ BeforeOpen()

void OpenTap.ILockManager.BeforeOpen ( IEnumerable< IResourceReferences resources,
CancellationToken  abortToken 
)

This hook is triggered before IResource.Open is executed. Only called once when e.g. a TestStep with mulitple resources starts.

Parameters
resourcesThe resources that will be opened.
abortTokenA token that will be signalled if the locking action should be cancelled.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:41