/usr/include/ola/client/ClientArgs.h is in libola-dev 0.10.5.nojsmin-3.
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 | /*
* 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
*
* ClientArgs.h
* Types used as arguments to the OLA Client.
* Copyright (C) 2013 Simon Newton
*/
#ifndef INCLUDE_OLA_CLIENT_CLIENTARGS_H_
#define INCLUDE_OLA_CLIENT_CLIENTARGS_H_
#include <ola/client/CallbackTypes.h>
#include <ola/dmx/SourcePriorities.h>
/**
* @file
* @brief Types used as arguments for the OLA Client.
*/
namespace ola {
namespace client {
/**
* @brief The patch action, used with OlaClient::Patch()
*/
enum PatchAction {
PATCH, /**< Patch the port. */
UNPATCH, /**< Unpatch the port */
};
/**
* @brief The register action, used with OlaClient::RegisterUniverse()
*/
enum RegisterAction {
REGISTER, /**< Register for the universe */
UNREGISTER, /**< Unregister from the universe */
};
/**
* @brief The port direction.
*/
enum PortDirection {
INPUT_PORT, /**< An input port which receives DMX data */
OUTPUT_PORT, /**< An output port which sends DMX data */
};
/**
* @brief The type of discovery to run with OlaClient::RunDiscovery().
*/
enum DiscoveryType {
DISCOVERY_CACHED, /**< Fetch the cached list of UIDs */
DISCOVERY_INCREMENTAL, /**< Trigger incremental discovery */
DISCOVERY_FULL, /**< Trigger full discovery */
};
/**
* @brief Arguments passed to the SendDMX() method.
*/
struct SendDMXArgs {
/**
* @brief The priority of the data, defaults to
* ola::dmx::PRIORITY_DEFAULT.
*/
uint8_t priority;
/**
* @brief the Callback to run upon completion. Defaults to NULL.
*/
GeneralSetCallback *callback;
/**
* @brief Create a new SendDMXArgs object
*/
SendDMXArgs()
: priority(ola::dmx::SOURCE_PRIORITY_DEFAULT),
callback(NULL) {
}
/**
* @brief Create a new SendDMXArgs object
*/
explicit SendDMXArgs(GeneralSetCallback *_callback)
: priority(ola::dmx::SOURCE_PRIORITY_DEFAULT),
callback(_callback) {
}
};
/**
* @brief Arguments used with OlaClient::RDMGet() and OlaClient::RDMSet()
* methods.
*/
struct SendRDMArgs {
/**
* The callback to run when the request completes
*/
RDMCallback *callback;
/**
* @brief Set to true to include frame & timing information in the response.
*/
bool include_raw_frames;
explicit SendRDMArgs(RDMCallback *_callback)
: callback(_callback),
include_raw_frames(false) {
}
};
} // namespace client
} // namespace ola
#endif // INCLUDE_OLA_CLIENT_CLIENTARGS_H_
|