/usr/include/ola/rdm/QueueingRDMController.h is in libola-dev 0.10.3.nojsmin-2+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | /*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* QueueingRDMController.h
* A RDM Controller that sends a single message at a time.
* Copyright (C) 2010 Simon Newton
*/
/**
* @addtogroup rdm_controller
* @{
* @file QueueingRDMController.h
* @brief An RDM Controller that queues messages and only sends a single message
* at a time.
* @}
*/
#ifndef INCLUDE_OLA_RDM_QUEUEINGRDMCONTROLLER_H_
#define INCLUDE_OLA_RDM_QUEUEINGRDMCONTROLLER_H_
#include <ola/rdm/RDMControllerInterface.h>
#include <queue>
#include <string>
#include <utility>
#include <vector>
namespace ola {
namespace rdm {
/*
* A RDM controller that only sends a single request at a time. This also
* handles timing out messages that we don't get a response for.
*/
class QueueingRDMController: public RDMControllerInterface {
public:
QueueingRDMController(RDMControllerInterface *controller,
unsigned int max_queue_size);
~QueueingRDMController();
void Pause();
void Resume();
// This can be called multiple times and the requests will be queued.
void SendRDMRequest(RDMRequest *request, RDMCallback *on_complete);
protected:
typedef struct {
const RDMRequest *request;
RDMCallback *on_complete;
} outstanding_rdm_request;
RDMControllerInterface *m_controller;
unsigned int m_max_queue_size;
std::queue<outstanding_rdm_request> m_pending_requests;
bool m_rdm_request_pending; // true if a request is in progress
bool m_active; // true if the controller is active
std::auto_ptr<RDMCallback> m_callback;
std::auto_ptr<ola::rdm::RDMResponse> m_response;
std::vector<RDMFrame> m_frames;
virtual void TakeNextAction();
virtual bool CheckForBlockingCondition();
void MaybeSendRDMRequest();
void DispatchNextRequest();
void HandleRDMResponse(RDMReply *reply);
void RunCallback(RDMReply *reply);
};
/**
* The DiscoverableQueueingRDMController also handles discovery, and ensures
* that only a single discovery or RDM request sequence occurs at once.
*
* In this model, discovery has a higher precedence than RDM messages.
*/
class DiscoverableQueueingRDMController: public QueueingRDMController {
public:
DiscoverableQueueingRDMController(
DiscoverableRDMControllerInterface *controller,
unsigned int max_queue_size);
~DiscoverableQueueingRDMController() {}
// These can be called multiple times and the requests will be queued
void RunFullDiscovery(RDMDiscoveryCallback *callback);
void RunIncrementalDiscovery(RDMDiscoveryCallback *callback);
private:
typedef std::vector<RDMDiscoveryCallback*> DiscoveryCallbacks;
typedef std::vector<std::pair<bool, RDMDiscoveryCallback*> >
PendingDiscoveryCallbacks;
DiscoverableRDMControllerInterface *m_discoverable_controller;
DiscoveryCallbacks m_discovery_callbacks;
PendingDiscoveryCallbacks m_pending_discovery_callbacks;
void TakeNextAction();
bool CheckForBlockingCondition();
void GenericDiscovery(RDMDiscoveryCallback *callback, bool full);
void StartRDMDiscovery();
void DiscoveryComplete(const ola::rdm::UIDSet &uids);
};
} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_QUEUEINGRDMCONTROLLER_H_
|