refactored StructuredAsyncLock

timonkrebs · Oct 10, 2023 · 6006919 · 6006919
1 parent a48afb0
commit 6006919
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 22 deletions.
diff --git a/MemoizR.AsyncLock/MemoizR.AsyncLock.csproj b/MemoizR.AsyncLock/MemoizR.AsyncLock.csproj
diff --git a/MemoizR.AsyncLock/AsyncAsymmetricLock.cs → ...tructuredAsyncLock/AsyncAsymmetricLock.cs b/MemoizR.AsyncLock/AsyncAsymmetricLock.cs → ...tructuredAsyncLock/AsyncAsymmetricLock.cs
@@ -1,4 +1,4 @@
-namespace MemoizR.AsyncLock;
+namespace MemoizR.StructuredAsyncLock;
 
 public class AsyncAsymmetricLock
 {

diff --git a/MemoizR.StructuredAsyncLock/MemoizR.StructuredAsyncLock.csproj b/MemoizR.StructuredAsyncLock/MemoizR.StructuredAsyncLock.csproj
@@ -0,0 +1,32 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <PackageId>MemoizR.StructuredAsyncLock</PackageId>
+    <Version>0.0.5</Version>
+    <Authors>Timon Krebs</Authors>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <PackageReadmeFile>NUGET_ASYNC_LOCK_README.md</PackageReadmeFile>
+    <PackageIcon>MemoizR-Small.png</PackageIcon>
+    <!-- Optional: Publish the repository URL in the built .nupkg (in the NuSpec <Repository> element) -->
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+
+    <!-- Optional: Embed source files that are not tracked by the source control manager in the PDB -->
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+
+    <!-- Optional: Build symbol package (.snupkg) to distribute the PDB containing Source Link -->
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PackageTags>Memoization, StructuredConcurrency, Structured Concurrency, Graph, Dependency, Dependencies, Dynamic, Dynamic Dependencies, Concurrency, Lazy, Resolve, Perf, Performance, Parallel, Parallel Computing, Sync, Synchronization, State, State Synchronization</PackageTags>
+  </PropertyGroup>
+  <ItemGroup>
+        <None Include="..\docs\NUGET_ASYNC_LOCK_README.md" Pack="true" PackagePath="\" />
+        <None Include="..\docs\MemoizR-Small.png" Pack="true" PackagePath="\" />
+  </ItemGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+    <PackageReference Include="Nito.Collections.Deque" Version="1.1.1" />
+  </ItemGroup>
+
+</Project>
diff --git a/MemoizR.AsyncLock/Nito/AsyncWaitQueue.cs → ...tructuredAsyncLock/Nito/AsyncWaitQueue.cs b/MemoizR.AsyncLock/Nito/AsyncWaitQueue.cs → ...tructuredAsyncLock/Nito/AsyncWaitQueue.cs
@@ -1,7 +1,7 @@
 using System.Diagnostics;
 using Nito.Collections;
 
-namespace MemoizR.AsyncLock;
+namespace MemoizR.StructuredAsyncLock;
 
 /// <summary>
 /// A collection of cancelable <see cref="TaskCompletionSource{T}"/> instances. Implementations must assume the caller is holding a lock.

diff --git a/...izR.AsyncLock/Nito/AwaitableDisposable.cs → ...uredAsyncLock/Nito/AwaitableDisposable.cs b/...izR.AsyncLock/Nito/AwaitableDisposable.cs → ...uredAsyncLock/Nito/AwaitableDisposable.cs
@@ -1,6 +1,6 @@
 using System.Runtime.CompilerServices;
 
-namespace MemoizR.AsyncLock;
+namespace MemoizR.StructuredAsyncLock;
 
 /// <summary>
 /// An awaitable wrapper around a task whose result is disposable. The wrapper is not disposable, so this prevents usage errors like "using (MyAsync())" when the appropriate usage should be "using (await MyAsync())".

diff --git a/...ck/Nito/TaskCompletionSourceExtensions.cs → ...ck/Nito/TaskCompletionSourceExtensions.cs b/...ck/Nito/TaskCompletionSourceExtensions.cs → ...ck/Nito/TaskCompletionSourceExtensions.cs
@@ -1,4 +1,4 @@
-namespace MemoizR.AsyncLock;
+namespace MemoizR.StructuredAsyncLock;
 
 /// <summary>
 /// Provides extension methods for <see cref="TaskCompletionSource{TResult}"/>.

diff --git a/MemoizR.sln b/MemoizR.sln
@@ -11,7 +11,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MemoizR.Reactive", "MemoizR
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MemoizR.StructuredConcurrency", "MemoizR.StructuredConcurrency\MemoizR.StructuredConcurrency.csproj", "{565C60BC-380D-4E30-B621-A31C5E229A7F}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MemoizR.AsyncLock", "MemoizR.AsyncLock\MemoizR.AsyncLock.csproj", "{412EE767-E418-4103-B4B1-4D61A2D91D13}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MemoizR.StructuredAsyncLock", "MemoizR.StructuredAsyncLock\MemoizR.StructuredAsyncLock.csproj", "{412EE767-E418-4103-B4B1-4D61A2D91D13}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

diff --git a/MemoizR/Context.cs b/MemoizR/Context.cs
@@ -1,4 +1,4 @@
-using MemoizR.AsyncLock;
+using MemoizR.StructuredAsyncLock;
 
 namespace MemoizR;
 

diff --git a/MemoizR/MemoizR.csproj b/MemoizR/MemoizR.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <ItemGroup>
-    <ProjectReference Include="..\MemoizR.AsyncLock\MemoizR.AsyncLock.csproj" />
+    <ProjectReference Include="..\MemoizR.StructuredAsyncLock\MemoizR.StructuredAsyncLock.csproj" />
   </ItemGroup>
 
   <PropertyGroup>

diff --git a/MemoizR/Signal.cs b/MemoizR/Signal.cs
@@ -1,5 +1,3 @@
-using MemoizR.AsyncLock;
-
 namespace MemoizR;
 
 public sealed class Signal<T> : MemoHandlR<T>

diff --git a/docs/NUGET_ASYNC_LOCK_README.md b/docs/NUGET_ASYNC_LOCK_README.md
@@ -0,0 +1,6 @@
+# MemoizR:AsyncLock
+
+AsyncAsymmetricLock should only be used in accordance with structured sequential concurrency.
+No Task should be stored in a variable to ensure structured sequential concurrency.
+
+Otherwise it there will be undefined behaviour.