Overview

Helper type that creates a single OwnedChunk from a region of memory and mimics v1::SingleChunkRegionTracker.

This type can be used as a drop-in replacement for v1::SingleChunkRegionTracker while migrating to using pw_multibuf/v2.

Inheritance diagram for pw::multibuf::v1_adapter::SingleChunkRegionTracker:

Public Member Functions
	SingleChunkRegionTracker ()

	SingleChunkRegionTracker (ByteSpan region)

ByteSpan	Region () const

std::optional< OwnedChunk >	GetChunk (size_t size)

virtual void	Destroy ()

void	SetRegion (ByteSpan region)

Constructor & Destructor Documentation

pw::multibuf::v1_adapter::SingleChunkRegionTracker::SingleChunkRegionTracker ( )

inline

Default constructor.

Callers must call SetRegion before calling GetChunk.

pw::multibuf::v1_adapter::SingleChunkRegionTracker::SingleChunkRegionTracker ( ByteSpan region )

inlineexplicit

Constructs a region tracker with a single Chunk that maps to region, which must outlive this tracker and any OwnedChunk it creates.

virtual void pw::multibuf::v1_adapter::internal::SingleChunkAllocator::Destroy ( )

inlinevirtual

Destroys the ChunkRegionTracker.

Typical implementations will call std::destroy_at(this) and then free the memory associated with the region and the tracker.

std::optional< OwnedChunk > pw::multibuf::v1_adapter::SingleChunkRegionTracker::GetChunk ( size_t size )

inline

Gets a Chunk of a given size, which must be less than or equal to the provided region.

Returns: An OwnedChunk if the Chunk is free, otherwise std::nullopt, in which case GetChunk() can be called again.

void pw::multibuf::v1_adapter::internal::ChunkAllocator::SetRegion ( ByteSpan region )

Sets the region used to provide chunks.

At most one region may be set by this method or a constructor.

The documentation for this class was generated from the following file:

pw_multibuf/v1_adapter/public/pw_multibuf/v1_adapter/single_chunk_region_tracker.h