qresponse.h

 
#ifndef QRESPONSE_H
    #define QRESPONSE_H
 
    #include "qtypes.h"
    #include "qstimers.h"
    #include "qioutils.h"
 
    #include <string.h>
 
    #ifdef __cplusplus
    extern "C" {
    #endif
 
    #ifndef Q_RESPONSE_HANDLER
        #define Q_RESPONSE_HANDLER      ( 1 )
    #endif
 
    typedef struct _qResponse_s { // skipcq: CXX-E2000
        struct _qResponse_Private_s { // skipcq: CXX-E2000
            char *pattern2Match;                /*< Points to the storage area provided by the user to hold the match requested response. */
            qSTimer_t timeout;                  /*< The timeout used to wait the requested response. */
            size_t maxStrLength;                /*< The size of the storage area. */
            size_t patternLength;               /*< The length of the current response request.*/
            volatile size_t matchedCount;       /*< To hold the current number of response matches. */
            volatile qBool_t responseReceived;  /*< A flag that indicates when the response matches the request. */
        }
        qPrivate;
    }
    qResponse_t;
 
    qBool_t qResponse_Setup( qResponse_t * const r,
                             char *xLocBuff,
                             const size_t nMax );
 
    qBool_t qResponse_Reset( qResponse_t * const r );
 
    qBool_t qResponse_Received( qResponse_t * const r,
                                const char *pattern,
                                const size_t n );
 
    qBool_t qResponse_ReceivedWithTimeout( qResponse_t * const r,
                                           const char *pattern,
                                           const size_t n,
                                           const qTime_t t );
 
    qBool_t qResponse_ISRHandler( qResponse_t * const r,
                                  const char rxChar );
 
    #ifdef __cplusplus
    }
    #endif
 
#endif