SegnalibriBookmarks

I segnalibri rappresentano il meccanismo che consente a un'attività di attendere passivamente l'input senza mantenere un thread del flusso di lavoro.Bookmarks are the mechanism that enables an activity to passively wait for input without holding onto a workflow thread. Quando un'attività segnala che sta attendendo stimoli, può creare un segnalibro.When an activity signals that it is waiting for stimulus, it can create a bookmark. Ciò indica al runtime che l'esecuzione dell'attività non deve essere considerata completa anche quando viene restituito il metodo attualmente in esecuzione (che ha creato l'oggetto Bookmark).This indicates to the runtime that the activity’s execution should not be considered complete even when the currently executing method (which created the Bookmark) returns.

Informazioni introduttive sul segnalibroBookmark Basics

Un oggetto Bookmark rappresenta un punto in cui l'esecuzione può essere ripresa (e attraverso cui è possibile recapitare l'input) all'interno di un'istanza del flusso di lavoro.A Bookmark represents a point at which execution can be resumed (and through which input can be delivered) within a workflow instance. In genere, viene assegnato un nome a un oggetto Bookmark e il codice esterno (host o estensione) è responsabile della ripresa del segnalibro con i dati attinenti.Typically, a Bookmark is given a name and external (host or extension) code is responsible for resuming the bookmark with relevant data. Quando un oggetto Bookmark viene ripreso, l'esecuzione del flusso di lavoro pianifica il delegato BookmarkCallback associato a tale oggetto Bookmark al momento della creazione.When a Bookmark is resumed, the workflow runtime schedules the BookmarkCallback delegate that was associated with that Bookmark at the time of its creation.

Opzioni del segnalibroBookmark Options

La classe BookmarkOptions specifica il tipo di oggetto Bookmark in corso di creazione.The BookmarkOptions class specifies the type of Bookmark being created. I valori possibili che non si escludono a vicenda sono None, MultipleResume e NonBlocking.The possible non mutually-exclusive values are None, MultipleResume, and NonBlocking. Usare il valore None, ovvero l'impostazione predefinita, quando si crea un oggetto Bookmark che si presume debba essere ripreso una sola volta.Use None, the default, when creating a Bookmark that is expected to be resumed exactly once. Usare il valore MultipleResume quando si crea un oggetto Bookmark che può essere ripreso più volte.Use MultipleResume when creating a Bookmark that can be resumed multiple times. Usare un valore NonBlocking quando si crea un oggetto Bookmark che potrebbe non essere mai ripreso.Use NonBlocking when creating a Bookmark that might never be resumed. A differenza dei segnalibri creati usando l'oggetto BookmarkOptions predefinito, i segnalibri NonBlocking non impediscono il completamento di un'attività.Unlike bookmarks created using the default BookmarkOptions, NonBlocking bookmarks do not prevent an activity from completing.

Ripresa del segnalibroBookmark Resumption

I segnalibri possono essere ripresi dal codice all'esterno di un flusso di lavoro usando uno degli overload ResumeBookmark.Bookmarks can be resumed by code outside of a workflow using one of the ResumeBookmark overloads. In questo esempio viene creata un'attività ReadLine.In this example, a ReadLine activity is created. In caso di esecuzione, l'attività ReadLine crea un oggetto Bookmark, registra un callback, quindi attende la ripresa dell'oggetto Bookmark.When executed, the ReadLine activity creates a Bookmark, registers a callback, and then waits for the Bookmark to be resumed. Una volta ripresa, l'attività ReadLine assegna i dati passati con l'oggetto Bookmark al relativo argomento Result.When it is resumed, the ReadLine activity assigns the data that was passed with the Bookmark to its Result argument.

public sealed class ReadLine : NativeActivity<string>  
{  
    [RequiredArgument]  
    public  InArgument<string> BookmarkName { get; set; }  

    protected override void Execute(NativeActivityContext context)  
    {  
        // Create a Bookmark and wait for it to be resumed.  
        context.CreateBookmark(BookmarkName.Get(context),   
            new BookmarkCallback(OnResumeBookmark));  
    }  

    // NativeActivity derived activities that do asynchronous operations by calling   
    // one of the CreateBookmark overloads defined on System.Activities.NativeActivityContext   
    // must override the CanInduceIdle property and return true.  
    protected override bool CanInduceIdle  
    {  
        get { return true; }  
    }  

    public void OnResumeBookmark(NativeActivityContext context, Bookmark bookmark, object obj)  
    {  
        // When the Bookmark is resumed, assign its value to  
        // the Result argument.  
        Result.Set(context, (string)obj);  
    }  
}  

In questo esempio viene creato un flusso di lavoro che usa l'attività ReadLine per rilevare il nome dell'utente e visualizzarlo nella finestra della console.In this example, a workflow is created that uses the ReadLine activity to gather the user’s name and display it to the console window. L'applicazione host esegue il lavoro effettivo di rilevamento dell'input e lo passa al flusso di lavoro riprendendo l'oggetto Bookmark.The host application performs the actual work of gathering the input and passes it to the workflow by resuming the Bookmark.

Variable<string> name = new Variable<string>  
{  
    Name = "name"  
};  

Activity wf = new Sequence  
{  
    Variables =  
    {  
        name  
    },  
    Activities =  
    {  
        new WriteLine()  
        {  
            Text = "What is your name?"  
        },  
        new ReadLine()  
        {  
            BookmarkName = "UserName",  
            Result = name  
        },  
        new WriteLine()  
        {  
            Text = new InArgument<string>((env) => "Hello, " + name.Get(env))  
        }  
    }  
};  

AutoResetEvent syncEvent = new AutoResetEvent(false);  

// Create the WorkflowApplication using the desired  
// workflow definition.  
WorkflowApplication wfApp = new WorkflowApplication(wf);  

// Handle the desired lifecycle events.  
wfApp.Completed = delegate(WorkflowApplicationCompletedEventArgs e)  
{  
    // Signal the host that the workflow is complete.  
    syncEvent.Set();  
};  

// Start the workflow.  
wfApp.Run();  

// Collect the user's name and resume the bookmark.  
// Bookmark resumption only occurs when the workflow  
// is idle. If a call to ResumeBookmark is made and the workflow  
// is not idle, ResumeBookmark blocks until the workflow becomes  
// idle before resuming the bookmark.  
wfApp.ResumeBookmark("UserName", Console.ReadLine());  

// Wait for Completed to arrive and signal that  
// the workflow is complete.  
syncEvent.WaitOne();  

Quando l'attività ReadLine viene eseguita, crea un oggetto Bookmark denominato UserName e attende la ripresa del segnalibro.When the ReadLine activity is executed, it creates a Bookmark named UserName and then waits for the bookmark to be resumed. L'host raccoglie i dati desiderati, quindi riprende l'oggetto Bookmark.The host collects the desired data and then resumes the Bookmark. Il flusso di lavoro viene ripreso, ne viene visualizzato il nome, quindi viene completato.The workflow resumes, displays the name, and then completes. Si noti che non è necessario alcun codice di sincronizzazione per la ripresa del segnalibro.Note that no synchronization code is required with regard to resuming the bookmark. Un oggetto Bookmark può essere ripreso solo quando il flusso di lavoro è inattivo e, in caso contrario, la chiamata al metodo ResumeBookmark viene bloccata finché il flusso di lavoro non diventa inattivo.A Bookmark can only be resumed when the workflow is idle, and if the workflow is not idle, the call to ResumeBookmark blocks until the workflow becomes idle.

Risultato della ripresa del segnalibroBookmark Resumption Result

Il metodo ResumeBookmark restituisce un valore dell'enumerazione BookmarkResumptionResult per indicare i risultati della richiesta di ripresa del segnalibro.ResumeBookmark returns a BookmarkResumptionResult enumeration value to indicate the results of the bookmark resumption request. I possibili valori restituiti sono Success, NotReady e NotFound.The possible return values are Success, NotReady, and NotFound. Gli host e le estensioni possono usare questo valore per stabilire come procedere.Hosts and extensions can use this value to determine how to proceed.