/usr/include/ola/rdm/RDMControllerInterface.h is in libola-dev 0.9.1-1.1.
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 | /*
* 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
*
* RDMControllerInterface.h
* A RDM Controller that sends a single message at a time.
* Copyright (C) 2010 Simon Newton
*/
/**
* @addtogroup rdm_controller
* @{
* @file RDMControllerInterface.h
* @brief Definitions and Interfaces to implement an RDMController that sends a
* single message at a time.
* @}
*/
#ifndef INCLUDE_OLA_RDM_RDMCONTROLLERINTERFACE_H_
#define INCLUDE_OLA_RDM_RDMCONTROLLERINTERFACE_H_
#include <ola/Callback.h>
#include <ola/rdm/RDMCommand.h>
#include <ola/rdm/RDMResponseCodes.h>
#include <ola/rdm/UIDSet.h>
#include <string>
#include <vector>
namespace ola {
namespace rdm {
/**
* This is the type of callback that is run when a request completes or fails.
* For performance reasons we can take either a single use callback or a
* permanent callback.
*
* @param rdm_response_code the status code for the response
* @param RDMResponse a pointer to the response object
* @param vector<string> a list of strings that contain the raw response
* messages (if the device supports this, some don't).
*/
typedef ola::BaseCallback3<void,
rdm_response_code,
const RDMResponse*,
const std::vector<std::string>&> RDMCallback;
/**
* This is the callback used when discovery completes.
*/
typedef ola::BaseCallback1<void, const ola::rdm::UIDSet&> RDMDiscoveryCallback;
/**
* This is a class that can send RDM messages.
*/
class RDMControllerInterface {
public:
RDMControllerInterface() {}
virtual ~RDMControllerInterface() {}
/**
* Assumption: A class that implements this MUST ensure that as time tends
* to infinity, the probably that the callback is run tends to 1. That is,
* there must be no way that a request can be dropped in such a way that
* the callback is never run. Doing so will either block all subsequent
* requests, or leak memory depending on the implementation.
*
* Also the implementor of this class should re-write the transaction #,
* and possibly the UID (changing src UIDs isn't addressed by the RDM
* spec).
*/
virtual void SendRDMRequest(const RDMRequest *request,
RDMCallback *on_complete) = 0;
};
/**
* This is a class that can send RDM messages as well as perform discovery.
* You only need to use this with the QueuingRDMController if discovery can't
* run at the same time as RDM messages are being sent.
*/
class DiscoverableRDMControllerInterface: public RDMControllerInterface {
public:
DiscoverableRDMControllerInterface(): RDMControllerInterface() {}
virtual ~DiscoverableRDMControllerInterface() {}
/**
* These methods trigger RDM discovery. The callback may run immediately.
*/
virtual void RunFullDiscovery(RDMDiscoveryCallback *callback) = 0;
virtual void RunIncrementalDiscovery(RDMDiscoveryCallback *callback) = 0;
};
} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_RDMCONTROLLERINTERFACE_H_
|