ProjectCachePluginBase Class

Definition

Only one plugin instance can exist for a given BuildManager BeginBuild / EndBuild session. Any exceptions thrown by the plugin will cause MSBuild to fail the build.

public ref class ProjectCachePluginBase abstract
public abstract class ProjectCachePluginBase
type ProjectCachePluginBase = class
Public MustInherit Class ProjectCachePluginBase
Inheritance
ProjectCachePluginBase

Constructors

ProjectCachePluginBase()

Methods

BeginBuildAsync(CacheContext, PluginLoggerBase, CancellationToken)

Called once before the build, to have the plugin instantiate its state. Errors are checked via HasLoggedErrors.

EndBuildAsync(PluginLoggerBase, CancellationToken)

Called once after all the build to let the plugin do any post build operations (log metrics, cleanup, etc). Errors are checked via HasLoggedErrors.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetCacheResultAsync(BuildRequestData, PluginLoggerBase, CancellationToken)

Called once for each build request. Operation needs to be atomic. Any side effects (IO, environment variables, etc) need to be reverted upon cancellation. MSBuild may choose to cancel this method and build the project itself. Errors are checked via HasLoggedErrors.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to