/usr/include/ola/client/ClientWrapper.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 | /*
* 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
*
* ClientWrapper.h
* This provides a helpful wrapper for the OlaClient & OlaCallbackClient
* classes.
* Copyright (C) 2005 Simon Newton
*
* The OlaClientWrapper classes takes care of setting up the socket, select
* server and client for you.
*/
/**
* @file ClientWrapper.h
* @brief Helper classes for managing OLA clients.
*/
#ifndef INCLUDE_OLA_CLIENT_CLIENTWRAPPER_H_
#define INCLUDE_OLA_CLIENT_CLIENTWRAPPER_H_
#include <ola/AutoStart.h>
#include <ola/Callback.h>
#include <ola/client/OlaClient.h>
#include <ola/io/SelectServer.h>
#include <ola/network/SocketAddress.h>
#include <ola/network/TCPSocket.h>
#include <memory>
namespace ola {
namespace client {
/**
* @brief The base Client Wrapper class.
*
* This encapsulates the calls required to setup a connection to olad.
*/
class BaseClientWrapper {
public:
typedef Callback0<void> CloseCallback;
BaseClientWrapper();
virtual ~BaseClientWrapper();
/**
* @brief Set the callback to be run when the client socket is closed.
*
* The default action is to terminate the SelectServer. By setting a callback
* you can override this behavior.
*
* @param callback the Callback to run, ownership is transferred.
*/
void SetCloseCallback(CloseCallback *callback);
/**
* @brief Get the SelectServer used by this client.
* @returns A pointer to a SelectServer, ownership isn't transferred.
*/
ola::io::SelectServer *GetSelectServer() { return &m_ss; }
/**
* @brief Setup the client.
* @returns true on success, false on failure.
*/
bool Setup();
/**
* @brief Reset the connection to the server.
* @returns true if the reset succeeded, false otherwise.
*/
bool Cleanup();
/**
* @brief Called internally when the client socket is closed.
* @internal
*/
void SocketClosed();
protected:
std::auto_ptr<ola::network::TCPSocket> m_socket;
private:
ola::io::SelectServer m_ss;
std::auto_ptr<CloseCallback> m_close_callback;
virtual void CreateClient() = 0;
virtual bool StartupClient() = 0;
virtual void InitSocket() = 0;
};
/**
* @brief A templatized ClientWrapper.
*/
template <typename ClientClass>
class GenericClientWrapper: public BaseClientWrapper {
public:
explicit GenericClientWrapper(bool auto_start = true):
BaseClientWrapper(),
m_auto_start(auto_start) {
}
~GenericClientWrapper() {}
/**
* @brief Return the underlying client object
*/
ClientClass *GetClient() const { return m_client.get(); }
private:
std::auto_ptr<ClientClass> m_client;
bool m_auto_start;
void CreateClient() {
if (!m_client.get()) {
m_client.reset(new ClientClass(m_socket.get()));
}
}
bool StartupClient() {
bool ok = m_client->Setup();
m_client->SetCloseHandler(
ola::NewSingleCallback(static_cast<BaseClientWrapper*>(this),
&BaseClientWrapper::SocketClosed));
return ok;
}
void InitSocket() {
if (m_auto_start) {
m_socket.reset(ola::client::ConnectToServer(OLA_DEFAULT_PORT));
} else {
m_socket.reset(ola::network::TCPSocket::Connect(
ola::network::IPV4SocketAddress(
ola::network::IPV4Address::Loopback(),
OLA_DEFAULT_PORT)));
}
if (m_socket.get()) {
m_socket->SetNoDelay();
}
}
};
/**
* @brief A ClientWrapper that uses the OlaClient.
*/
typedef GenericClientWrapper<OlaClient> OlaClientWrapper;
} // namespace client
} // namespace ola
#endif // INCLUDE_OLA_CLIENT_CLIENTWRAPPER_H_
|