BloombergLP::bdlma::BufferImpUtil::allocateMaximallyAlignedFromBuffer

Allocate a maximally‐aligned memory block from a buffer.

Synopsis

Declared in <bdlma_bufferimputil.h>

static
void*
allocateMaximallyAlignedFromBuffer(
    bsls::Types::IntPtr* cursor,
    char* buffer,
    bsls::Types::size_type bufferSize,
    bsls::Types::size_type size);

Description

Allocate a maximally‐aligned memory block of the specified size (in bytes) from the specified buffer having the specified bufferSize (in bytes) at the specified cursor position. Return the address of the allocated memory block if buffer contains sufficient available memory, and 0 otherwise. The cursor is set to the first byte position immediately after the allocated memory if there is sufficient memory, and not modified otherwise. The behavior is undefined unless 0 < size, 0 <= *cursor, and *cursor <= bufferSize.

Return Value

address of the allocated memory block if buffer contains sufficient available memory, and 0 otherwise

Parameters

Name

Description

cursor

byte offset into buffer at which to allocate

buffer

memory buffer from which to allocate

bufferSize

size in bytes of buffer

size

size in bytes of the memory block to allocate

Created with MrDocs