worker.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2013 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2012-2016 David Robillard <d@drobilla.net>
 * Copyright (C) 2012-2017 Robin Gareus <robin@gareus.org>
 *
 * This program is free 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 2 of the License, or
 * (at your option) any later version.
 *
 * 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef __ardour_worker_h__
#define __ardour_worker_h__
 
#include <stdint.h>
 
#include "pbd/pthread_utils.h"
#include "pbd/ringbuffer.h"
#include "pbd/semutils.h"
 
#include "ardour/libardour_visibility.h"
 
namespace ARDOUR {
 
class Worker;
 
class LIBARDOUR_API Workee {
public:
        virtual ~Workee() {}
 
        virtual int work(Worker& worker, uint32_t size, const void* data) = 0;
 
        virtual int work_response(uint32_t size, const void* data) = 0;
};
 
class LIBARDOUR_API Worker
{
public:
        Worker(Workee* workee, uint32_t ring_size, bool threaded=true);
        ~Worker();
 
        bool schedule(uint32_t size, const void* data);
 
        bool respond(uint32_t size, const void* data);
 
        void emit_responses();
 
        void set_synchronous(bool synchronous) { _synchronous = synchronous; }
 
private:
        void run();
        bool verify_message_completeness(PBD::RingBuffer<uint8_t>* rb);
 
        Workee*                   _workee;
        PBD::RingBuffer<uint8_t>* _requests;
        PBD::RingBuffer<uint8_t>* _responses;
        uint8_t*                  _response;
        PBD::Semaphore            _sem;
        PBD::Thread*              _thread;
        bool                      _exit;
        bool                      _synchronous;
};
 
} // namespace ARDOUR
 
#endif  /* __ardour_worker_h__ */