RequestQueue.h

// Copyright (c) 2013 by István Váradi
 
// This file is part of XPLRA, a remote-access plugin for X-Plane
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
#ifndef XPLRA_REQUESTQUEUE_H
#define XPLRA_REQUESTQUEUE_H
//------------------------------------------------------------------------------
 
#include <hu/varadiistvan/scpl/Mutex.h>
#include <hu/varadiistvan/scpl/CondVar.h>
 
#include <XPLMProcessing.h>
 
#include <vector>
 
//------------------------------------------------------------------------------
 
// Define to 1, if the new XPLMScheduleFlightLoop function should be
// used to schedule the flight loop only on-demand
#define USE_SCHEDULE_FLIGHTLOOP 0
 
//------------------------------------------------------------------------------
 
namespace xplra {
 
//------------------------------------------------------------------------------
 
class Request;
 
//------------------------------------------------------------------------------
 
class RequestQueue
{
private:
    typedef std::vector<Request*> requests_t;
 
#if !USE_SCHEDULE_FLIGHTLOOP
    static constexpr float flightLoopInterval = 0.1;
#endif
 
    static float flightLoop(float inElapsedSinceLastCall,
                            float inElapsedTimeSinceLastFlightLoop,
                            int inCounter, void* inRefCon);
 
#if USE_SCHEDULE_FLIGHTLOOP
    XPLMFlightLoopID flightLoopID;
#endif
 
    hu::varadiistvan::scpl::Mutex mutex;
 
    hu::varadiistvan::scpl::CondVar requestsDone;
 
    volatile bool enabled;
 
    requests_t requests;
 
public:
    RequestQueue();
 
    bool execute(Request* request);
 
    void disable();
 
private:
    void run();
};
 
//------------------------------------------------------------------------------
 
} /* namespace xplra */
 
//------------------------------------------------------------------------------
#endif // XPLRA_REQUESTQUEUE_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: