help/html/openlcb__buffer__fifo_8h_source.html

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

// more than once.

#ifndef __OPENLCB_OPENLCB_BUFFER_FIFO__

#define __OPENLCB_OPENLCB_BUFFER_FIFO__


#include <stdbool.h>

#include <stdint.h>


#include "openlcb_types.h"


#ifdef __cplusplus

extern "C" {

#endif /* __cplusplus */


    extern void OpenLcbBufferFifo_initialize(void);


    extern openlcb_msg_t *OpenLcbBufferFifo_push(openlcb_msg_t *new_msg);


    extern openlcb_msg_t *OpenLcbBufferFifo_pop(void);


    extern bool OpenLcbBufferFifo_is_empty(void);


    extern uint16_t OpenLcbBufferFifo_get_allocated_count(void);


    extern void OpenLcbBufferFifo_check_and_invalidate_messages_by_source_alias(uint16_t alias);


    extern openlcb_msg_t *OpenLcbBufferFifo_push_to_head(openlcb_msg_t *new_msg);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* __OPENLCB_OPENLCB_BUFFER_FIFO__ */

OpenLcbBufferFifo_pop
openlcb_msg_t * OpenLcbBufferFifo_pop(void)
Removes and returns the oldest message from the FIFO.
Definition openlcb_buffer_fifo.c:130

OpenLcbBufferFifo_push_to_head
openlcb_msg_t * OpenLcbBufferFifo_push_to_head(openlcb_msg_t *new_msg)
Inserts a message pointer at the head of the FIFO.
Definition openlcb_buffer_fifo.c:220

OpenLcbBufferFifo_check_and_invalidate_messages_by_source_alias
void OpenLcbBufferFifo_check_and_invalidate_messages_by_source_alias(uint16_t alias)
Marks all queued incoming messages from a released alias as invalid.
Definition openlcb_buffer_fifo.c:175

OpenLcbBufferFifo_push
openlcb_msg_t * OpenLcbBufferFifo_push(openlcb_msg_t *new_msg)
Adds a message pointer to the tail of the FIFO.
Definition openlcb_buffer_fifo.c:98

OpenLcbBufferFifo_get_allocated_count
uint16_t OpenLcbBufferFifo_get_allocated_count(void)
Returns the number of messages currently held in the FIFO.
Definition openlcb_buffer_fifo.c:240

OpenLcbBufferFifo_initialize
void OpenLcbBufferFifo_initialize(void)
Initializes the FIFO to an empty state.
Definition openlcb_buffer_fifo.c:71

OpenLcbBufferFifo_is_empty
bool OpenLcbBufferFifo_is_empty(void)
Returns true if the FIFO contains no messages.
Definition openlcb_buffer_fifo.c:153

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