451 lines
14 KiB
C
451 lines
14 KiB
C
|
/******************************************************************************
|
||
|
|
The MIT License(MIT)
|
||
|
|
|
||
|
|
Embedded Template Library.
|
||
|
|
https://github.com/ETLCPP/etl
|
||
|
|
https://www.etlcpp.com
|
||
|
|
|
||
|
|
Copyright(c) 2017 John Wellbelove
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
|
|
of this software and associated documentation files(the "Software"), to deal
|
||
|
|
in the Software without restriction, including without limitation the rights
|
||
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
|
||
|
|
copies of the Software, and to permit persons to whom the Software is
|
||
|
|
furnished to do so, subject to the following conditions :
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be included in all
|
||
|
|
copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
|
||
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||
|
|
SOFTWARE.
|
||
|
|
******************************************************************************/
|
||
|
|
|
||
|
|
#ifndef ETL_MESSAGE_BUS_INCLUDED
|
||
|
|
#define ETL_MESSAGE_BUS_INCLUDED
|
||
|
|
|
||
|
|
#include "platform.h"
|
||
|
|
#include "algorithm.h"
|
||
|
|
#include "vector.h"
|
||
|
|
#include "nullptr.h"
|
||
|
|
#include "error_handler.h"
|
||
|
|
#include "exception.h"
|
||
|
|
#include "message_types.h"
|
||
|
|
#include "message.h"
|
||
|
|
#include "message_router.h"
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
|
||
|
|
namespace etl
|
||
|
|
{
|
||
|
|
//***************************************************************************
|
||
|
|
/// Base exception class for message bus
|
||
|
|
//***************************************************************************
|
||
|
|
class message_bus_exception : public etl::exception
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
|
||
|
|
message_bus_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
|
||
|
|
: etl::exception(reason_, file_name_, line_number_)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
//***************************************************************************
|
||
|
|
/// Too many subscribers.
|
||
|
|
//***************************************************************************
|
||
|
|
class message_bus_too_many_subscribers : public etl::message_bus_exception
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
|
||
|
|
message_bus_too_many_subscribers(string_type file_name_, numeric_type line_number_)
|
||
|
|
: message_bus_exception(ETL_ERROR_TEXT("message bus:too many subscribers", ETL_MESSAGE_BUS_FILE_ID"A"), file_name_, line_number_)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
//***************************************************************************
|
||
|
|
/// Interface for message bus
|
||
|
|
//***************************************************************************
|
||
|
|
class imessage_bus : public etl::imessage_router
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
|
||
|
|
typedef etl::ivector<etl::imessage_router*> router_list_t;
|
||
|
|
|
||
|
|
public:
|
||
|
|
|
||
|
|
using etl::imessage_router::receive;
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Subscribe to the bus.
|
||
|
|
//*******************************************
|
||
|
|
bool subscribe(etl::imessage_router& router)
|
||
|
|
{
|
||
|
|
bool ok = true;
|
||
|
|
|
||
|
|
// There's no point adding routers that don't consume messages.
|
||
|
|
if (router.is_consumer())
|
||
|
|
{
|
||
|
|
ok = !router_list.full();
|
||
|
|
|
||
|
|
ETL_ASSERT(ok, ETL_ERROR(etl::message_bus_too_many_subscribers));
|
||
|
|
|
||
|
|
if (ok)
|
||
|
|
{
|
||
|
|
router_list_t::iterator irouter = etl::upper_bound(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
router.get_message_router_id(),
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
router_list.insert(irouter, &router);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return ok;
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Unsubscribe from the bus.
|
||
|
|
//*******************************************
|
||
|
|
void unsubscribe(etl::message_router_id_t id)
|
||
|
|
{
|
||
|
|
if (id == etl::imessage_bus::ALL_MESSAGE_ROUTERS)
|
||
|
|
{
|
||
|
|
clear();
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
ETL_OR_STD::pair<router_list_t::iterator, router_list_t::iterator> range = etl::equal_range(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
id,
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
router_list.erase(range.first, range.second);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
void unsubscribe(etl::imessage_router& router)
|
||
|
|
{
|
||
|
|
router_list_t::iterator irouter = etl::find(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
&router);
|
||
|
|
|
||
|
|
if (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
router_list.erase(irouter);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
virtual void receive(const etl::imessage& message) ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
receive(etl::imessage_router::ALL_MESSAGE_ROUTERS, message);
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
virtual void receive(etl::shared_message shared_msg) ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
receive(etl::imessage_router::ALL_MESSAGE_ROUTERS, shared_msg);
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
virtual void receive(etl::message_router_id_t destination_router_id,
|
||
|
|
const etl::imessage& message) ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
switch (destination_router_id)
|
||
|
|
{
|
||
|
|
//*****************************
|
||
|
|
// Broadcast to all routers.
|
||
|
|
case etl::imessage_router::ALL_MESSAGE_ROUTERS:
|
||
|
|
{
|
||
|
|
router_list_t::iterator irouter = router_list.begin();
|
||
|
|
|
||
|
|
// Broadcast to everyone.
|
||
|
|
while (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
etl::imessage_router& router = **irouter;
|
||
|
|
|
||
|
|
if (router.accepts(message.get_message_id()))
|
||
|
|
{
|
||
|
|
router.receive(message);
|
||
|
|
}
|
||
|
|
|
||
|
|
++irouter;
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************
|
||
|
|
// Must be an addressed message.
|
||
|
|
default:
|
||
|
|
{
|
||
|
|
router_list_t::iterator irouter = router_list.begin();
|
||
|
|
|
||
|
|
// Find routers with the id.
|
||
|
|
ETL_OR_STD::pair<router_list_t::iterator, router_list_t::iterator> range = etl::equal_range(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
destination_router_id,
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
// Call all of them.
|
||
|
|
while (range.first != range.second)
|
||
|
|
{
|
||
|
|
if ((*(range.first))->accepts(message.get_message_id()))
|
||
|
|
{
|
||
|
|
(*(range.first))->receive(message);
|
||
|
|
}
|
||
|
|
|
||
|
|
++range.first;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Do any message buses.
|
||
|
|
// These are always at the end of the list.
|
||
|
|
irouter = etl::lower_bound(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
etl::imessage_bus::MESSAGE_BUS,
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
while (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
// So pass it on.
|
||
|
|
(*irouter)->receive(destination_router_id, message);
|
||
|
|
|
||
|
|
++irouter;
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (has_successor())
|
||
|
|
{
|
||
|
|
if (get_successor().accepts(message.get_message_id()))
|
||
|
|
{
|
||
|
|
get_successor().receive(destination_router_id, message);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//********************************************
|
||
|
|
virtual void receive(etl::message_router_id_t destination_router_id,
|
||
|
|
etl::shared_message shared_msg) ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
switch (destination_router_id)
|
||
|
|
{
|
||
|
|
//*****************************
|
||
|
|
// Broadcast to all routers.
|
||
|
|
case etl::imessage_router::ALL_MESSAGE_ROUTERS:
|
||
|
|
{
|
||
|
|
router_list_t::iterator irouter = router_list.begin();
|
||
|
|
|
||
|
|
// Broadcast to everyone.
|
||
|
|
while (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
etl::imessage_router& router = **irouter;
|
||
|
|
|
||
|
|
if (router.accepts(shared_msg.get_message().get_message_id()))
|
||
|
|
{
|
||
|
|
router.receive(shared_msg);
|
||
|
|
}
|
||
|
|
|
||
|
|
++irouter;
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
//*****************************
|
||
|
|
// Must be an addressed message.
|
||
|
|
default:
|
||
|
|
{
|
||
|
|
// Find routers with the id.
|
||
|
|
ETL_OR_STD::pair<router_list_t::iterator, router_list_t::iterator> range = etl::equal_range(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
destination_router_id,
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
// Call all of them.
|
||
|
|
while (range.first != range.second)
|
||
|
|
{
|
||
|
|
if ((*(range.first))->accepts(shared_msg.get_message().get_message_id()))
|
||
|
|
{
|
||
|
|
(*(range.first))->receive(shared_msg);
|
||
|
|
}
|
||
|
|
|
||
|
|
++range.first;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Do any message buses.
|
||
|
|
// These are always at the end of the list.
|
||
|
|
router_list_t::iterator irouter = etl::lower_bound(router_list.begin(),
|
||
|
|
router_list.end(),
|
||
|
|
etl::imessage_bus::MESSAGE_BUS,
|
||
|
|
compare_router_id());
|
||
|
|
|
||
|
|
while (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
// So pass it on.
|
||
|
|
(*irouter)->receive(destination_router_id, shared_msg);
|
||
|
|
|
||
|
|
++irouter;
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (has_successor())
|
||
|
|
{
|
||
|
|
if (get_successor().accepts(shared_msg.get_message().get_message_id()))
|
||
|
|
{
|
||
|
|
get_successor().receive(destination_router_id, shared_msg);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
using imessage_router::accepts;
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Does this message bus accept the message id?
|
||
|
|
/// Returns <b>true</b> on the first router that does.
|
||
|
|
//*******************************************
|
||
|
|
bool accepts(etl::message_id_t id) const ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
// Check the list of subscribed routers.
|
||
|
|
router_list_t::iterator irouter = router_list.begin();
|
||
|
|
|
||
|
|
while (irouter != router_list.end())
|
||
|
|
{
|
||
|
|
etl::imessage_router& router = **irouter;
|
||
|
|
|
||
|
|
if (router.accepts(id))
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
++irouter;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Check any successor.
|
||
|
|
if (has_successor())
|
||
|
|
{
|
||
|
|
if (get_successor().accepts(id))
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
size_t size() const
|
||
|
|
{
|
||
|
|
return router_list.size();
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
void clear()
|
||
|
|
{
|
||
|
|
router_list.clear();
|
||
|
|
}
|
||
|
|
|
||
|
|
//********************************************
|
||
|
|
ETL_DEPRECATED bool is_null_router() const ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
//********************************************
|
||
|
|
bool is_producer() const ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
//********************************************
|
||
|
|
bool is_consumer() const ETL_OVERRIDE
|
||
|
|
{
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
protected:
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Constructor.
|
||
|
|
//*******************************************
|
||
|
|
imessage_bus(router_list_t& list)
|
||
|
|
: imessage_router(etl::imessage_router::MESSAGE_BUS),
|
||
|
|
router_list(list)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Constructor.
|
||
|
|
//*******************************************
|
||
|
|
imessage_bus(router_list_t& router_list_, etl::imessage_router& successor_)
|
||
|
|
: imessage_router(etl::imessage_router::MESSAGE_BUS, successor_),
|
||
|
|
router_list(router_list_)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
// How to compare routers to router ids.
|
||
|
|
//*******************************************
|
||
|
|
struct compare_router_id
|
||
|
|
{
|
||
|
|
bool operator()(const etl::imessage_router* prouter, etl::message_router_id_t id) const
|
||
|
|
{
|
||
|
|
return prouter->get_message_router_id() < id;
|
||
|
|
}
|
||
|
|
|
||
|
|
bool operator()(etl::message_router_id_t id, const etl::imessage_router* prouter) const
|
||
|
|
{
|
||
|
|
return id < prouter->get_message_router_id();
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
router_list_t& router_list;
|
||
|
|
};
|
||
|
|
|
||
|
|
//***************************************************************************
|
||
|
|
/// The message bus
|
||
|
|
//***************************************************************************
|
||
|
|
template <uint_least8_t MAX_ROUTERS_>
|
||
|
|
class message_bus : public etl::imessage_bus
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Constructor.
|
||
|
|
//*******************************************
|
||
|
|
message_bus()
|
||
|
|
: imessage_bus(router_list)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
//*******************************************
|
||
|
|
/// Constructor.
|
||
|
|
//*******************************************
|
||
|
|
message_bus(etl::imessage_router& successor_)
|
||
|
|
: imessage_bus(router_list, successor_)
|
||
|
|
{
|
||
|
|
}
|
||
|
|
|
||
|
|
private:
|
||
|
|
|
||
|
|
etl::vector<etl::imessage_router*, MAX_ROUTERS_> router_list;
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
#endif
|