/usr/include/ola/client/StreamingClient.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 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | /*
* 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
*
* StreamingClient.h
* Interface to the Streaming Client class.
* Copyright (C) 2005 Simon Newton
*/
/**
* @file
* @brief A client for sending DMX512 data to olad.
*/
#ifndef INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_
#define INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_
#include <ola/Constants.h>
#include <ola/DmxBuffer.h>
#include <ola/base/Macro.h>
#include <ola/dmx/SourcePriorities.h>
namespace ola {
namespace io { class SelectServer; }
namespace network { class TCPSocket; }
namespace proto { class OlaServerService_Stub; }
namespace rpc {
class RpcChannel;
class RpcSession;
}
namespace client {
/**
* @class StreamingClientInterface ola/client/StreamingClient.h
* @brief The interface for the StreamingClient class.
*/
class StreamingClientInterface {
public:
/**
* The arguments for the SendDmx method
*/
class SendArgs {
public:
/**
* @brief the priority of the data.
* This should be between ola::dmx::SOURCE_PRIORITY_MIN and
* ola::dmx::SOURCE_PRIORITY_MAX.
*/
uint8_t priority;
SendArgs() : priority(ola::dmx::SOURCE_PRIORITY_DEFAULT) {}
};
virtual ~StreamingClientInterface() {}
virtual bool Setup() = 0;
virtual void Stop() = 0;
virtual bool SendDmx(unsigned int universe, const DmxBuffer &data) = 0;
virtual bool SendDMX(unsigned int universe,
const DmxBuffer &data,
const SendArgs &args) = 0;
};
/**
* @class StreamingClient ola/client/StreamingClient.h
* @brief Send DMX512 data to olad.
*
* StreamingClient sends DMX512 data to OLAD without waiting for an
* acknowledgement. It's best suited to simple clients which only ever send
* DMX512 data.
*
* @snippet streaming_client.cpp Tutorial Example
*/
class StreamingClient : public StreamingClientInterface {
public:
/**
* Controls the options for the StreamingClient class.
*/
class Options {
public:
/**
* Create a new options structure with the default options. This
* includes automatically starting olad if it's not already running.
*/
Options() : auto_start(true), server_port(OLA_DEFAULT_PORT) {}
/**
* If true, the client will automatically start olad if it's not
* already running.
*/
bool auto_start;
/**
* The RPC port olad is listening on.
*/
uint16_t server_port;
};
/**
* Create a new StreamingClient.
* @param auto_start if set to true, this will automatically start olad if
* it's not already running.
* @deprecated Use the constructor that takes an Options struct instead.
*/
explicit StreamingClient(bool auto_start = true);
/**
* Create a new StreamingClient.
* @param options an Options structure.
*/
explicit StreamingClient(const Options &options);
/**
* Destructor. This closes the connection to the olad server if it's still
* open.
*/
~StreamingClient();
/**
* Initialize the client and connect to olad.
* @returns true if the initialization completed sucessfully, false if
* there was a failure.
*/
bool Setup();
/**
* Close the connection to the olad server. This does not need to be called
* since ~StreamingClient() will close the connection if it's still open
* when the object is destroyed.
*/
void Stop();
/**
* Send a DmxBuffer to the olad server.
* @param universe the universe to send on.
* @param data the DMX512 data.
* @returns true if sent sucessfully, false if the connection to the server
* has been closed.
*/
bool SendDmx(unsigned int universe, const DmxBuffer &data);
/**
* @brief Send DMX data.
* @param universe the universe to send to.
* @param data the DmxBuffer with the data
* @param args the SendDMXArgs to use for this call.
*/
bool SendDMX(unsigned int universe,
const DmxBuffer &data,
const SendArgs &args);
void ChannelClosed(ola::rpc::RpcSession *session);
private:
bool m_auto_start;
uint16_t m_server_port;
ola::network::TCPSocket *m_socket;
ola::io::SelectServer *m_ss;
class ola::rpc::RpcChannel *m_channel;
class ola::proto::OlaServerService_Stub *m_stub;
bool m_socket_closed;
bool Send(unsigned int universe, uint8_t priority, const DmxBuffer &data);
DISALLOW_COPY_AND_ASSIGN(StreamingClient);
};
} // namespace client
} // namespace ola
#endif // INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_
|