Packet Buffers#

Buffer#

typedef uint16_t Buffer

MessageBufferQueue#

typedef Buffer MessageBufferQueue

PacketHeader#

typedef Buffer PacketHeader

EmberMessageBuffer#

typedef Buffer EmberMessageBuffer

Marker#

typedef void(* Marker) (Buffer *buffer) )(Buffer *buffer)

BufferMarker#

typedef void(* BufferMarker) (void) )(void)

sli_legacy_buffer_manager_allocate_buffer#

Buffer sli_legacy_buffer_manager_allocate_buffer (uint16_t dataSizeInBytes)

Allocates a buffer.

sli_legacy_buffer_manager_get_buffer_pointer#

uint8_t * sli_legacy_buffer_manager_get_buffer_pointer (Buffer buffer)

gets a pointer to the specified buffer

sli_legacy_buffer_manager_get_buffer_length#

uint16_t sli_legacy_buffer_manager_get_buffer_length (Buffer buffer)

gets the length of the specified buffer

sli_legacy_buffer_manager_fill_string_buffer#

Buffer sli_legacy_buffer_manager_fill_string_buffer (const uint8_t * contents)

allocates a buffer and fills it with the given null terminated string

'contents' may be NULL, in which case NULL_BUFFER is returned.

sli_legacy_buffer_manager_fill_buffer#

Buffer sli_legacy_buffer_manager_fill_buffer (const uint8_t * contents, uint16_t length)

Allocates a buffer and fills with length bytes of contents.

sli_legacy_buffer_manager_buffer_bytes_used#

uint16_t sli_legacy_buffer_manager_buffer_bytes_used (void )

returns the number of bytes of buffer space currently in use

sli_legacy_buffer_manager_buffer_bytes_remaining#

uint16_t sli_legacy_buffer_manager_buffer_bytes_remaining (void )

returns the number of available bytes remaining in the buffer system

sli_legacy_buffer_manager_buffer_bytes_total#

uint16_t sli_legacy_buffer_manager_buffer_bytes_total (void )

returns the number of bytes allocated to the buffer system

sli_legacy_buffer_manager_is_valid_buffer#

bool sli_legacy_buffer_manager_is_valid_buffer (Buffer buffer)

returns whether the given buffer is valid

sli_legacy_buffer_manager_set_buffer_length#

void sli_legacy_buffer_manager_set_buffer_length (Buffer buffer, uint16_t length)

Truncates the buffer. New length cannot be longer than the old length.

sli_legacy_buffer_manager_set_buffer_length_from_end#

void sli_legacy_buffer_manager_set_buffer_length_from_end (Buffer buffer, uint16_t length)

Truncates the buffer, removing bytes from the front. New length cannot be longer than the old length.

sli_legacy_buffer_manager_reclaim_unused_buffers#

void sli_legacy_buffer_manager_reclaim_unused_buffers (const BufferMarker * markers)

Reclaims unused buffers and compacts the heap.

Reclaims all buffers not reachable from 'roots', the PHY->MAC queue, by one of marker functions. The marker functions should call their argument on all known buffer references.

The idea is that single top level references, such as a queue, can be put in 'roots', whereas buffers stored in data structures, such as the retry table, are handled by marker functions.

Surviving buffers moved to the beginning of the heap, which amalgamates the free memory into a single contiguous block. This should only be called when there are no references to buffers outside of 'roots', the PHY->MAC queue, and the locations passed to the marker functions.

IMPORTANT: BufferMarker routines should not reference buffers after they have been marked. The buffers may be in an inconsistent state until the reclaimation has completed.

Right: void myBufferMarker(void) { ... myBuffer ... sli_legacy_buffer_manager_mark_buffer(&myBuffer); }

Wrong: void myBufferMarker(void) { sli_legacy_buffer_manager_mark_buffer(&myBuffer); ... myBuffer ... }

sli_legacy_buffer_manager_mark_buffer#

void sli_legacy_buffer_manager_mark_buffer (Buffer * root)

Marks the passed buffer. Called from Marker function.

sli_legacy_buffer_manager_mark_buffer_weak#

void sli_legacy_buffer_manager_mark_buffer_weak (Buffer * root)

weakly mark buffer

sli_legacy_buffer_manager_mark_buffer_weak only operates during the update references phase if emMark Buffer is called on the same buffer elsewhere, the weak reference will be updated. If a buffer is only weakly marked, the update phase will replace it with NULL_BUFFER

NULL_BUFFER#

#define NULL_BUFFER

0x0000u