/*****************************************************************************
* Product: Deferred Event state pattern example
* Last updated for version 5.4.0
* Last updated on 2015-03-25
*
* Q u a n t u m L e a P s
* ---------------------------
* innovating embedded systems
*
* Copyright (C) Quantum Leaps, www.state-machine.com.
*
* This program is open source software: you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alternatively, this program may be distributed and modified under the
* terms of Quantum Leaps commercial licenses, which expressly supersede
* the GNU General Public License and are specifically designed for
* licensees interested in retaining the proprietary status of their code.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*
* Contact information:
* Web: www.state-machine.com
* Email: info@state-machine.com
*****************************************************************************/
#include "qpc.h"
#include "bsp.h"
#include /* this example uses printf() to report status */
Q_DEFINE_THIS_FILE
/*..........................................................................*/
enum TServerSignals {
NEW_REQUEST_SIG = Q_USER_SIG, /* the new request signal */
RECEIVED_SIG, /* the request has been received */
AUTHORIZED_SIG, /* the request has been authorized */
TERMINATE_SIG /* terminate the application */
};
/*..........................................................................*/
typedef struct RequestEvtTag {
QEvt super; /* derive from QEvt */
uint8_t ref_num; /* reference number of the request */
} RequestEvt;
/*..........................................................................*/
typedef struct TServerTag { /* Transaction Server active object */
QActive super; /* derive from QActive */
QEQueue requestQueue; /* native QF queue for deferred request events */
QEvt const *requestQSto[3]; /* storage for deferred queue buffer */
QTimeEvt receivedEvt; /* private time event generator */
QTimeEvt authorizedEvt; /* private time event generator */
} TServer;
void TServer_ctor(TServer * const me); /* the default ctor */
/* hierarchical state machine ... */
static QState TServer_initial (TServer * const me, QEvt const * const e);
static QState TServer_idle (TServer * const me, QEvt const * const e);
static QState TServer_busy (TServer * const me, QEvt const * const e);
static QState TServer_receiving (TServer * const me, QEvt const * const e);
static QState TServer_authorizing(TServer * const me, QEvt const * const e);
static QState TServer_final (TServer * const me, QEvt const * const e);
/*..........................................................................*/
void TServer_ctor(TServer * const me) { /* the default ctor */
QActive_ctor(&me->super, Q_STATE_CAST(&TServer_initial));
QEQueue_init(&me->requestQueue,
me->requestQSto, Q_DIM(me->requestQSto));
QTimeEvt_ctor(&me->receivedEvt, RECEIVED_SIG);
QTimeEvt_ctor(&me->authorizedEvt, AUTHORIZED_SIG);
}
/* HSM definition ----------------------------------------------------------*/
QState TServer_initial(TServer * const me, QEvt const * const e) {
(void)e; /* avoid the compiler warning about unused parameter */
return Q_TRAN(&TServer_idle);
}
/*..........................................................................*/
QState TServer_final(TServer * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case Q_ENTRY_SIG: {
printf("final-ENTRY;\nBye!Bye!\n");
QF_stop(); /* terminate the application */
status = Q_HANDLED();
break;
}
default: {
status = Q_SUPER(&QHsm_top);
break;
}
}
return status;
}
/*..........................................................................*/
QState TServer_idle(TServer * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case Q_ENTRY_SIG: {
printf("idle-ENTRY;\n");
/* recall the request from the requestQueue */
if (QActive_recall((QActive *)me, &me->requestQueue)) {
printf("Request recalled\n");
}
else {
printf("No deferred requests\n");
}
status = Q_HANDLED();
break;
}
case NEW_REQUEST_SIG: {
printf("Processing request #%d\n",
(int)((RequestEvt const *)e)->ref_num);
status = Q_TRAN(&TServer_receiving);
break;
}
case TERMINATE_SIG: {
status = Q_TRAN(&TServer_final);
break;
}
default: {
status = Q_SUPER(&QHsm_top);
break;
}
}
return status;
}
/*..........................................................................*/
QState TServer_busy(TServer * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case NEW_REQUEST_SIG: {
if (QActive_defer((QActive *)me, &me->requestQueue, e)) {
printf("Request #%d deferred;\n",
(int)((RequestEvt const *)e)->ref_num);
}
else {
printf("Request #%d IGNORED;\n",
(int)((RequestEvt const *)e)->ref_num);
/* notify the request sender that his request was denied... */
}
status = Q_HANDLED();
break;
}
case TERMINATE_SIG: {
status = Q_TRAN(&TServer_final);
break;
}
default: {
status = Q_SUPER(&QHsm_top);
break;
}
}
return status;
}
/*..........................................................................*/
QState TServer_receiving(TServer * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case Q_ENTRY_SIG: {
printf("receiving-ENTRY;\n");
/* one-shot timeout in 1 second */
QTimeEvt_postIn(&me->receivedEvt, (QActive *)me,
BSP_TICKS_PER_SEC);
status = Q_HANDLED();
break;
}
case Q_EXIT_SIG: {
QTimeEvt_disarm(&me->receivedEvt);
status = Q_HANDLED();
break;
}
case RECEIVED_SIG: {
status = Q_TRAN(&TServer_authorizing);
break;
}
default: {
status = Q_SUPER(&TServer_busy);
break;
}
}
return status;
}
/*..........................................................................*/
QState TServer_authorizing(TServer * const me, QEvt const * const e) {
QState status;
switch (e->sig) {
case Q_ENTRY_SIG: {
printf("authorizing-ENTRY;\n");
/* one-shot timeout in 2 seconds */
QTimeEvt_postIn(&me->authorizedEvt, (QActive *)me,
2*BSP_TICKS_PER_SEC);
status = Q_HANDLED();
break;
}
case Q_EXIT_SIG: {
QTimeEvt_disarm(&me->authorizedEvt);
status = Q_HANDLED();
break;
}
case AUTHORIZED_SIG: {
status = Q_TRAN(&TServer_idle);
break;
}
default: {
status = Q_SUPER(&TServer_busy);
break;
}
}
return status;
}
// test harness ============================================================*/
// Local-scope objects -------------------------------------------------------
static TServer l_tserver; /* the TServer active object */
static QEvt const *l_tserverQSto[10]; /* Event queue storage for TServer */
static QF_MPOOL_EL(RequestEvt) l_smlPoolSto[20]; /* storage for small pool */
/*..........................................................................*/
int main(int argc, char *argv[]) {
printf("Deferred Event state pattern\nQEP version: %s\nQF version: %s\n"
"Press 'n' to generate a new request\n"
"Press ESC to quit...\n",
QEP_getVersion(), QF_getVersion());
BSP_init(argc, argv); /* initialize the BSP */
QF_init(); /* initialize the framework and the underlying RTOS/OS */
/* publish-subscribe not used, no call to QF_psInit() */
/* initialize event pools... */
QF_poolInit(l_smlPoolSto, sizeof(l_smlPoolSto), sizeof(l_smlPoolSto[0]));
/* start the active objects... */
TServer_ctor(&l_tserver);
QActive_start((QActive *)&l_tserver, 1,
l_tserverQSto, Q_DIM(l_tserverQSto),
(void *)0, 1024, (QEvt *)0);
return QF_run(); /* run the QF application */
}
/*..........................................................................*/
void BSP_onKeyboardInput(uint8_t key) {
switch (key) {
case 'n': { /* 'n': new request? */
static uint8_t reqCtr = 0; /* count the requests */
RequestEvt *e = Q_NEW(RequestEvt, NEW_REQUEST_SIG);
e->ref_num = (++reqCtr); /* set the reference number */
/* post directly to TServer active object */
QACTIVE_POST((QActive *)&l_tserver, (QEvt *)e, (void *)0);
break;
}
case '\33': { /* ESC pressed? */
static QEvt const terminateEvt = { TERMINATE_SIG, 0U, 0U };
QACTIVE_POST((QActive *)&l_tserver, &terminateEvt, (void *)0);
break;
}
}
}