Устойчивые таймеры

Durable Functions предоставляет durable timers для использования в функциях оркестрации для реализации задержек или настройки тайм-аутов для асинхронных действий. Используйте устойчивые таймеры в функциях оркестратора вместо sleepdelay API, которые могут быть встроены в язык.

Пакеты SDK для устойчивых задач предоставляют устойчивые таймеры для использования в оркестрации для реализации задержек или настройки времени ожидания для асинхронных действий. Применяйте стойкие таймеры в оркестрациях вместо sleep или delay API, которые могут быть встроены в язык.

Это важно

В настоящее время пакет SDK для устойчивых задач PowerShell недоступен.

Устойчивые таймеры — это задачи, создаваемые с помощью соответствующего create timer API для выбранного языка, как показано в следующих примерах, и принимают время срабатывания или продолжительность в качестве аргумента.

C#

// Put the orchestrator to sleep for 72 hours
DateTime dueTime = context.CurrentUtcDateTime.AddHours(72);
await context.CreateTimer(dueTime, CancellationToken.None);

JavaScript

// Put the orchestrator to sleep for 72 hours
// Note that DateTime comes from the "luxon" module
const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ hours: 72 });
yield context.df.createTimer(deadline.toJSDate());

Python

# Put the orchestrator to sleep for 72 hours
due_time = context.current_utc_datetime + timedelta(hours=72)
durable_timeout_task = context.create_timer(due_time)

PowerShell

# Put the orchestrator to sleep for 72 hours
$duration = New-TimeSpan -Hours 72
Start-DurableTimer -Duration $duration

Java

// Put the orchestrator to sleep for 72 hours
ctx.createTimer(Duration.ofHours(72)).await();

C#

// Put the orchestration to sleep for 72 hours
await context.CreateTimer(TimeSpan.FromHours(72), CancellationToken.None);

Python

# Put the orchestration to sleep for 72 hours
from datetime import timedelta
yield ctx.create_timer(timedelta(hours=72))

Java

// Put the orchestration to sleep for 72 hours
ctx.createTimer(Duration.ofHours(72)).await();

JavaScript

// Put the orchestration to sleep for 72 hours
yield ctx.createTimer(72 * 60 * 60);

PowerShell

Пакет SDK для устойчивых задач недоступен для PowerShell. Вместо этого используйте Durable Functions.

await При выполнении задачи таймера функция оркестратора спит до указанного времени окончания срока действия.

await При выполнении задачи таймера оркестрация спит до указанного времени окончания срока действия.

Замечание

Оркестрации продолжают обрабатывать другие входящие события, ожидая истечения срока действия задачи таймера.

Ограничения таймера

При создании таймера, истекающего в 4:30 вечера UTC, базовая платформа устойчивых задач включает сообщение, которое становится видимым только в 4:30 вечера UTC. Если приложение-функция масштабируется до нуля экземпляров в то же время, новое видимое сообщение таймера гарантирует, что приложение-функция активируется снова на соответствующей виртуальной машине.

Замечание

• Для приложений JavaScript, Python и PowerShell устойчивые таймеры ограничены шестью днями. Чтобы обойти это ограничение, используйте API таймера в цикле while для имитации длительной задержки. Актуальные приложения .NET и Java поддерживают произвольные таймеры.
• В зависимости от используемой версии пакета SDK и поставщика хранилища долговременные таймеры в течение шести дней или более могут быть реализованы с помощью ряда более коротких таймеров (например, трехдневных периодов), пока не будет достигнуто требуемое время истечения срока действия. Это поведение наблюдается в базовом хранилище данных, но не влияет на поведение оркестрации.
• Не используйте встроенные API даты и времени для получения текущего времени. При вычислении будущей даты истечения срока действия таймера всегда используйте API текущего времени функции оркестратора. Дополнительные сведения см. в статье об ограничениях кода функции оркестратора.

При создании таймера, истекающего в 4:30 вечера UTC, базовая платформа устойчивых задач включает сообщение, которое становится видимым только в 4:30 вечера UTC. Сообщение таймера гарантирует, что работник активируется снова после истечения срока действия таймера.

Замечание

• Указание длительной задержки (например, задержка в течение нескольких дней или более) может привести к созданию нескольких внутренних управляемых устойчивых таймеров. Код оркестрации не должен знать об этом поведении. Однако он может отображаться в журналах фреймворка и сохраненном состоянии истории.
• Не используйте встроенные API даты и времени для получения текущего времени. При вычислении будущей даты истечения срока действия таймера всегда используйте текущее свойство контекста оркестрации (например, context.CurrentUtcDateTime в .NET, ctx.current_utc_datetime в Python или ctx.currentUtcDateTime в JavaScript).

Применение задержек

В следующем примере показано, как использовать устойчивые таймеры для задержки выполнения. Пример выдает уведомление о выставлении счетов каждый день в течение 10 дней.

C#

[FunctionName("BillingIssuer")]
public static async Task Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    for (int i = 0; i < 10; i++)
    {
        DateTime deadline = context.CurrentUtcDateTime.Add(TimeSpan.FromDays(1));
        await context.CreateTimer(deadline, CancellationToken.None);
        await context.CallActivityAsync("SendBillingEvent");
    }
}

Замечание

Предыдущий пример C# предназначен для Durable Functions 2.x. Для Durable Functions 1.x используйте DurableOrchestrationContext вместо IDurableOrchestrationContext. Дополнительные сведения о различиях между версиями см. в статье о версиях устойчивых функций .

JavaScript

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    for (let i = 0; i < 10; i++) {
        const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ days: 1 });
        yield context.df.createTimer(deadline.toJSDate());
        yield context.df.callActivity("SendBillingEvent");
    }
});

Python

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    for i in range(0, 9):
        deadline = context.current_utc_datetime + timedelta(days=1)
        yield context.create_timer(deadline)
        yield context.call_activity("SendBillingEvent")

main = df.Orchestrator.create(orchestrator_function)

PowerShell

param($Context)

for ($num = 0 ; $num -le 9 ; $num++){
    $expiryTime = New-TimeSpan -Days 1
    $timerTask = Start-DurableTimer -Duration $expiryTime
    Invoke-DurableActivity -FunctionName 'SendBillingEvent'
}

Java

@FunctionName("BillingIssuer")
public String billingIssuer(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    for (int i = 0; i < 10; i++) {
        ctx.createTimer(Duration.ofDays(1)).await();
        ctx.callActivity("SendBillingEvent").await();
    }
    return "done";
}

C#

public class BillingIssuer : TaskOrchestrator<object?, string>
{
    public override async Task<string> RunAsync(TaskOrchestrationContext context, object? input)
    {
        for (int i = 0; i < 10; i++)
        {
            await context.CreateTimer(TimeSpan.FromDays(1), CancellationToken.None);
            await context.CallActivityAsync("SendBillingEvent");
        }
        return "done";
    }
}

Python

from datetime import timedelta
from durabletask import task

def send_billing_event(ctx: task.ActivityContext, _) -> None:
    # Send billing event
    pass

def billing_issuer(ctx: task.OrchestrationContext, _):
    for i in range(10):
        yield ctx.create_timer(timedelta(days=1))
        yield ctx.call_activity(send_billing_event)
    return "done"

Java

public class BillingIssuer implements TaskOrchestration {
    @Override
    public void run(TaskOrchestrationContext ctx) {
        for (int i = 0; i < 10; i++) {
            ctx.createTimer(Duration.ofDays(1)).await();
            ctx.callActivity("SendBillingEvent").await();
        }
        ctx.complete("done");
    }
}

JavaScript

import { ActivityContext, OrchestrationContext, TOrchestrator } from "@microsoft/durabletask-js";

const sendBillingEvent = async (_: ActivityContext): Promise<void> => {
    // Send billing event
};

const billingIssuer: TOrchestrator = async function* (ctx: OrchestrationContext): any {
    for (let i = 0; i < 10; i++) {
        yield ctx.createTimer(24 * 60 * 60); // 1 day
        yield ctx.callActivity(sendBillingEvent);
    }
    return "done";
};

PowerShell

Пакет SDK для устойчивых задач недоступен для PowerShell. Вместо этого используйте Durable Functions.

Предупреждение

Избегайте бесконечных циклов в функциях оркестратора. Сведения о том, как безопасно и эффективно реализовать бесконечные сценарии цикла, см. в разделе "Вечные оркестрации".

Предупреждение

Избегайте бесконечных циклов в оркестрации. Сведения о том, как безопасно и эффективно реализовать бесконечные сценарии цикла, см. в разделе "Вечные оркестрации".

Использование времени ожидания

В этом примере показано, как использовать устойчивые таймеры для организации тайм-аутов.

C#

[FunctionName("TryGetQuote")]
public static async Task<bool> Run(
    [OrchestrationTrigger] IDurableOrchestrationContext context)
{
    TimeSpan timeout = TimeSpan.FromSeconds(30);
    DateTime deadline = context.CurrentUtcDateTime.Add(timeout);

    using (var cts = new CancellationTokenSource())
    {
        Task activityTask = context.CallActivityAsync("GetQuote");
        Task timeoutTask = context.CreateTimer(deadline, cts.Token);

        Task winner = await Task.WhenAny(activityTask, timeoutTask);
        if (winner == activityTask)
        {
            // success case
            cts.Cancel();
            return true;
        }
        else
        {
            // timeout case
            return false;
        }
    }
}

Замечание

Предыдущий пример C# предназначен для Durable Functions 2.x. Для Durable Functions 1.x используйте DurableOrchestrationContext вместо IDurableOrchestrationContext. Дополнительные сведения о различиях между версиями см. в статье о версиях устойчивых функций .

JavaScript

const df = require("durable-functions");
const { DateTime } = require("luxon");

module.exports = df.orchestrator(function*(context) {
    const deadline = DateTime.fromJSDate(context.df.currentUtcDateTime, {zone: 'utc'}).plus({ seconds: 30 });

    const activityTask = context.df.callActivity("GetQuote");
    const timeoutTask = context.df.createTimer(deadline.toJSDate());

    const winner = yield context.df.Task.any([activityTask, timeoutTask]);
    if (winner === activityTask) {
        // success case
        timeoutTask.cancel();
        return true;
    }
    else
    {
        // timeout case
        return false;
    }
});

Python

import azure.functions as func
import azure.durable_functions as df
from datetime import datetime, timedelta

def orchestrator_function(context: df.DurableOrchestrationContext):
    deadline = context.current_utc_datetime + timedelta(seconds=30)
    activity_task = context.call_activity("GetQuote")
    timeout_task = context.create_timer(deadline)

    winner = yield context.task_any([activity_task, timeout_task])
    if winner == activity_task:
        timeout_task.cancel()
        return True
    elif winner == timeout_task:
        return False

main = df.Orchestrator.create(orchestrator_function)

PowerShell

param($Context)

$expiryTime =  New-TimeSpan -Seconds 30

$activityTask = Invoke-DurableActivity -FunctionName 'GetQuote' -NoWait
$timerTask = Start-DurableTimer -Duration $expiryTime -NoWait

$winner = Wait-DurableTask -Task @($activityTask, $timerTask) -Any

if ($winner -eq $activityTask) {
    Stop-DurableTimerTask -Task $timerTask
    return $True
}
else {
    return $False
}

Java

@FunctionName("TryGetQuote")
public boolean tryGetQuote(
        @DurableOrchestrationTrigger(name = "ctx") TaskOrchestrationContext ctx) {
    Task<Double> activityTask = ctx.callActivity("GetQuote", Double.class);
    Task<Void> timerTask = ctx.createTimer(Duration.ofSeconds(30));

    Task<?> winner = ctx.anyOf(activityTask, timerTask);
    if (winner == activityTask) {
        // success case
        return true;
    } else {
        // timeout case
        return false;
    }
}

C#

public class TryGetQuote : TaskOrchestrator<object?, bool>
{
    public override async Task<bool> RunAsync(TaskOrchestrationContext context, object? input)
    {
        using var cts = new CancellationTokenSource();

        Task<double> activityTask = context.CallActivityAsync<double>("GetQuote");
        Task timeoutTask = context.CreateTimer(TimeSpan.FromSeconds(30), cts.Token);

        Task winner = await Task.WhenAny(activityTask, timeoutTask);
        if (winner == activityTask)
        {
            // success case
            cts.Cancel();
            return true;
        }
        else
        {
            // timeout case
            return false;
        }
    }
}

Python

from datetime import timedelta
from durabletask import task

def get_quote(ctx: task.ActivityContext, _) -> float:
    # Get quote logic
    return 100.0

def try_get_quote(ctx: task.OrchestrationContext, _):
    activity_task = ctx.call_activity(get_quote)
    timeout_task = ctx.create_timer(timedelta(seconds=30))

    winner = yield task.when_any([activity_task, timeout_task])
    if winner == activity_task:
        # success case
        return True
    else:
        # timeout case
        return False

Java

public class TryGetQuote implements TaskOrchestration {
    @Override
    public void run(TaskOrchestrationContext ctx) {
        Task<Double> activityTask = ctx.callActivity("GetQuote", Double.class);
        Task<Void> timerTask = ctx.createTimer(Duration.ofSeconds(30));

        Task<?> winner = ctx.anyOf(activityTask, timerTask).await();
        if (winner == activityTask) {
            // success case
            ctx.complete(true);
        } else {
            // timeout case
            ctx.complete(false);
        }
    }
}

JavaScript

import { ActivityContext, OrchestrationContext, TOrchestrator, whenAny } from "@microsoft/durabletask-js";

const getQuote = async (_: ActivityContext): Promise<number> => {
    // Get quote logic
    return 100.0;
};

const tryGetQuote: TOrchestrator = async function* (ctx: OrchestrationContext): any {
    const activityTask = ctx.callActivity(getQuote);
    const timeoutTask = ctx.createTimer(30);

    const winner = yield whenAny([activityTask, timeoutTask]);
    if (winner === activityTask) {
        // success case
        return true;
    } else {
        // timeout case
        return false;
    }
};

PowerShell

Пакет SDK для устойчивых задач недоступен для PowerShell. Вместо этого используйте Durable Functions.

Предупреждение

В .NET, JavaScript, Python и PowerShell отменяйте все созданные устойчивые таймеры, если ваш код не ожидает их завершения. См. предыдущие примеры, чтобы узнать, как отменить ожидающие таймеры. Платформа устойчивых задач не изменяет состояние оркестрации на "Завершено" до тех пор, пока не будут выполнены все невыполненные задачи, включая устойчивые задачи таймера, либо завершены, либо отменены.

Предупреждение

Если ваш SDK поддерживает отмену таймера (например, .NET), отмените любые созданные долговременные таймеры, если ваш код не ожидает их завершения. См. предыдущие примеры, чтобы узнать, как отменить ожидающие таймеры. Платформа устойчивых задач не изменяет состояние оркестрации на "Завершено" до тех пор, пока не будут выполнены все невыполненные задачи, включая устойчивые задачи таймера, либо завершены, либо отменены.

Этот механизм отмены, использующий шаблон when-any, не завершает выполнение функций активности или выполнения подоркестраций, которые находятся в процессе выполнения. Скорее, это позволяет функции оркестратора игнорировать результат и двигаться дальше. Если ваше приложение-функция использует план потребления, вам по-прежнему выставляется плата за любое время и память, которые использует брошенная функция активности. По умолчанию функции, работающие в плане потребления, имеют время ожидания в течение пяти минут. Если это ограничение превышено, хост Azure Functions перезагружается, чтобы остановить все выполнение и предотвратить неконтролируемую ситуацию выставления счетов. Время ожидания функции настраивается.

Более подробный пример реализации времени ожидания в функциях оркестратора см. в статье о взаимодействии с человеком .

Этот механизм отмены, использующий шаблон when-any, не завершает выполнение текущих активностей или исполнения под-оркестраций. Скорее, это просто позволяет оркестрации игнорировать результат и двигаться дальше.

Дальнейшие действия

Узнайте, как создавать и обрабатывать внешние события

Начало работы с Durable Task SDK