API Reference

Low-Power ExampleDeprecated APIs

Compile-Time Configuration

QP/C++ Framework supports compile-time configuration through the following mechanisms:

• command-line macros
• qp_config.hpp header file
• qp_port.hpp header file
• qs_port.hpp header file

Active Objects

QP/C++ Framework supports Active Objects through the following base classes.

QP::QActive class (derived from QP::QAsm)

• see also QP::QHsm class
• QP::QActive::QActive()
• QP::QActive::start()
• QActive:: POST()
• QActive:: POST_X()
• QP::QActive::post_()
• QP::QActive::postLIFO()
• QP::QActive::defer()
• QP::QActive::recall()
• QP::QActive::flushDeferred()
• QP::QActive::stop()

QP::QMActive class (derived from QP::QActive)

• see also QP::QMsm class
• QP::QMActive::QMActive()

Publish-Subscribe

• QP::QActive::psInit()
• QP::QActive::subscribe()
• QP::QActive::unsubscribe()
• QP::QActive::unsubscribeAll()
• QActive:: PUBLISH()

Events

QP/C++ Framework supports events, through the following bases classes:

QP::QEvt class (see also Event Management and Time Management) QP::QEvt class

• QP::QEvt::QEvt(QSignal) - constexpr constructor for immutable events
• Q_EVT_CAST() - event down-casting

State Machines

QP/C++ Framework supports event-driven, hierarchical state machines through the following bases classes:

QP::QAsm class

• QP::QAsm::QAsm()
• QP::QAsm::init()
• QP::QAsm::dispatch()

QP::QHsm class (derived from QP::QAsm)

• QP::QHsm::QHsm()
• QP::QHsm::init()
• QP::QHsm::dispatch()
• QP::QHsm::isIn()
• QP::QHsm::state()
• QP::QHsm::top()
• Q_STATE_CAST()

QP::QMsm class (derived from QP::QAsm)

• QP::QMsm::QMsm()
• QP::QMsm::isIn()
• QP::QMsm::stateObj()

Mutable Event Management

• QP::QF::poolInit()
• QP::QF::q_new() template
• QP::QF::q_new_x() template
• Q_NEW()
• Q_NEW_X()
• QP::QEvt::init()
• QP::QF::q_new_ref() template
• QP::QF::q_delete_ref() template
• Q_NEW_REF()
• Q_DELETE_REF()
• QP::QF::gc()

QP::QMPool class (memory pool, also used for mutable events)

• QP::QMPool::init()
• QP::QMPool::get()
• QP::QMPool::put()

Time Management

QP::QTimeEvt class (derived from QP::QEvt)

• QP::QTimeEvt::tick()
• QP::QTimeEvt::QTimeEvt()
• QP::QTimeEvt::armX()
• QP::QTimeEvt::disarm()
• QP::QTimeEvt::rearm()
• QP::QTimeEvt::getCtr()

::QTicker active object (derived from ::QTimeEvt)

Event Queues (raw thread-safe)

QP::QEQueue class

• QP::QEQueue::init()
• QP::QEQueue::post()
• QP::QEQueue::postLIFO()
• QP::QEQueue::get()
• QP::QEQueue::getNFree()
• QP::QEQueue::getNMin()
• QP::QEQueue::isEmpty()
• QP::QEQueueCtr()

Software Tracing

QS is a software tracing system that enables developers to monitor live event-driven QP applications with minimal target system resources and without stopping or significantly slowing down the code. QS is an ideal tool for testing, troubleshooting, and optimizing QP applications. QS can even be used to support acceptance testing in product manufacturing.

QS-Transmit (QS-TX)

• QS_INIT()
• QP::QS::initBuf()
• QP::QS::getByte()
• QP::QS::getBlock()
• QP::QS::onStartup()
• QP::QS::onCleanup()
• QP::QS::onFlush()
• QP::QS::onGetTime()

QS Filters

• QS_GLB_FILTER()
• QS_LOC_FILTER()
• QS_FILTER_AP_OBJ()

QS Dictionaries

• QS_SIG_DICTIONARY()
• QS_OBJ_DICTIONARY()
• QS_OBJ_ARR_DICTIONARY()
• QS_FUN_DICTIONARY()
• QS_USR_DICTIONARY()
• QS_ENUM_DICTIONARY()

QS Application-Specific Records

• QS_BEGIN_ID()
• QS_END()
• QS_U8() / QS_I8()
• QS_U16() / QS_I16()
• QS_U32() / QS_I32()
• QS_ENUM()
• QS_STR()
• QS_MEM()
• QP::QS_USER enumeration

QS Receive-Channel (QS-RX)

• QP::QS::rxInitBuf()
• QP::QS::rxPut()
• QP::QS::rxParse()
• QP::QS::onCommand()

QV (Non-preemptive Kernel)

QV is a simple non-preemptive kernel, which executes Active Objects one at a time, with priority-based scheduling performed before processing of each event. Due to naturally short duration of event processing in state machines, the simple QV kernel is often adequate for many real-time systems.

Kernel Initialization and Control

• QF_run()
• QP::QV::schedDisable()
• QP::QV::schedEnable()
• QP::QV::onIdle()
• QV_CPU_SLEEP()

QK (Preemptive RTC Kernel)

QK is a lightweight preemptive, priority-based, run-to-completion (RTC) kernel designed specifically for executing event-driven active objects.

Kernel Initialization and Control

• QF_run()
• QP::QK::schedLock()
• QP::QK::schedUnlock()
• QP::QK::onIdle()

QK Interrupt Management

• QK_ISR_ENTRY()
• QK_ISR_EXIT()

QXK (Dual-Mode Kernel)

QXK is a lightweight, preemptive, priority-based, dual-mode (run-to-completion/blocking) kernel that executes active objects like the QK kernel, but can also execute traditional blocking threads (extended threads). In this respect, QXK behaves exactly as a conventional RTOS (Real-Time Operating System). QXK has been designed specifically for mixing event-driven active objects with traditional blocking code, such as commercial middleware (TCP/IP stacks, UDP stacks, embedded file systems, etc.) or legacy software.

Kernel Initialization and Control

• QF_run()
• QP::QXK::onIdle()
• QP::QXK::schedLock()
• QP::QXK::schedUnlock()
• QP::QXK::current()

QXK Interrupt Management

• QXK_ISR_ENTRY()
• QXK_ISR_EXIT()

::QXThread class

• QP::QXThread class
• QP::QXThread::QXThread()
• QP::QXThread::start()
• QP::QXThread::delay()
• QP::QXThread::delayCancel()
• QP::QXThread::queueGet()

QXThread Message Queues

• QXThread:: POST()
• QXThread:: POST_X()
• QP::QXThread::queueGet() - waiting (blocking) on message queue

::QXSemaphore class

• QP::QXSemaphore class (Semaphore Control Block)
• QP::QXSemaphore::init()
• QP::QXSemaphore::wait()
• QP::QXSemaphore::tryWait()
• QP::QXSemaphore::signal()

::QXMutex class

• QP::QXMutex class (Mutex Control Block)
• QP::QXMutex::init()
• QP::QXMutex::lock()
• QP::QXMutex::tryLock()
• QP::QXMutex::unlock()

::QMPool class

• QP::QMPool class
• QP::QMPool:init()
• QP::QMPool::get()
• QP::QMPool::put()

Low-Power ExampleDeprecated APIs