Skip to content

Add remarks about stored exceptions #8751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 9, 2023
Merged

Add remarks about stored exceptions #8751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16e1dc1
add exception remarks to async methods
gewarren Dec 30, 2022
551200a
touch ups - move out from under examples section where necessary
gewarren Dec 30, 2022
8032194
respond to feedback
gewarren Jan 4, 2023
55e5b69
respond to feedback
gewarren Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions xml/Microsoft.Extensions.Caching.Distributed/DistributedCacheExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@
<param name="key">The key to get the stored data for.</param>
<summary>Asynchronously gets a string from the specified cache with the specified key.</summary>
<returns>A task that gets the string value from the stored cache key.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetStringAsync">
Expand Down Expand Up @@ -131,7 +131,7 @@
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
<summary>Asynchronously gets a string from the specified cache with the specified key.</summary>
<returns>A task that gets the string value from the stored cache key.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.GetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="Set">
Expand Down Expand Up @@ -200,7 +200,7 @@
<param name="value">The data to store in the cache.</param>
<summary>Asynchronously sets a sequence of bytes in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.Set(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[])" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down Expand Up @@ -239,7 +239,7 @@
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
<summary>Asynchronously sets a sequence of bytes in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.Set(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.Byte[])" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down Expand Up @@ -351,7 +351,7 @@
<param name="value">The data to store in the cache.</param>
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String)" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down Expand Up @@ -385,7 +385,7 @@
<param name="options">The cache options for the entry.</param>
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down Expand Up @@ -424,7 +424,7 @@
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String)" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down Expand Up @@ -465,7 +465,7 @@
<param name="token">Optional. A <see cref="T:System.Threading.CancellationToken" /> to cancel the operation.</param>
<summary>Asynchronously sets a string in the specified cache with the specified key.</summary>
<returns>A task that represents the asynchronous set operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.DistributedCacheExtensions.SetString(Microsoft.Extensions.Caching.Distributed.IDistributedCache,System.String,System.String,Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="key" /> or <paramref name="value" /> is null.</exception>
</Docs>
Expand Down
16 changes: 8 additions & 8 deletions xml/Microsoft.Extensions.Caching.Distributed/IDistributedCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
Expand Down Expand Up @@ -116,7 +116,7 @@
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Gets a value with the given key.</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation, containing the located value or null.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Get(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="Refresh">
Expand Down Expand Up @@ -175,7 +175,7 @@
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Refresh(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="RefreshAsync">
Expand Down Expand Up @@ -208,7 +208,7 @@
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Refresh(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
Expand Down Expand Up @@ -267,7 +267,7 @@
<param name="key">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Remove(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveAsync">
Expand Down Expand Up @@ -300,7 +300,7 @@
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Removes the value with the given key.</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Remove(System.String)" />.</remarks>
</Docs>
</Member>
<Member MemberName="Set">
Expand Down Expand Up @@ -367,7 +367,7 @@
<param name="options">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />.</remarks>
</Docs>
</Member>
<Member MemberName="SetAsync">
Expand Down Expand Up @@ -404,7 +404,7 @@
<param name="token">Optional. The <see cref="T:System.Threading.CancellationToken" /> used to propagate notifications that the operation should be canceled.</param>
<summary>Sets the value with the given key.</summary>
<returns>The <see cref="T:System.Threading.Tasks.Task" /> that represents the asynchronous operation.</returns>
<remarks>To be added.</remarks>
<remarks>This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as <see cref="T:System.ArgumentException" />, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by <see cref="M:Microsoft.Extensions.Caching.Distributed.IDistributedCache.Set(System.String,System.Byte[],Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions)" />.</remarks>
</Docs>
</Member>
</Members>
Expand Down
Loading