Base class for ICliActions that use a mutex to lock the Target directory for the duration of the command. More...

Inheritance diagram for OpenTap.Package.LockingPackageAction:

Public Member Functions
override int	Execute (CancellationToken cancellationToken)
	Executes this the action. Derived types should override LockedExecute instead of this.

Public Member Functions inherited from OpenTap.Package.PackageAction
delegate void	ProgressUpdateDelegate (int progressPercent, string message)
	A delegate used by ProgressUpdate

delegate void	ErrorDelegate (Exception ex)
	A delegate type used by the Error event.

int	Execute (CancellationToken cancellationToken)
	The code to be executed by the action.

Public Member Functions inherited from OpenTap.Cli.ICliAction

Static Public Member Functions
static Mutex	GetMutex (string target)
	Get the named mutex used to lock the specified OpenTAP installation directory while it is being changed.

static bool	RunIsolated (string application=null, string target=null)
	Only here for compatibility. Use IsolatedPackageAction instead of calling this.

Protected Member Functions
int	LockedExecute (CancellationToken cancellationToken)
	The code to be executed by the action while the Target directory is locked.

Protected Member Functions inherited from OpenTap.Package.PackageAction
void	RaiseError (Exception ex)
	Call this to raise the Error event.

void	RaiseProgressUpdate (int progressPercent, string message)
	Call this to raise the ProgressUpdate event.

Properties
bool	Unlocked `[get, set]`
	Unlockes the package action to allow multiple running at the same time.

string	Target `[get, set]`
	The location to apply the command to. The default is the location of OpenTap.PackageManager.exe.

Additional Inherited Members
Static Protected Attributes inherited from OpenTap.Package.PackageAction
static TraceSource	log = OpenTap.Log.CreateSource("PackageAction")
	Log source for PackageAction plugins.

Events inherited from OpenTap.Package.PackageAction
ProgressUpdateDelegate	ProgressUpdate
	Called by the action to indicate how far it has gotten. Will usually be called with a progressPercent of 100 to indicate that it is done.

ErrorDelegate	Error
	Called when a critical error happens.

Detailed Description

Base class for ICliActions that use a mutex to lock the Target directory for the duration of the command.

Member Function Documentation

override int OpenTap.Package.LockingPackageAction.Execute ( CancellationToken cancellationToken )

inline

Executes this the action. Derived types should override LockedExecute instead of this.

Returns: Return 0 to indicate success. Otherwise return a custom errorcode that will be set as the exitcode from the CLI.

static Mutex OpenTap.Package.LockingPackageAction.GetMutex ( string target )

inlinestatic

Get the named mutex used to lock the specified OpenTAP installation directory while it is being changed.

Parameters

target The OpenTAP installation directory

int OpenTap.Package.LockingPackageAction.LockedExecute ( CancellationToken cancellationToken )

abstractprotected

The code to be executed by the action while the Target directory is locked.

Returns: Return 0 to indicate success. Otherwise return a custom errorcode that will be set as the exitcode from the CLI.