Mbed OS Reference
Loading...
Searching...
No Matches
EMACMemoryManager Class Referenceabstract
Inheritance diagram for EMACMemoryManager:
NetStackMemoryManager NanostackMemoryManager

Public Member Functions

virtual net_stack_mem_buf_t * alloc_heap (uint32_t size, uint32_t align)=0
 Allocates memory buffer from the heap. More...
 
virtual net_stack_mem_buf_t * alloc_pool (uint32_t size, uint32_t align)=0
 Allocates memory buffer chain from a pool. More...
 
virtual uint32_t get_pool_alloc_unit (uint32_t align) const =0
 Get memory buffer pool allocation unit. More...
 
virtual void free (net_stack_mem_buf_t *buf)=0
 Free memory buffer chain. More...
 
virtual uint32_t get_total_len (const net_stack_mem_buf_t *buf) const =0
 Return total length of a memory buffer chain. More...
 
virtual void copy (net_stack_mem_buf_t *to_buf, const net_stack_mem_buf_t *from_buf)=0
 Copy a memory buffer chain. More...
 
virtual void copy_to_buf (net_stack_mem_buf_t *to_buf, const void *ptr, uint32_t len)
 Copy to a memory buffer chain. More...
 
virtual uint32_t copy_from_buf (void *ptr, uint32_t len, const net_stack_mem_buf_t *from_buf) const
 Copy from a memory buffer chain. More...
 
virtual void cat (net_stack_mem_buf_t *to_buf, net_stack_mem_buf_t *cat_buf)=0
 Concatenate two memory buffer chains. More...
 
virtual net_stack_mem_buf_t * get_next (const net_stack_mem_buf_t *buf) const =0
 Returns the next buffer. More...
 
virtual void * get_ptr (const net_stack_mem_buf_t *buf) const =0
 Return pointer to the payload of the buffer. More...
 
virtual uint32_t get_len (const net_stack_mem_buf_t *buf) const =0
 Return payload size of the buffer. More...
 
virtual void set_len (net_stack_mem_buf_t *buf, uint32_t len)=0
 Sets the payload size of the buffer. More...
 

Detailed Description

Definition at line 45 of file EMACMemoryManager.h.

Member Function Documentation

◆ alloc_heap()

virtual net_stack_mem_buf_t * alloc_heap ( uint32_t  size,
uint32_t  align 
)
pure virtualinherited

Allocates memory buffer from the heap.

Memory buffer allocated from heap is always contiguous and can be arbitrary size.

Parameters
sizeSize of the memory to allocate in bytes
alignMemory alignment requirement in bytes
Returns
Allocated memory buffer, or NULL in case of error

Implemented in NanostackMemoryManager.

◆ alloc_pool()

virtual net_stack_mem_buf_t * alloc_pool ( uint32_t  size,
uint32_t  align 
)
pure virtualinherited

Allocates memory buffer chain from a pool.

Memory allocated from pool is contiguous if size is equal or less than (aligned) allocation unit, otherwise may be chained. Will typically come from fixed-size packet pool memory.

Parameters
sizeTotal size of the memory to allocate in bytes
alignMemory alignment requirement for each buffer in bytes
Returns
Allocated memory buffer chain, or NULL in case of error

Implemented in NanostackMemoryManager.

◆ get_pool_alloc_unit()

virtual uint32_t get_pool_alloc_unit ( uint32_t  align) const
pure virtualinherited

Get memory buffer pool allocation unit.

Returns the maximum size of contiguous memory that can be allocated from a pool.

Parameters
alignMemory alignment requirement in bytes
Returns
Contiguous memory size

Implemented in NanostackMemoryManager.

◆ free()

virtual void free ( net_stack_mem_buf_t *  buf)
pure virtualinherited

Free memory buffer chain.

Frees all buffers from the chained list.

Parameters
bufMemory buffer chain to be freed.

Implemented in NanostackMemoryManager.

◆ get_total_len()

virtual uint32_t get_total_len ( const net_stack_mem_buf_t *  buf) const
pure virtualinherited

Return total length of a memory buffer chain.

Returns a total length of this buffer and any following buffers in the chain.

Parameters
bufMemory buffer chain
Returns
Total length in bytes

Implemented in NanostackMemoryManager.

◆ copy()

virtual void copy ( net_stack_mem_buf_t *  to_buf,
const net_stack_mem_buf_t *  from_buf 
)
pure virtualinherited

Copy a memory buffer chain.

Copies data from one buffer chain to another. Copy operation does not adjust the lengths of the copied-to memory buffer chain, so chain total lengths must be the same.

Parameters
to_bufMemory buffer chain to copy to
from_bufMemory buffer chain to copy from

Implemented in NanostackMemoryManager.

◆ copy_to_buf()

virtual void copy_to_buf ( net_stack_mem_buf_t *  to_buf,
const void *  ptr,
uint32_t  len 
)
virtualinherited

Copy to a memory buffer chain.

Copies data to a buffer chain. Copy operation does not adjust the lengths of the copied-to memory buffer chain, so chain total length must match the copied length.

Parameters
to_bufMemory buffer chain to copy to
ptrPointer to data
lenData length

◆ copy_from_buf()

virtual uint32_t copy_from_buf ( void *  ptr,
uint32_t  len,
const net_stack_mem_buf_t *  from_buf 
) const
virtualinherited

Copy from a memory buffer chain.

Copies data from a memory buffer chain.

Parameters
lenData length
ptrPointer to data
from_bufMemory buffer chain to copy from
Returns
Length of the data that was copied

◆ cat()

virtual void cat ( net_stack_mem_buf_t *  to_buf,
net_stack_mem_buf_t *  cat_buf 
)
pure virtualinherited

Concatenate two memory buffer chains.

Concatenates buffer chain to end of the other buffer chain. Concatenated-to buffer total length is adjusted accordingly. cat_buf must point to the start of a the chain. After concatenation to_buf's chain now owns those buffers, and they will be freed when the to_buf chain is freed.

Parameters
to_bufMemory buffer chain to concatenate to
cat_bufMemory buffer chain to concatenate

Implemented in NanostackMemoryManager.

◆ get_next()

virtual net_stack_mem_buf_t * get_next ( const net_stack_mem_buf_t *  buf) const
pure virtualinherited

Returns the next buffer.

Returns the next buffer from the memory buffer chain.

Parameters
bufMemory buffer
Returns
The next memory buffer, or NULL if last

Implemented in NanostackMemoryManager.

◆ get_ptr()

virtual void * get_ptr ( const net_stack_mem_buf_t *  buf) const
pure virtualinherited

Return pointer to the payload of the buffer.

Parameters
bufMemory buffer
Returns
Pointer to the payload

Implemented in NanostackMemoryManager.

◆ get_len()

virtual uint32_t get_len ( const net_stack_mem_buf_t *  buf) const
pure virtualinherited

Return payload size of the buffer.

Parameters
bufMemory buffer
Returns
Size in bytes

Implemented in NanostackMemoryManager.

◆ set_len()

virtual void set_len ( net_stack_mem_buf_t *  buf,
uint32_t  len 
)
pure virtualinherited

Sets the payload size of the buffer.

The allocated payload size will not change. It is not permitted to change the length of a buffer that is not the first (or only) in a chain.

Parameters
bufMemory buffer
lenPayload size, must be less or equal to the allocated size

Implemented in NanostackMemoryManager.