ContractHandle Classe

Définition

public ref class ContractHandle : IDisposable

public class ContractHandle : IDisposable

type ContractHandle = class
    interface IDisposable

Public Class ContractHandle
Implements IDisposable

Héritage

Object

ContractHandle

Implémente

IDisposable

Exemples

L’exemple suivant montre comment définir le handle de jeton de durée de vie dans une carte de contrat à vue côté complément d’un pipeline.

private CalculatorContracts.ICalc2Contract _contract;

private System.AddIn.Pipeline.ContractHandle _handle;

public CalculatorContractToViewHostAdapter(ICalc2Contract contract) {
    _contract = contract;
    _handle = new System.AddIn.Pipeline.ContractHandle(contract);
}

Private _contract As ICalc2Contract
Private _handle As ContractHandle

Public Sub New(ByVal contract As ICalc2Contract)
    _contract = contract
    _handle = New ContractHandle(contract)
End Sub

Remarques

Étant donné que le modèle de complément permet aux compléments de communiquer entre les domaines d’application et entre les processus, il ne peut pas compter sur le garbage collector pour les récupérer. Cette classe fournit un mécanisme de comptage de références pour le complément en obtenant un jeton de durée de vie à son contrat.

Lorsqu’un ContractHandle objet est construit, il appelle la AcquireLifetimeToken méthode sur le contrat passé au constructeur. Lorsque l’objet ContractHandle est supprimé ou finalisé, il appelle la RevokeLifetimeToken méthode sur le contrat, ce qui supprime sa conservation sur le contrat.

Les adaptateurs implémentent le contrat. La ContractHandle classe est conçue pour être utilisée dans un adaptateur de contrat à vue pour aider les développeurs de pipelines à gérer la durée de vie du contrat adapté. En règle générale, une instance de cette classe est instanciée pendant la construction de la classe d’adaptateur et est stockée dans un champ d’instance de l’adaptateur. Lorsque la classe d’adaptateur est collectée par le garbage-collect, l’objet ContractHandle est également collecté et l’objet ContractHandle révoque le jeton de durée de vie sur le contrat.

Il est recommandé que vos adaptateurs de vue à contrat héritent de la ContractBase classe. Vous pouvez ensuite utiliser une implémentation par défaut pour les membres de IContract, ce qui signifie que vous devez implémenter uniquement les membres de votre contrat spécifique.