This repository has been archived on 2023-02-02. You can view files and clone it, but cannot push or open issues or pull requests.
mfgames-locking-cil/MfGames.Locking/TryGetCreate.cs
Dylan R. E. Moonfire f01a18a15a Initial commit.
2018-01-18 16:16:01 -06:00

111 lines
4.4 KiB
C#

// <copyright file="TryGetCreate.cs" company="Moonfire Games">
// Copyright (c) Moonfire Games.
// This code is licensed under the MIT license.
// See LICENSE.md in the source or https://opensource.org/licenses/MIT
// </copyright>
namespace MfGames.Locking
{
using System;
using System.Threading;
/// <summary>
/// Implements the basic pattern for getting an item from a cache using
/// the ReaderWriterLockSlim class. This attempts to get it using a read-only
/// lock. If that fails, it gets an upgradable lock, tries again, and if it
/// still can't find it, upgrades the lock to a write lock to create it.
/// </summary>
public static class TryGetCreate
{
/// <summary>
/// Invokes the try/get/create pattern used a condition to test for it
/// and a constructor function.
/// </summary>
/// <param name="readerWriterLockSlim">The reader writer lock slim.</param>
/// <param name="conditionHandler">The condition handler.</param>
/// <param name="createHandler">The create handler.</param>
public static void Invoke(
ReaderWriterLockSlim readerWriterLockSlim,
Func<bool> conditionHandler,
Action createHandler)
{
using (new ReadLock(readerWriterLockSlim))
{
// Verify that the condition for creating it is false.
if (!conditionHandler())
{
return;
}
}
// We failed to get the lock using the read-only. We create an upgradable lock
// and try again since it may have been created with a race condition when the
// last lock was released and this one was acquired.
using (new UpgradableLock(readerWriterLockSlim))
{
// Verify that the condition for creating it is false.
if (!conditionHandler())
{
return;
}
// We failed to get it in the lock. Upgrade the lock to a write and create it.
using (new WriteLock(readerWriterLockSlim))
{
createHandler();
}
}
}
/// <summary>
/// Invokes the try/get/create pattern using a tryget retrieval and a
/// creator handler.
/// </summary>
/// <typeparam name="TInput">The type of the input.</typeparam>
/// <typeparam name="TOutput">The type of the output.</typeparam>
/// <param name="readerWriterLockSlim">The reader writer lock slim.</param>
/// <param name="input">The input.</param>
/// <param name="tryGetHandler">The try get handler.</param>
/// <param name="createHandler">The create handler.</param>
/// <returns>The requested output object.</returns>
public static TOutput Invoke<TInput, TOutput>(
ReaderWriterLockSlim readerWriterLockSlim,
TInput input,
TryGetHandler<TInput, TOutput> tryGetHandler,
Func<TInput, TOutput> createHandler)
{
// First attempt to get the item using a read-only lock.
TOutput output;
using (new ReadLock(readerWriterLockSlim))
{
// Try to get the item using the try/get handler.
if (tryGetHandler(input, out output))
{
// We successful got the item in the read-only cache, so just return it.
return output;
}
}
// We failed to get the lock using the read-only. We create an upgradable lock
// and try again since it may have been created with a race condition when the
// last lock was released and this one was acquired.
using (new UpgradableLock(readerWriterLockSlim))
{
// Try to get the item using the try/get handler.
if (tryGetHandler(input, out output))
{
// We successful got the item in this lock, so return it without
// upgrading the lock.
return output;
}
// We failed to get it in the lock. Upgrade the lock to a write and create it.
using (new WriteLock(readerWriterLockSlim))
{
return createHandler(input);
}
}
}
}
}