help/html/openlcb__buffer__list_8h_source.html

// This is a guard condition so that contents of this file are not included

// more than once.

#ifndef __OPENLCB_OPENLCB_BUFFER_LIST__

#define __OPENLCB_OPENLCB_BUFFER_LIST__


#include <stdbool.h>

#include <stdint.h>


#include "openlcb_types.h"


#ifdef __cplusplus

extern "C"

{

#endif /* __cplusplus */


    extern void OpenLcbBufferList_initialize(void);


    extern openlcb_msg_t *OpenLcbBufferList_add(openlcb_msg_t *new_msg);


    extern openlcb_msg_t *OpenLcbBufferList_find(uint16_t source_alias, uint16_t dest_alias, uint16_t mti);


    extern openlcb_msg_t *OpenLcbBufferList_release(openlcb_msg_t *msg);


    extern openlcb_msg_t *OpenLcbBufferList_index_of(uint16_t index);


    extern bool OpenLcbBufferList_is_empty(void);


    extern void OpenLcbBufferList_check_timeouts(uint8_t current_tick);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* __OPENLCB_OPENLCB_BUFFER_LIST__ */

OpenLcbBufferList_index_of
openlcb_msg_t * OpenLcbBufferList_index_of(uint16_t index)
Returns the message pointer at the given index.
Definition openlcb_buffer_list.c:176

OpenLcbBufferList_check_timeouts
void OpenLcbBufferList_check_timeouts(uint8_t current_tick)
Scans for stale in-progress buffers and frees them.
Definition openlcb_buffer_list.c:205

OpenLcbBufferList_is_empty
bool OpenLcbBufferList_is_empty(void)
Returns true if the list contains no messages.
Definition openlcb_buffer_list.c:189

OpenLcbBufferList_release
openlcb_msg_t * OpenLcbBufferList_release(openlcb_msg_t *msg)
Removes a message from the list without freeing it.
Definition openlcb_buffer_list.c:151

OpenLcbBufferList_find
openlcb_msg_t * OpenLcbBufferList_find(uint16_t source_alias, uint16_t dest_alias, uint16_t mti)
Finds a message matching source alias, dest alias, and MTI.
Definition openlcb_buffer_list.c:115

OpenLcbBufferList_initialize
void OpenLcbBufferList_initialize(void)
Initializes the buffer list to an empty state.
Definition openlcb_buffer_list.c:59

OpenLcbBufferList_add
openlcb_msg_t * OpenLcbBufferList_add(openlcb_msg_t *new_msg)
Inserts a message pointer into the first available slot.
Definition openlcb_buffer_list.c:82

openlcb_types.h
Core type definitions, structures, and configuration constants for the OpenLCB library.

openlcb_msg_t
Core OpenLCB message structure.
Definition openlcb_types.h:480