Class BasePooledBuffer<T>

Namespace

DotCompute.Memory

Assembly

DotCompute.Memory.dll

Base class for pooled memory buffers with automatic recycling.

public abstract class BasePooledBuffer<T> : BaseMemoryBuffer<T>, IUnifiedMemoryBuffer<T>, IUnifiedMemoryBuffer, IAsyncDisposable, IMemoryOwner<T>, IDisposable where T : unmanaged

Type Parameters

T

Inheritance

object

BaseMemoryBuffer<T>

BasePooledBuffer<T>

Implements

IUnifiedMemoryBuffer<T>

IUnifiedMemoryBuffer

IAsyncDisposable

IMemoryOwner<T>

IDisposable

Inherited Members

BaseMemoryBuffer<T>.SizeInBytes

BaseMemoryBuffer<T>.Length

BaseMemoryBuffer<T>.DevicePointer

BaseMemoryBuffer<T>.MemoryType

BaseMemoryBuffer<T>.Accelerator

BaseMemoryBuffer<T>.State

BaseMemoryBuffer<T>.Options

BaseMemoryBuffer<T>.IsOnHost

BaseMemoryBuffer<T>.IsOnDevice

BaseMemoryBuffer<T>.IsDirty

BaseMemoryBuffer<T>.AsSpan()

BaseMemoryBuffer<T>.AsReadOnlySpan()

BaseMemoryBuffer<T>.AsMemory()

BaseMemoryBuffer<T>.AsReadOnlyMemory()

BaseMemoryBuffer<T>.GetDeviceMemory()

BaseMemoryBuffer<T>.Map(MapMode)

BaseMemoryBuffer<T>.MapRange(int, int, MapMode)

BaseMemoryBuffer<T>.MapAsync(MapMode, CancellationToken)

BaseMemoryBuffer<T>.EnsureOnHost()

BaseMemoryBuffer<T>.EnsureOnDevice()

BaseMemoryBuffer<T>.EnsureOnHostAsync(AcceleratorContext, CancellationToken)

BaseMemoryBuffer<T>.EnsureOnDeviceAsync(AcceleratorContext, CancellationToken)

BaseMemoryBuffer<T>.Synchronize()

BaseMemoryBuffer<T>.SynchronizeAsync(AcceleratorContext, CancellationToken)

BaseMemoryBuffer<T>.MarkHostDirty()

BaseMemoryBuffer<T>.MarkDeviceDirty()

BaseMemoryBuffer<T>.CopyFromAsync(ReadOnlyMemory<T>, CancellationToken)

BaseMemoryBuffer<T>.CopyToAsync(Memory<T>, CancellationToken)

BaseMemoryBuffer<T>.CopyToAsync(IUnifiedMemoryBuffer<T>, CancellationToken)

BaseMemoryBuffer<T>.CopyToAsync(int, IUnifiedMemoryBuffer<T>, int, int, CancellationToken)

BaseMemoryBuffer<T>.FillAsync(T, CancellationToken)

BaseMemoryBuffer<T>.FillAsync(T, int, int, CancellationToken)

BaseMemoryBuffer<T>.Slice(int, int)

BaseMemoryBuffer<T>.AsType<TNew>()

BaseMemoryBuffer<T>.CopyFromAsync(ReadOnlyMemory<T>, long, CancellationToken)

BaseMemoryBuffer<T>.CopyToAsync(Memory<T>, long, CancellationToken)

BaseMemoryBuffer<T>.CopyFromAsync(IUnifiedMemoryBuffer<T>, long, long, long, CancellationToken)

BaseMemoryBuffer<T>.ValidateCopyParameters(long, long, long, long, long)

BaseMemoryBuffer<T>.ThrowIfDisposed()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

IUnifiedMemoryBufferExtensions.CopyFromAsync<T>(IUnifiedMemoryBuffer<T>, ReadOnlyMemory<T>, long, CancellationToken)

IUnifiedMemoryBufferExtensions.CopyFromAsync<TBuffer, TSource>(IUnifiedMemoryBuffer<TBuffer>, ReadOnlyMemory<TSource>, int, CancellationToken)

IUnifiedMemoryBufferExtensions.CopyFromAsync<TBuffer, TSource>(IUnifiedMemoryBuffer<TBuffer>, ReadOnlyMemory<TSource>, long, CancellationToken)

IUnifiedMemoryBufferExtensions.ElementCount<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.EnsureReadyForDeviceOperationAsync<T>(IUnifiedMemoryBuffer<T>, CancellationToken)

IUnifiedMemoryBufferExtensions.EnsureReadyForHostOperationAsync<T>(IUnifiedMemoryBuffer<T>, CancellationToken)

IUnifiedMemoryBufferExtensions.GetDevicePointer<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.GetMetrics<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.GetReadOnlySpan<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.GetSpan<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.IsUnifiedMemory<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, Memory<T>, int, CancellationToken)

IUnifiedMemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, Span<T>, int)

IUnifiedMemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, CancellationToken)

IUnifiedMemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, T[], int, CancellationToken)

IUnifiedMemoryBufferExtensions.Read<T>(IUnifiedMemoryBuffer<T>, Span<T>, int)

IUnifiedMemoryBufferExtensions.ToSafeMemory<T>(IUnifiedMemoryBuffer<T>)

IUnifiedMemoryBufferExtensions.ValidateBuffer<T>(IUnifiedMemoryBuffer<T>, string)

IUnifiedMemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, ReadOnlyMemory<T>, int, CancellationToken)

IUnifiedMemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, ReadOnlySpan<T>, int)

IUnifiedMemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, T[], int, CancellationToken)

IUnifiedMemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, T[], CancellationToken)

IUnifiedMemoryBufferExtensions.Write<T>(IUnifiedMemoryBuffer<T>, ReadOnlySpan<T>, int)

MemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, Memory<T>, long, CancellationToken)

MemoryBufferExtensions.ReadAsync<T>(IUnifiedMemoryBuffer<T>, T[], long, CancellationToken)

MemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, ReadOnlyMemory<T>, long, CancellationToken)

MemoryBufferExtensions.WriteAsync<T>(IUnifiedMemoryBuffer<T>, T[], long, CancellationToken)

BufferExtensions.GetElementCount<T>(IUnifiedMemoryBuffer<T>)

BufferExtensions.IsSafeToDispose(IDisposable)

BufferExtensions.SafeDispose(IDisposable)

Remarks

Initializes a new instance of the BasePooledBuffer<T> class.

Constructors

BasePooledBuffer(long, Action<BasePooledBuffer<T>>?)

Base class for pooled memory buffers with automatic recycling.

protected BasePooledBuffer(long sizeInBytes, Action<BasePooledBuffer<T>>? returnAction = null)

Parameters

sizeInBytes long

returnAction Action<BasePooledBuffer<T>>

Remarks

Initializes a new instance of the BasePooledBuffer<T> class.

Properties

IsDisposed

Gets whether the buffer has been disposed.

public override bool IsDisposed { get; }

Property Value

bool

Memory

Gets the memory belonging to this owner.

public abstract Memory<T> Memory { get; }

Property Value

Memory<T>

The memory belonging to this owner.

Methods

Dispose()

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

public override void Dispose()

DisposeAsync()

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

public override ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

DisposeCore()

Core disposal logic to be implemented by derived classes.

protected virtual void DisposeCore()

DisposeCoreAsync()

Core async disposal logic to be implemented by derived classes.

protected virtual ValueTask DisposeCoreAsync()

Returns

ValueTask

Reset()

Resets the buffer for reuse in the pool.

public virtual void Reset()