espressif/esp-protocols
1
0
Fork 1
mirror of https://github.com/espressif/esp-protocols.git synced 2025-07-30 02:37:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

Factory: Rename Builder class to Creator, since it's not 100% builder pattern

Browse Source
This commit is contained in:
David Cermak
2021-06-17 16:21:28 +02:00
parent 148a9300a4
commit 6e34954677
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
components/esp_modem/include/cxx_include/esp_modem_dce_factory.hpp
View File

@ -57,30 +57,30 @@ public:
}; };
/** /**
* @brief Builder class for building a DCE_T<Module> in a specific way, either from a Module object or by default from the DTE and netif * @brief Creator class for building a DCE_T<Module> in a specific way, either from a Module object or by default from the DTE and netif
* *
* @throws * @throws
* - esp_modem::esp_err_exception on invalid arguments * - esp_modem::esp_err_exception on invalid arguments
* - std::bad_alloc if failed to allocate * - std::bad_alloc if failed to allocate
*/ */
template<typename T_Module> template<typename T_Module>
class Builder { class Creator {
static_assert(std::is_base_of<ModuleIf, T_Module>::value, "Builder must be used only for Module classes"); static_assert(std::is_base_of<ModuleIf, T_Module>::value, "Builder must be used only for Module classes");
public: public:
Builder(std::shared_ptr<DTE> dte, esp_netif_t *esp_netif): dte(std::move(dte)), device(nullptr), netif(esp_netif) Creator(std::shared_ptr<DTE> dte, esp_netif_t *esp_netif): dte(std::move(dte)), device(nullptr), netif(esp_netif)
{ {
throw_if_false(netif != nullptr, "Null netif"); throw_if_false(netif != nullptr, "Null netif");
} }
Builder(std::shared_ptr<DTE> dte, esp_netif_t *esp_netif, std::shared_ptr<T_Module> dev): dte(std::move(dte)), device(std::move(dev)), netif(esp_netif) Creator(std::shared_ptr<DTE> dte, esp_netif_t *esp_netif, std::shared_ptr<T_Module> dev): dte(std::move(dte)), device(std::move(dev)), netif(esp_netif)
{ {
throw_if_false(netif != nullptr, "Null netif"); throw_if_false(netif != nullptr, "Null netif");
} }
~Builder() ~Creator()
{ {
if (device == nullptr) { if (device != nullptr) {
ESP_LOGE("dce_factory::~Builder", "module was captured or created but never used"); ESP_LOGE("dce_factory::~Creator", "module was captured or created but never used");
} }
} }
@ -233,16 +233,16 @@ protected:
template <typename T_Module, typename Ptr = std::shared_ptr<T_Module>, typename ...Args> template <typename T_Module, typename Ptr = std::shared_ptr<T_Module>, typename ...Args>
static Ptr build_module_T(const config *cfg, Args && ... args) static Ptr build_module_T(const config *cfg, Args && ... args)
{ {
Builder<T_Module> b(std::forward<Args>(args)...); Creator<T_Module> creator(std::forward<Args>(args)...);
return b.template create_module<Ptr>(cfg); return creator.template create_module<Ptr>(cfg);
} }
template <typename T_Module, typename T_Dce = DCE_T<T_Module>, typename T_DcePtr = T_Dce *, typename ...Args> template <typename T_Module, typename T_Dce = DCE_T<T_Module>, typename T_DcePtr = T_Dce *, typename ...Args>
static auto build_generic_DCE(const config *cfg, Args && ... args) -> T_DcePtr static auto build_generic_DCE(const config *cfg, Args && ... args) -> T_DcePtr
{ {
Builder<T_Module> b(std::forward<Args>(args)...); Creator<T_Module> creator(std::forward<Args>(args)...);
return b.template create<T_Dce, T_DcePtr>(cfg); return creator.template create<T_Dce, T_DcePtr>(cfg);
} }
}; };