ЗакладкиBookmarks

Закладки - это механизм, позволяющий действиям пассивно ожидать ввода, не останавливая поток рабочего процесса.Bookmarks are the mechanism that enables an activity to passively wait for input without holding onto a workflow thread. Когда действие сообщает об ожидании внешнего воздействия, оно может создать закладку.When an activity signals that it is waiting for stimulus, it can create a bookmark. Это сообщает среде выполнения, что выполнение действия не должно считаться завершенным даже в случае возвращения управления из выполняющегося в данный момент метода (создавшего закладку 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.

Основные сведения о закладкахBookmark Basics

Закладка Bookmark представляет точку, с которой может быть продолжено выполнение (и через которую могут быть переданы входные данные) в экземпляре рабочего процесса.A Bookmark represents a point at which execution can be resumed (and through which input can be delivered) within a workflow instance. Обычно закладке Bookmark присваиваются имя и внешний код (ведущего приложения или расширения), используемый для продолжения работы с точки закладки с соответствующими данными.Typically, a Bookmark is given a name and external (host or extension) code is responsible for resuming the bookmark with relevant data. При возобновлении закладки Bookmark среда выполнения рабочего процесса планирует делегат BookmarkCallback, который был связан с этой закладкой Bookmark на момент ее создания.When a Bookmark is resumed, the workflow runtime schedules the BookmarkCallback delegate that was associated with that Bookmark at the time of its creation.

Параметры закладкиBookmark Options

В классе BookmarkOptions указывается тип создаваемой закладки Bookmark.The BookmarkOptions class specifies the type of Bookmark being created. Возможны следующие (не исключающие друг друга) значения: None, MultipleResume и NonBlocking.The possible non mutually-exclusive values are None, MultipleResume, and NonBlocking. При создании закладки None, которая будет возобновлена ровно один раз, рекомендуется использовать вариант по умолчанию Bookmark.Use None, the default, when creating a Bookmark that is expected to be resumed exactly once. При создании закладки MultipleResume, которая может быть возобновлена несколько раз, следует использовать вариант Bookmark.Use MultipleResume when creating a Bookmark that can be resumed multiple times. При создании закладки NonBlocking, которая может быть не продолжена вообще, следует использовать параметр Bookmark.Use NonBlocking when creating a Bookmark that might never be resumed. В отличие от закладок, созданных с использованием параметров BookmarkOptions по умолчанию, закладки типа NonBlocking не мешают завершению работы действия.Unlike bookmarks created using the default BookmarkOptions, NonBlocking bookmarks do not prevent an activity from completing.

Возобновление закладокBookmark Resumption

Закладки могут возобновляться кодом извне рабочего процесса с использованием одного из перегруженных методов ResumeBookmark.Bookmarks can be resumed by code outside of a workflow using one of the ResumeBookmark overloads. В этом примере создается действие ReadLine.In this example, a ReadLine activity is created. При выполнении действие ReadLine создает Bookmark, регистрирует обратный вызов и ждет возобновления чтения с закладки Bookmark.When executed, the ReadLine activity creates a Bookmark, registers a callback, and then waits for the Bookmark to be resumed. После возобновления чтения с закладки действие ReadLine присваивает данные, переданные с закладкой Bookmark, своему аргументу 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);  
    }  
}  

В следующем примере создается рабочий процесс, использующий действие ReadLine для получения имени пользователя и его отображения в окне консоли.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. Ведущее приложение выполняет действительную работу по сбору входных данных и передает их в рабочий процесс, возобновляя закладку 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();  

При выполнении действие ReadLine создает закладку Bookmark с именем UserName и ждет возобновления чтения с этой закладки.When the ReadLine activity is executed, it creates a Bookmark named UserName and then waits for the bookmark to be resumed. Узел собирает необходимые данные и возобновляет чтение с закладки Bookmark.The host collects the desired data and then resumes the Bookmark. Рабочий процесс возобновляется, отображает имя и затем завершается.The workflow resumes, displays the name, and then completes. Следует заметить, что для возобновления закладки не требуется наличие кода синхронизации.Note that no synchronization code is required with regard to resuming the bookmark. Закладка Bookmark может быть возобновлена только при простое рабочего процесса; если рабочий процесс не простаивает, вызов ResumeBookmark блокируется, пока рабочий процесс не перейдет в состояние простоя.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.

Результат возобновления закладкиBookmark Resumption Result

ResumeBookmark возвращает значение перечисления BookmarkResumptionResult, сообщая о результате выполнения запроса возобновления закладки.ResumeBookmark returns a BookmarkResumptionResult enumeration value to indicate the results of the bookmark resumption request. Возможны следующие возвращаемые значения: Success, NotReady и NotFound.The possible return values are Success, NotReady, and NotFound. Ведущие приложения и расширения могут использовать эти значения для определения дальнейших действий.Hosts and extensions can use this value to determine how to proceed.