Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
CallbackTypes.h
Go to the documentation of this file.
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * CallbackTypes.h
17  * Copyright (C) 2013 Simon Newton
18  */
19 
25 #ifndef INCLUDE_OLA_CLIENT_CALLBACKTYPES_H_
26 #define INCLUDE_OLA_CLIENT_CALLBACKTYPES_H_
27 
28 #include <ola/Callback.h>
29 #include <ola/DmxBuffer.h>
30 #include <ola/client/ClientTypes.h>
31 #include <ola/client/Result.h>
32 #include <ola/rdm/RDMCommand.h>
33 #include <ola/rdm/UIDSet.h>
34 
35 #include <string>
36 #include <vector>
37 
38 namespace ola {
39 namespace client {
40 
46 typedef SingleUseCallback2<void, const Result&, const std::vector<OlaPlugin>&>
48 
56 
64 
72 
80 
86 
92 
100 
108 
116 
125 
126 
133 typedef SingleUseCallback3<void, const Result&, const DMXMetadata&,
135 
143 
152 typedef SingleUseCallback3<void, const Result&,
153  const RDMMetadata&,
155 
156 
157 } // namespace client
158 } // namespace ola
159 #endif // INCLUDE_OLA_CLIENT_CALLBACKTYPES_H_
SingleUseCallback3< void, const Result &, const DMXMetadata &, const DmxBuffer & > DMXCallback
Called once when OlaClient::FetchDMX() completes.
Definition: CallbackTypes.h:134
An RDM Command that represents responses (GET, SET or DISCOVER).
Definition: RDMCommand.h:457
Metadata that accompanies RDM Responses.
Definition: ClientTypes.h:332
Types used as return values from the OLA Client.
SingleUseCallback2< void, const Result &, const PluginState & > PluginStateCallback
Invoked when OlaClient::FetchPluginState() completes.
Definition: CallbackTypes.h:63
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
SingleUseCallback2< void, const Result &, const std::vector< OlaPlugin > & > PluginListCallback
Invoked when OlaClient::FetchPluginList() completes.
Definition: CallbackTypes.h:47
The Result object passed to OLA client callbacks.
Callback2< void, const DMXMetadata &, const DmxBuffer & > RepeatableDMXCallback
Called when new DMX data arrives.
Definition: CallbackTypes.h:142
A set of UIDs.
SingleUseCallback3< void, const Result &, const RDMMetadata &, const ola::rdm::RDMResponse * > RDMCallback
Called when a RDM request completes. Used with OlaClient::RDMGet() and OlaClient::RDMSet().
Definition: CallbackTypes.h:154
A class used to hold a single universe of DMX data.
BaseCallback1< void, const Result & > GeneralSetCallback
Invoked when an operation completes.
Definition: CallbackTypes.h:91
Indicates the result of a OLA API call.
Definition: Result.h:52
SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > CandidatePortsCallback
Invoked when OlaClient::FetchDeviceInfo() completes.
Definition: CallbackTypes.h:79
SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > DeviceInfoCallback
Invoked when OlaClient::FetchDeviceInfo() completes.
Definition: CallbackTypes.h:71
The base class for all 1 argument callbacks.
Definition: Callback.h:982
SingleUseCallback1< void, const Result & > SetCallback
Invoked when an operation completes.
Definition: CallbackTypes.h:85
A 2 argument callback which can be called multiple times.
Definition: Callback.h:1895
A 1 argument callback which deletes itself after it's run.
Definition: Callback.h:1004
A 3 argument callback which deletes itself after it's run.
Definition: Callback.h:2850
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
SingleUseCallback2< void, const Result &, const OlaUniverse & > UniverseInfoCallback
Invoked when OlaClient::FetchUniverseInfo() completes.
Definition: CallbackTypes.h:107
Metadata that accompanies DMX packets.
Definition: ClientTypes.h:311
SingleUseCallback2< void, const Result &, const ola::rdm::UIDSet & > DiscoveryCallback
Invoked when OlaClient::RunDiscovery() completes.
Definition: CallbackTypes.h:124
SingleUseCallback2< void, const Result &, const std::vector< OlaUniverse > & > UniverseListCallback
Invoked when OlaClient::FetchUniverseList() completes.
Definition: CallbackTypes.h:99
A 2 argument callback which deletes itself after it's run.
Definition: Callback.h:1907
SingleUseCallback2< void, const Result &, const std::string & > ConfigureDeviceCallback
Invoked when OlaClient::ConfigureDevice() completes.
Definition: CallbackTypes.h:115
SingleUseCallback2< void, const Result &, const std::string & > PluginDescriptionCallback
Invoked when OlaClient::FetchPluginDescription() completes.
Definition: CallbackTypes.h:55
Classes that represent RDM commands.