fd.h File Reference

Frame data block list utility functions. More...

#include <stdint.h>

Include dependency graph for fd.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	fd_list_s
	Represents a list of frame data blocks. More...
struct	fd_node_s
	Represents a node in a list of frame data blocks. More...

Functions
void	FD_free (struct fd_list_s *list)
	Frees all entry nodes in the list, but does not free the list itself.
struct fd_node_s *	FD_shift (struct fd_list_s *list)
	Returns the first node in the list and removes it for consumption by the caller. The caller is responsible for freeing the returned node.
int	FD_append (struct fd_list_s *list, uint8_t *frame)
	Appends a new frame data block to the end of the list. The frame data provided is not copied, so the caller is responsible for ensuring the memory remains valid until the frame data block is freed.

Detailed Description

Frame data block list utility functions.

Function Documentation

FD_append()

int FD_append	(	struct fd_list_s *	list,
		uint8_t *	frame )

Appends a new frame data block to the end of the list. The frame data provided is not copied, so the caller is responsible for ensuring the memory remains valid until the frame data block is freed.

Parameters

list	pointer to the list structure, must be non-NULL and zero initialized
frame	frame data to append

Returns

0 on success, a negative error code on failure

Here is the caller graph for this function:

FD_free()

void FD_free

(

struct fd_list_s *

list

)

Frees all entry nodes in the list, but does not free the list itself.

Parameters

list	pointer to the list structure to free

Here is the caller graph for this function:

FD_shift()

struct fd_node_s * FD_shift

(

struct fd_list_s *

list

)

Returns the first node in the list and removes it for consumption by the caller. The caller is responsible for freeing the returned node.

Parameters

list	pointer to the list structure, must be non-NULL and zero initialized

Returns

the first node in the list, or NULL if the list is empty

Here is the caller graph for this function: