Files
libremetaverse/LibreMetaverse/Repeat.cs
2025-06-16 15:38:23 -05:00

102 lines
4.0 KiB
C#

/*
* Copyright (c) 2025, Sjofn LLC.
* All rights reserved.
*
* - Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* - Neither the name of the openmetaverse.co nor the names
* of its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Threading.Tasks;
using System.Threading;
namespace LibreMetaverse
{
internal static class Repeat
{
/// <summary>
/// Execute a given <see cref="Action"/> at a given interval in a loop
/// </summary>
/// <param name="pollInterval">Interval for executing action</param>
/// <param name="action">Essentially the action you wish to execute</param>
/// <param name="token">Cancellation token</param>
/// <param name="immediately">When set, executes the action immediately instead of waiting for the interval</param>
/// <returns></returns>
public static Task Interval(
TimeSpan pollInterval,
Action action,
CancellationToken token,
bool immediately = false)
{
return Task.Factory.StartNew(
() =>
{
if (immediately) { action(); }
for (; ; )
{
if (token.WaitCancellationRequested(pollInterval)) { break; }
action();
}
}, token, TaskCreationOptions.LongRunning, TaskScheduler.Default);
}
/// <summary>
/// Execute a given <see cref="Action"/> at a given interval in a loop
/// </summary>
/// <param name="pollInterval">Interval for executing action</param>
/// <param name="asyncAction">Essentially the action you wish to execute</param>
/// <param name="token">Cancellation token</param>
/// <param name="immediately">When set, executes the action immediately instead of waiting for the interval</param>
/// <returns></returns>
public static Task IntervalAsync(
TimeSpan pollInterval,
Func<Task> asyncAction,
CancellationToken token,
bool immediately = false)
{
return Task.Factory.StartNew(
async () =>
{
if (immediately)
{
await asyncAction(); }
for (; ; )
{
if (token.WaitCancellationRequested(pollInterval)) { break; }
await asyncAction();
}
}, token, TaskCreationOptions.LongRunning, TaskScheduler.Default);
}
}
internal static class CancellationTokenExtensions
{
public static bool WaitCancellationRequested(
this CancellationToken token,
TimeSpan timeout)
{
return token.WaitHandle.WaitOne(timeout);
}
}
}