117 lines
3.6 KiB
C++
117 lines
3.6 KiB
C++
/*
|
|
* This file is part of the Flowee project
|
|
* Copyright (C) 2019-2021 Tom Zander <tom@flowee.org>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#ifndef NETWORKSERVICE_H
|
|
#define NETWORKSERVICE_H
|
|
|
|
#include "NetworkConnection.h"
|
|
#include "NetworkServiceBase.h"
|
|
#include <streaming/BufferPool.h>
|
|
|
|
#include <deque>
|
|
#include <mutex>
|
|
|
|
class RemoteContainer;
|
|
|
|
/**
|
|
* Implement a handler of service messages.
|
|
*
|
|
* In the NetworkManager system messages are optionally routed to handlers
|
|
* using a service ID. Handling messages for a specific service, as they come
|
|
* from the network can be done by inherting from the NetworkService class
|
|
* and reimplementing the onIncomingMessage() call.
|
|
*
|
|
* Please note that this class adds to the very basic NetworkServiceBase class
|
|
* a safe way to reply to your incoming messages.
|
|
*/
|
|
class NetworkService : public NetworkServiceBase
|
|
{
|
|
public:
|
|
~NetworkService();
|
|
|
|
void onIncomingMessage(const Message &message, const EndPoint &ep) override;
|
|
|
|
class Remote {
|
|
public:
|
|
Remote() {}
|
|
Remote(int poolSize) : pool(poolSize) {}
|
|
virtual ~Remote();
|
|
NetworkConnection connection;
|
|
Streaming::BufferPool pool;
|
|
};
|
|
|
|
/**
|
|
* To implement a common subscription method where the only
|
|
* thing a remote tells us if they are enabled or disabled, we provide this
|
|
* standard pattern of finding remotes.
|
|
*
|
|
* To use this in a subclass you provide as your createRemote() method code like this:
|
|
* @code
|
|
Remote *createRemote() override {
|
|
return new RemoteSubscriptionInfo();
|
|
}
|
|
* @endcode
|
|
* In any method that is interested the remotes in order to send messages to, you can simply
|
|
* write:
|
|
* @code
|
|
const auto list = remotes<RemoteWithBool>(&NetworkService::filterRemoteWithBool);
|
|
if (list.empty())
|
|
return;
|
|
* @endcode
|
|
*/
|
|
class RemoteWithBool : public Remote {
|
|
public:
|
|
bool enabled = false;
|
|
};
|
|
/// Helper method to pass in to remotes<RemoteWithBool*>()
|
|
/// This method only returns items in the list that are the right type and have the 'enabled' bool set to true
|
|
static RemoteWithBool* filterRemoteWithBool(Remote *r);
|
|
|
|
/// pure virtual handler method that attaches a remote
|
|
virtual void onIncomingMessage(Remote *con, const Message &message, const EndPoint &ep) = 0;
|
|
|
|
protected:
|
|
/// constructor
|
|
NetworkService(int serviceId);
|
|
|
|
/// factory method, please return a subclass of Remote with your own data in it
|
|
virtual Remote *createRemote();
|
|
|
|
std::deque<Remote*> remotes() const;
|
|
|
|
template <class T>
|
|
std::deque<T*> remotes(const std::function<T*(Remote*)> &filter) const {
|
|
std::deque<T*> answer;
|
|
for (const auto r : remotes()) {
|
|
T* r_ = filter(r);
|
|
if (r_)
|
|
answer.push_back(r_);
|
|
}
|
|
return answer;
|
|
}
|
|
|
|
|
|
private:
|
|
void addRemote(Remote *remote);
|
|
void removeRemote(Remote *remote);
|
|
mutable std::atomic<RemoteContainer*> m_remotes;
|
|
|
|
void onDisconnected(const EndPoint &endPoint);
|
|
};
|
|
|
|
#endif
|