/usr/include/ola/rdm/RDMControllerInterface.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 118 119 120 121 122 123 124 125 126 | /*
* 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/RDMReply.h>
#include <ola/rdm/RDMResponseCodes.h>
#include <ola/rdm/UIDSet.h>
namespace ola {
namespace rdm {
/**
* @brief The callback run when a RDM request completes.
* @tparam reply The RDMReply object. The reply object is valid for the
* duration of the call.
*
* The RDMReply is not const, since some stages of the pipeline may need to
* rewrite the UID / Transaction Number.
*
* For performance reasons this can be either a single use callback or a
* permanent callback.
*/
typedef ola::BaseCallback1<void, RDMReply*> RDMCallback;
/**
* @brief A helper message to run a RDMCallback with the given status code.
* @param callback The RDMCallback to run.
* @param status_code The status code to use in the RDMReply.
*/
inline void RunRDMCallback(RDMCallback *callback, RDMStatusCode status_code) {
ola::rdm::RDMReply reply(status_code);
callback->Run(&reply);
}
/**
* @brief The callback run when a discovery operation completes.
* @tparam UIDSet The UIDs that were discovered.
*/
typedef ola::BaseCallback1<void, const ola::rdm::UIDSet&> RDMDiscoveryCallback;
/**
* @brief The interface that can send RDMRequest.
*/
class RDMControllerInterface {
public:
virtual ~RDMControllerInterface() {}
/**
* @brief Send a RDM command.
* @param request the RDMRequest, ownership is transferred.
* @param on_complete The callback to run when the request completes.
*
* Implementors much ensure that the callback is always run at some point.
* In other words, 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 may want to re-write the transaction #,
* and possibly the UID (changing src UIDs isn't addressed by the RDM
* spec).
*
* The RDMRequest may be a DISCOVERY_COMMAND, if the implementation does not
* support DISCOVERY_COMMANDs then the callback should be run with
* ola::rdm::RDM_PLUGIN_DISCOVERY_NOT_SUPPORTED.
*/
virtual void SendRDMRequest(RDMRequest *request,
RDMCallback *on_complete) = 0;
};
/**
* @brief The interface that can send RDM commands, as well as perform discovery
* operations.
*/
class DiscoverableRDMControllerInterface: public RDMControllerInterface {
public:
DiscoverableRDMControllerInterface(): RDMControllerInterface() {}
virtual ~DiscoverableRDMControllerInterface() {}
/**
* @brief Start a full discovery operation.
* @param callback The callback run when discovery completes. This may run
* immediately in some implementations.
*/
virtual void RunFullDiscovery(RDMDiscoveryCallback *callback) = 0;
/**
* @brief Start an incremental discovery operation.
* @param callback The callback run when discovery completes. This may run
* immediately in some implementations.
*/
virtual void RunIncrementalDiscovery(RDMDiscoveryCallback *callback) = 0;
};
} // namespace rdm
} // namespace ola
#endif // INCLUDE_OLA_RDM_RDMCONTROLLERINTERFACE_H_
|