Struct SemaphoreEntrySlim

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

A lightweight, disposable object representing an acquired semaphore entry.

public readonly struct SemaphoreEntrySlim : IDisposable

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToNullable<T>(T)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Properties

Entered

Specifies whether or not a semaphore has been entered.

public bool Entered { get; }

Property Value

bool

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Remarks

Releases previously acquired semaphore entry.

Exceptions

SemaphoreFullException

Attempt to release a semaphore has thrown an exception of this type. See Release() for more information.

Enter(SemaphoreSlim)

Enters a SemaphoreSlim instance by blocking the current thread.

public static SemaphoreEntrySlim Enter(SemaphoreSlim semaphore)

Parameters

semaphore SemaphoreSlim

A semaphore object to enter.

Returns

SemaphoreEntrySlim

A disposable SemaphoreEntrySlim instance.

Exceptions

ObjectDisposedException

The semaphore has been disposed.

EnterAsync(SemaphoreSlim, CancellationToken)

Enters a SemaphoreSlim instance asynchronously.

public static ValueTask<SemaphoreEntrySlim> EnterAsync(SemaphoreSlim semaphore, CancellationToken cancellationToken = default)

Parameters

semaphore SemaphoreSlim

A semaphore object to enter.

cancellationToken CancellationToken

Optional CancellationToken to observe.

Returns

ValueTask<SemaphoreEntrySlim>

A task that returns a disposable SemaphoreEntrySlim instance.

Exceptions

ObjectDisposedException

The semaphore has been disposed.

OperationCanceledException

cancellationToken was cancelled.

TryEnter(SemaphoreSlim, out bool)

Attempts to enter a SemaphoreSlim instance by blocking the current thread. If the semaphore has been disposed, then it will not be entered.

public static SemaphoreEntrySlim TryEnter(SemaphoreSlim semaphore, out bool entered)

Parameters

semaphore SemaphoreSlim

A semaphore object to enter.

entered bool

An out parameter set to true when semaphore has been entered, otherwise false.

Returns

SemaphoreEntrySlim

A disposable SemaphoreEntrySlim instance. Semaphore will not be entered if semaphore has been disposed.

TryEnterAsync(SemaphoreSlim, CancellationToken)

Attempts to enter a SemaphoreSlim instance asynchronously. If the semaphore has been disposed, then it will not be entered.

public static ValueTask<SemaphoreEntrySlim> TryEnterAsync(SemaphoreSlim semaphore, CancellationToken cancellationToken = default)

Parameters

semaphore SemaphoreSlim

A semaphore object to enter.

cancellationToken CancellationToken

Optional CancellationToken to observe.

Returns

ValueTask<SemaphoreEntrySlim>

A task that returns a disposable SemaphoreEntrySlim instance. Semaphore will not be entered if semaphore has been disposed.

Exceptions

OperationCanceledException

cancellationToken was cancelled.