Stone_Red/DesktopMagic
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/DesktopMagic.git synced 2026-09-04 08:56:15 +02:00
Code Issues Packages Projects Releases 10 Wiki Activity

Add cancellation support to AsyncPlugin methods

Browse Source
This commit is contained in:
Stone_Red
2026-01-13 22:42:15 +01:00
parent 056c42d4df
commit 92ecd2e93d
3 changed files with 44 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/DesktopMagicPluginAPI/AsyncPlugin.cs
+14 -1
View File
@@ -1,5 +1,6 @@
using System;
using System.Drawing;
using System.Threading;
using System.Threading.Tasks;
namespace DesktopMagic.Api;
@@ -15,11 +16,23 @@ namespace DesktopMagic.Api;
/// intervals, and configuration changes as needed.</remarks>
public abstract class AsyncPlugin : Plugin
{
/// <summary>
/// Occurs once when the plugin gets activated. Override for async initialization.
/// </summary>
/// <param name="cancellationToken">Token signaled when the host requests cancellation.</param>
public virtual Task StartAsync(CancellationToken cancellationToken) => Task.CompletedTask;
/// <summary>
/// Occurs once when the plugin gets deactivated. Override for async cleanup.
/// </summary>
/// <param name="cancellationToken">Token signaled when the host requests cancellation.</param>
public virtual Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
/// <summary>
/// Occurs when the <see cref="Plugin.UpdateInterval"/> elapses.
/// </summary>
/// <returns></returns>
public abstract Task<Bitmap?> MainAsync();
public abstract Task<Bitmap?> MainAsync(CancellationToken cancellationToken);
/// <summary>
/// This method should not be called directly! Override and use <see cref="MainAsync"/> for asynchronous plugin operations.