Skip to content

scheduling.md

Latest commit

 

History

History
131 lines (104 loc) · 3.59 KB

scheduling.md

File metadata and controls

131 lines (104 loc) · 3.59 KB
Raw
description Scheduling PHP

Scheduling

You have the Ecotone async worker running already and you want a once-a-minute job (clean expired carts, refresh stale projections, poll a third-party API) without registering yet another supervisor or wiring up Symfony's Scheduler / Laravel's task scheduler. The #[Scheduled] attribute runs that job in the same worker process — same retries, same error channel, same metrics as the rest of your async handlers.

Scheduled Method

class NotificationService
{
    #[Scheduled(endpointId: "notificationSender")]
    #[Poller(fixedRateInMilliseconds: 1000)]
    public function sendNotifications(): void
    {
        echo "Sending notifications...\n";
    }
}

endpointId - it's name which identifies process to run
poller - Configuration how to execute this method read more in next section.
Above configuration tells Ecotone to execute this method every second.

{% tabs %} {% tab title="Symfony" %}

console ecotone:list
+--------------------+
| Endpoint Names     |
+--------------------+
| notificationSender |
+--------------------+

{% endtab %}

{% tab title="Laravel" %}

artisan ecotone:list
+--------------------+
| Endpoint Names     |
+--------------------+
| notificationSender |
+--------------------+

{% endtab %}

{% tab title="Lite" %}

$consumers = $messagingSystem->list()

{% endtab %} {% endtabs %}

After setting up Scheduled endpoint we can run the endpoint:

{% tabs %} {% tab title="Symfony" %}

console ecotone:run notificationSender -vvv

{% endtab %}

{% tab title="Laravel" %}

artisan ecotone:run notificationSender -vvv

{% endtab %}

{% tab title="Lite" %}

$messagingSystem->run("notificationSender");

{% endtab %} {% endtabs %}

Scheduled Handler

You can run Scheduled for given Handler.
Right now method return Message which is send to given routing.

class CurrencyExchanger
{
    #[Scheduled(requestChannelName: "exchange", endpointId: "currencyExchanger")] 
    #[Poller(fixedRateInMilliseconds=1000)]
    public function callExchange() : array
    {
        return ["currency" => "EUR", "ratio" => 1.23];
    }
}

#[CommandHandler("exchange")] 
public function exchange(ExchangeCommand $command) : void;

requestChannelName - The channel name to which Message should be send.

When the Message will arrive on the Command Handler it will be automatically converted to ExchangeCommand. If you want to understand how the conversion works, you may read about it in Conversion section.

Expression Language

We can also set up cron and fixed rate using expression language. This gives us ability to set it up differently based on the environment we are currently in. 

class CurrencyExchanger
{
    #[Scheduled(requestChannelName: "exchange", endpointId: "currencyExchanger")] 
    #[Poller(fixedRateExpression="reference('timerService').getFixedRate()")]
    public function callExchange() : array
    {
        return ["currency" => "EUR", "ratio" => 1.23];
    }
}

{% hint style="success" %} Timing will be evaluated once, and then preserved as timing configuration. The evaluation will happen when ecotone:run will be executed. {% endhint %}

Materials

Demo implementation

You may find demo implementation here.

Links