QP/C 6.8.1
Macros | Functions
qf_actq.c File Reference
QF

QActive native queue operations (based on QEQueue) More...

#include "qf_port.h"
#include "qf_pkg.h"
#include "qassert.h"
#include "qs_port.h"
#include "qs_pkg.h"
Include dependency graph for qf_actq.c:

Go to the source code of this file.

Macros

#define QTICKER_CAST_(me_)   ((QTicker *)(me_))
 Perform downcast to QTicker pointer. More...
 

Functions

bool QActive_post_ (QActive *const me, QEvt const *const e, uint_fast16_t const margin, void const *const sender)
 Implementation of the active object post (FIFO) operation. More...
 
void QActive_postLIFO_ (QActive *const me, QEvt const *const e)
 Implementation of the active object post LIFO operation. More...
 
QEvt const * QActive_get_ (QActive *const me)
 Get an event from the event queue of an active object. More...
 
uint_fast16_t QF_getQueueMin (uint_fast8_t const prio)
 This function returns the minimum of free entries of the given event queue. More...
 
static void QTicker_init_ (QHsm *const me, void const *par)
 
static void QTicker_dispatch_ (QHsm *const me, QEvt const *const e)
 
static bool QTicker_post_ (QActive *const me, QEvt const *const e, uint_fast16_t const margin, void const *const sender)
 virtual function to asynchronously post (FIFO) an event to an AO More...
 
static void QTicker_postLIFO_ (QActive *const me, QEvt const *const e)
 
void QTicker_ctor (QTicker *const me, uint8_t tickRate)
 "constructor" of QTicker More...
 

Detailed Description

QActive native queue operations (based on QEQueue)

Note
this source file is only included in the application build when the native QF active object queue is used (instead of a message queue of an RTOS).

Definition in file qf_actq.c.

Macro Definition Documentation

◆ QTICKER_CAST_

#define QTICKER_CAST_ (   me_)    ((QTicker *)(me_))

Perform downcast to QTicker pointer.

Description
This macro encapsulates the downcast to (QTicker *), which is used in QTicker_init_() and QTicker_dispatch_(). Such casts can trigger PC-Lint "Note 929: cast from pointer to pointer [MISRA-04 Rule 11.4, advisory]" and this macro helps to encapsulate this deviation.

Definition at line 436 of file qf_actq.c.

Function Documentation

◆ QActive_post_()

bool QActive_post_ ( QActive *const  me,
QEvt const *const  e,
uint_fast16_t const  margin,
void const *const  sender 
)

Implementation of the active object post (FIFO) operation.

Description
Direct event posting is the simplest asynchronous communication method available in QF.
Parameters
[in,out]mepointer (see Object Orientation)
[in]epointer to the event to be posted
[in]marginnumber of required free slots in the queue after posting the event. The special value QF_NO_MARGIN means that this function will assert if posting fails.
Returns
'true' (success) if the posting succeeded (with the provided margin) and 'false' (failure) when the posting fails.
Attention
This function should be called only via the macro QACTIVE_POST() or QACTIVE_POST_X().
Note
The QF_NO_MARGIN value of the margin parameter is special and denotes situation when the post() operation is assumed to succeed (event delivery guarantee). An assertion fires, when the event cannot be delivered in this case.
Usage
extern QActive *AO_Table;
QState Philoso_hungry(Philo * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case Q_ENTRY_SIG: {
TableEvt *pe = Q_NEW(TableEvt, HUNGRY_SIG); /* dynamic alloc */
pe->philNum = me->num;
QACTIVE_POST(AO_Table, &pe->super, me); /* direct posting */
status = Q_HANDLED();
break;
}
. . .
default: {
status = Q_SUPER(&QHsm_top);
break;
}
}
return status;
}
See also
QActive_post_(), QActive_postLIFO()
Precondition
event pointer must be valid

Definition at line 94 of file qf_actq.c.

◆ QActive_postLIFO_()

void QActive_postLIFO_ ( QActive *const  me,
QEvt const *const  e 
)

Implementation of the active object post LIFO operation.

Description
posts an event to the event queue of the active object me using the Last-In-First-Out (LIFO) policy.
Note
The LIFO policy should be used only for self-posting and with caution, because it alters order of events in the queue.
Parameters
[in]mepointer (see Object Orientation)
[ine pointer to the event to post to the queue
Attention
This function should be called only via the macro QACTIVE_POST_LIFO().
See also
QActive_post_(), QACTIVE_POST(), QACTIVE_POST_X()

Definition at line 238 of file qf_actq.c.

◆ QActive_get_()

QEvt const* QActive_get_ ( QActive *const  me)

Get an event from the event queue of an active object.

Description
The behavior of this function depends on the kernel/OS used in the QF port. For built-in kernels (QV or QK) the function can be called only when the queue is not empty, so it doesn't block. For a blocking kernel/OS the function can block and wait for delivery of an event.
Parameters
[in,out]mepointer (see Object Orientation)
Returns
a pointer to the received event. The returned pointer is guaranteed to be valid (can't be NULL).
Note
This function is used internally by a QF port to extract events from the event queue of an active object. This function depends on the event queue implementation and is sometimes customized in the QF port (file qf_port.h). Depending on the definition of the macro QACTIVE_EQUEUE_WAIT_(), the function might block the calling thread when no events are available.

Definition at line 331 of file qf_actq.c.

◆ QF_getQueueMin()

uint_fast16_t QF_getQueueMin ( uint_fast8_t const  prio)

This function returns the minimum of free entries of the given event queue.

Description
Queries the minimum of free ever present in the given event queue of an active object with priority prio, since the active object was started.
Note
This function is available only when the native QF event queue implementation is used. Requesting the queue minimum of an unused priority level raises an assertion in the QF. (A priority level becomes used in QF after the call to the QF_add_() function.)
Parameters
[in]prioPriority of the active object, whose queue is queried
Returns
the minimum of free ever present in the given event queue of an active object with priority prio, since the active object was started.

Definition at line 398 of file qf_actq.c.

◆ QTicker_init_()

static void QTicker_init_ ( QHsm *const  me,
void const *  par 
)
static

Definition at line 454 of file qf_actq.c.

◆ QTicker_dispatch_()

static void QTicker_dispatch_ ( QHsm *const  me,
QEvt const *const  e 
)
static

Definition at line 460 of file qf_actq.c.

◆ QTicker_post_()

static bool QTicker_post_ ( QActive *const  me,
QEvt const *const  e,
uint_fast16_t const  margin,
void const *const  sender 
)
static

virtual function to asynchronously post (FIFO) an event to an AO

Definition at line 480 of file qf_actq.c.

◆ QTicker_postLIFO_()

static void QTicker_postLIFO_ ( QActive *const  me,
QEvt const *const  e 
)
static

Definition at line 518 of file qf_actq.c.

◆ QTicker_ctor()

void QTicker_ctor ( QTicker *const  me,
uint8_t  tickRate 
)

"constructor" of QTicker

Constructor of the QTicker Active Object class.

Definition at line 439 of file qf_actq.c.

QEvt::sig
QSignal sig
signal of the event instance
Definition: qep.h:152
Q_HANDLED
#define Q_HANDLED()
Macro to call in a state-handler when it handles an event.
Definition: qep.h:519
QActive
Active Object base class (based on QHsm implementation)
Definition: qf.h:116
Q_ENTRY_SIG
@ Q_ENTRY_SIG
signal for coding entry actions
Definition: qep.h:655
QState
uint_fast8_t QState
typedef of the return type from a state/action-handler function.
Definition: qep.h:204
QEvt
Event class.
Definition: qep.h:151
QHsm::QHsm_top
QState QHsm_top(void const *const me, QEvt const *const e)
the top-state.
Definition: qep_hsm.c:233
Q_NEW
#define Q_NEW(evtT_, sig_)
Allocate a dynamic event.
Definition: qf.h:756
Q_SUPER
#define Q_SUPER(super_)
Macro to call in a state-handler when it designates the superstate of a given state.
Definition: qep.h:513
QActive::QACTIVE_POST
#define QACTIVE_POST(me_, e_, sender_)
Polymorphically posts an event to an active object (FIFO) with delivery guarantee.
Definition: qf.h:251