![]() |
MHEG5
22.11.0
|
MHEG5 Queue. More...
#include "techtype.h"
#include "stb_os.h"
#include "glue_memory.h"
#include "glue_debug.h"
#include "glue_queue.h"
Classes | |
struct | s_msg_queue |
struct | s_q_notify |
Typedefs | |
typedef struct s_msg_queue | S_MSG_QUEUE |
typedef struct s_q_notify | S_Q_NOTIFY |
Functions | |
E_MhegErr | VQ_Open (S_MhegConfig *cfg_params) |
Initialise component control and section queues. Allocates memory for, sets up and creates event (component control) and section queues. More... | |
void | VQ_Close (void) |
Close component control and section queue component. Destroys all allocated memory and resources for event and section queues. Must be called before MHEG5 main task starts. More... | |
E_MhegErr | VQ_PutMsg (S_MhegMessage *pMsg, E_PRIORITY priority) |
Post an event or section into component queues. Copies data into queue. More... | |
E_MhegErr | VQ_GetMsg (S_MhegMessage *pMsg) |
Get an event or section from the component queues. This is a blocking function. More... | |
U16BIT | VQ_GetSizeFree (E_PRIORITY priority) |
Get size available on a queue. More... | |
BOOLEAN | VQ_EventNeedsProcessing (void) |
Check whether any events on component queues needs processing. More... | |
void * | VQ_RegisterNotify (F_QueueNotify normal_rcvd, F_QueueNotify critical_rcvd, F_QueueNotify critical_done) |
void | VQ_UnRegisterNotify (void *qn) |
MHEG5 Queue.
void VQ_Close | ( | void | ) |
Close component control and section queue component. Destroys all allocated memory and resources for event and section queues. Must be called before MHEG5 main task starts.
Close component control and section queue component. Destroys all allocated memory and resources for event and section queues.
BOOLEAN VQ_EventNeedsProcessing | ( | void | ) |
Check whether any events on component queues needs processing.
E_MhegErr VQ_GetMsg | ( | S_MhegMessage * | pMsg | ) |
Get an event or section from the component queues. This is a blocking function.
pEvent | Pointer to component event or section data structure. |
U16BIT VQ_GetSizeFree | ( | E_PRIORITY | priority | ) |
Get size available on a queue.
pEvent | Pointer to component event or section data structure. |
E_MhegErr VQ_Open | ( | S_MhegConfig * | cfg_params | ) |
Initialise component control and section queues. Allocates memory for, sets up and creates event (component control) and section queues.
num_section_buffers | Maximum number of sections in queue |
E_MhegErr VQ_PutMsg | ( | S_MhegMessage * | pMsg, |
E_PRIORITY | priority | ||
) |
Post an event or section into component queues. Copies data into queue.
Post event or section message on queue. Copies data into queue.
pEvent | Pointer to component event. |
msg_size | data size excluding size of S_MhegMessage |
void* VQ_RegisterNotify | ( | F_QueueNotify | normal_rcvd, |
F_QueueNotify | critical_rcvd, | ||
F_QueueNotify | critical_done | ||
) |
critical_rcvd | Pointer to function signalling a critical event |
critical_done | Pointer to function inform critical event done |
void VQ_UnRegisterNotify | ( | void * | qn | ) |
normal_rcvd | Pointer to function signalling an async event |