Skip to content

docs #257

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 1 commit into from
Sep 11, 2022
Merged

docs #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions BitFaster.Caching/Lfu/ConcurrentLfuBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,16 @@ namespace BitFaster.Caching.Lfu
/// <summary>
/// A builder of ICache and IScopedCache instances with the following configuration
/// settings:
/// - The maximum size.
/// - The concurrency level.
/// - The key comparer.
/// - The buffer sizes.
///
/// <list type="bullet">
/// <item><description>The maximum size.</description></item>
/// <item><description>The concurrency level.</description></item>
/// <item><description>The key comparer.</description></item>
/// </list>
/// The following features can be selected which change the underlying cache implementation:
/// - Scoped IDisposable values.
/// <list type="bullet">
/// <item><description>Scoped IDisposable values.</description></item>
/// <item><description>Atomic value factory.</description></item>
/// </list>
/// </summary>
/// <typeparam name="K">The type of keys in the cache.</typeparam>
/// <typeparam name="V">The type of values in the cache.</typeparam>
Expand Down
24 changes: 12 additions & 12 deletions BitFaster.Caching/Lru/ConcurrentLruBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using BitFaster.Caching.Lru.Builder;

namespace BitFaster.Caching.Lru
{
/// <summary>
/// A builder of ICache and IScopedCache instances with the following configuration
/// settings:
/// - The maximum size.
/// - The concurrency level.
/// - The key comparer.
///
/// <list type="bullet">
/// <item><description>The maximum size.</description></item>
/// <item><description>The concurrency level.</description></item>
/// <item><description>The key comparer.</description></item>
/// </list>
/// The following features can be selected which change the underlying cache implementation:
/// - Collect metrics (e.g. hit rate). Small perf penalty.
/// - Time based expiration, measured since write.
/// - Scoped IDisposable values.
/// <list type="bullet">
/// <item><description>Collect metrics (e.g. hit rate). Small perf penalty.</description></item>
/// <item><description>Time based expiration, measured since write.</description></item>
/// <item><description>Scoped IDisposable values.</description></item>
/// <item><description>Atomic value factory.</description></item>
/// </list>
/// </summary>
/// <typeparam name="K">The type of keys in the cache.</typeparam>
/// <typeparam name="V">The type of values in the cache.</typeparam>
Expand Down