Open Lighting Architecture: include/ola/client/CallbackTypes.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
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
24
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
38namespace ola {
39namespace client {
40
46typedef SingleUseCallback2<void, const Result&, const std::vector<OlaPlugin>&>
47 PluginListCallback;
48
54typedef SingleUseCallback2<void, const Result&, const std::string&>
55 PluginDescriptionCallback;
56
62typedef SingleUseCallback2<void, const Result&, const PluginState&>
63 PluginStateCallback;
64
70typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&>
71 DeviceInfoCallback;
72
78typedef SingleUseCallback2<void, const Result&, const std::vector<OlaDevice>&>
79 CandidatePortsCallback;
80
85 typedef SingleUseCallback1<void, const Result&> SetCallback;
86
91 typedef BaseCallback1<void, const Result&> GeneralSetCallback;
92
98typedef SingleUseCallback2<void, const Result&, const std::vector<OlaUniverse>&>
99 UniverseListCallback;
100
106typedef SingleUseCallback2<void, const Result&, const OlaUniverse&>
107 UniverseInfoCallback;
108
114typedef SingleUseCallback2<void, const Result&, const std::string&>
115 ConfigureDeviceCallback;
116
123typedef SingleUseCallback2<void, const Result&, const ola::rdm::UIDSet&>
124 DiscoveryCallback;
125
126
133typedef SingleUseCallback3<void, const Result&, const DMXMetadata&,
134 const DmxBuffer&> DMXCallback;
135
141typedef Callback2<void, const DMXMetadata&, const DmxBuffer&>
142 RepeatableDMXCallback;
143
152typedef SingleUseCallback3<void, const Result&,
153 const RDMMetadata&,
154 const ola::rdm::RDMResponse*> RDMCallback;
155
156
157} // namespace client
158} // namespace ola
159#endif // INCLUDE_OLA_CLIENT_CALLBACKTYPES_H_
Callback.h
ClientTypes.h
Types used as return values from the OLA Client.
DmxBuffer.h
A class used to hold a single universe of DMX data.
RDMCommand.h
Classes that represent RDM commands.
Result.h
The Result object passed to OLA client callbacks.
UIDSet.h
A set of UIDs.
ola::BaseCallback1
The base class for all 1 argument callbacks.
Definition Callback.h:982
ola::Callback2
A 2 argument callback which can be called multiple times.
Definition Callback.h:1895
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
ola::SingleUseCallback1
A 1 argument callback which deletes itself after it's run.
Definition Callback.h:1004
ola::SingleUseCallback2
A 2 argument callback which deletes itself after it's run.
Definition Callback.h:1907
ola::SingleUseCallback3
A 3 argument callback which deletes itself after it's run.
Definition Callback.h:2850
ola::client::Result
Indicates the result of a OLA API call.
Definition Result.h:52
ola::rdm::RDMResponse
An RDM Command that represents responses (GET, SET or DISCOVER).
Definition RDMCommand.h:457
ola::client
OLA C++ API.
ola::client::PluginListCallback
SingleUseCallback2< void, const Result &, const std::vector< OlaPlugin > & > PluginListCallback
Invoked when OlaClient::FetchPluginList() completes.
Definition CallbackTypes.h:47
ola::client::DiscoveryCallback
SingleUseCallback2< void, const Result &, const ola::rdm::UIDSet & > DiscoveryCallback
Invoked when OlaClient::RunDiscovery() completes.
Definition CallbackTypes.h:124
ola::client::UniverseInfoCallback
SingleUseCallback2< void, const Result &, const OlaUniverse & > UniverseInfoCallback
Invoked when OlaClient::FetchUniverseInfo() completes.
Definition CallbackTypes.h:107
ola::client::DeviceInfoCallback
SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > DeviceInfoCallback
Invoked when OlaClient::FetchDeviceInfo() completes.
Definition CallbackTypes.h:71
ola::client::PluginDescriptionCallback
SingleUseCallback2< void, const Result &, const std::string & > PluginDescriptionCallback
Invoked when OlaClient::FetchPluginDescription() completes.
Definition CallbackTypes.h:55
ola::client::RDMCallback
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
ola::client::RepeatableDMXCallback
Callback2< void, const DMXMetadata &, const DmxBuffer & > RepeatableDMXCallback
Called when new DMX data arrives.
Definition CallbackTypes.h:142
ola::client::SetCallback
SingleUseCallback1< void, const Result & > SetCallback
Invoked when an operation completes.
Definition CallbackTypes.h:85
ola::client::UniverseListCallback
SingleUseCallback2< void, const Result &, const std::vector< OlaUniverse > & > UniverseListCallback
Invoked when OlaClient::FetchUniverseList() completes.
Definition CallbackTypes.h:99
ola::client::PluginStateCallback
SingleUseCallback2< void, const Result &, const PluginState & > PluginStateCallback
Invoked when OlaClient::FetchPluginState() completes.
Definition CallbackTypes.h:63
ola::client::CandidatePortsCallback
SingleUseCallback2< void, const Result &, const std::vector< OlaDevice > & > CandidatePortsCallback
Invoked when OlaClient::FetchDeviceInfo() completes.
Definition CallbackTypes.h:79
ola::client::GeneralSetCallback
BaseCallback1< void, const Result & > GeneralSetCallback
Invoked when an operation completes.
Definition CallbackTypes.h:91
ola::client::ConfigureDeviceCallback
SingleUseCallback2< void, const Result &, const std::string & > ConfigureDeviceCallback
Invoked when OlaClient::ConfigureDevice() completes.
Definition CallbackTypes.h:115
ola::client::DMXCallback
SingleUseCallback3< void, const Result &, const DMXMetadata &, const DmxBuffer & > DMXCallback
Called once when OlaClient::FetchDMX() completes.
Definition CallbackTypes.h:134
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
ola::client::DMXMetadata
Metadata that accompanies DMX packets.
Definition ClientTypes.h:311
ola::client::RDMMetadata
Metadata that accompanies RDM Responses.
Definition ClientTypes.h:332