SNode.C
Loading...
Searching...
No Matches
ConfigAddress.h
Go to the documentation of this file.
1/*
2 * SNode.C - A Slim Toolkit for Network Communication
3 * Copyright (C) Volker Christian <me@vchrist.at>
4 * 2020, 2021, 2022, 2023, 2024, 2025
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License as published
8 * by the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20/*
21 * MIT License
22 *
23 * Permission is hereby granted, free of charge, to any person obtaining a copy
24 * of this software and associated documentation files (the "Software"), to deal
25 * in the Software without restriction, including without limitation the rights
26 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
27 * copies of the Software, and to permit persons to whom the Software is
28 * furnished to do so, subject to the following conditions:
29 *
30 * The above copyright notice and this permission notice shall be included in
31 * all copies or substantial portions of the Software.
32 *
33 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
34 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
35 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
36 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
37 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
38 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
39 * THE SOFTWARE.
40 */
41
42#ifndef NET_RC_CONFIG_CONFIGADDRESS_H
43#define NET_RC_CONFIG_CONFIGADDRESS_H
44
45#include "net/config/ConfigAddressLocal.h"
46#include "net/config/ConfigAddressRemote.h"
47#include "net/config/ConfigAddressReverse.h"
48#include "net/rc/SocketAddress.h"
49
50namespace net::config {
51 class ConfigInstance;
52}
53
54#ifndef DOXYGEN_SHOULD_SKIP_THIS
55
56#include <cstdint>
57#include <string>
58
59namespace CLI {
60 class Option;
61} // namespace CLI
62
63#endif /* DOXYGEN_SHOULD_SKIP_THIS */
64
65namespace net::rc::config {
66
67 template <template <typename SocketAddressT> typename ConfigAddressTypeT>
68 class ConfigAddressReverse : public ConfigAddressTypeT<net::rc::SocketAddress> {
69 private:
70 using Super = ConfigAddressTypeT<SocketAddress>;
71
72 protected:
73 using Super::Super;
74 };
75
76 template <template <typename SocketAddressT> typename ConfigAddressTypeT>
77 class ConfigAddress : public ConfigAddressTypeT<net::rc::SocketAddress> {
78 private:
79 using Super = ConfigAddressTypeT<net::rc::SocketAddress>;
80
81 protected:
82 explicit ConfigAddress(net::config::ConfigInstance* instance,
83 const std::string& addressOptionName,
84 const std::string& addressOptionDescription);
85
86 private:
87 SocketAddress* init() final;
88
89 public:
90 ConfigAddress& setSocketAddress(const SocketAddress& socketAddress);
91
92 ConfigAddress& setBtAddress(const std::string& btAddress);
93 std::string getBtAddress() const;
94
95 ConfigAddress& setChannel(uint8_t channel);
96 uint8_t getChannel() const;
97
98 protected:
99 ConfigAddress& setBtAddressRequired(bool required = true);
100 ConfigAddress& setChannelRequired(bool required = true);
101
102 CLI::Option* btAddressOpt = nullptr;
103 CLI::Option* channelOpt = nullptr;
104 };
105
106} // namespace net::rc::config
107
108extern template class net::config::ConfigAddress<net::rc::SocketAddress>;
109extern template class net::config::ConfigAddressLocal<net::rc::SocketAddress>;
110extern template class net::config::ConfigAddressRemote<net::rc::SocketAddress>;
111extern template class net::config::ConfigAddressReverse<net::rc::SocketAddress>;
112extern template class net::config::ConfigAddressBase<net::rc::SocketAddress>;
113extern template class net::rc::config::ConfigAddress<net::config::ConfigAddressLocal>;
114extern template class net::rc::config::ConfigAddress<net::config::ConfigAddressRemote>;
115extern template class net::rc::config::ConfigAddressReverse<net::config::ConfigAddressReverse>;
116
117#endif // NET_RC_CONFIG_CONFIGADDRESS_H
Config & getConfig() const
Definition Socket.hpp:60
static constexpr int DISABLED
Definition State.h:56
static constexpr int ERROR
Definition State.h:57
std::string what() const
Definition State.cpp:114
static constexpr int FATAL
Definition State.h:58
static constexpr int OK
Definition State.h:55
void listen(const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
std::list< std::string > getRoutes() const
Definition Router.cpp:84
WebAppT(const std::string &name, const Router &router)
Definition WebAppT.h:80
uint8_t getChannel() const
SocketAddress & setChannel(uint8_t channel)
SocketAddress(const std::string &btAddress, uint8_t channel)
std::string toString(bool expanded=true) const override
SocketAddress(const std::string &btAddress)
SocketAddress & setBtAddress(const std::string &btAddress)
SocketAddress(const SockAddr &sockAddr, SockLen sockAddrLen)
std::string getBtAddress() const
SocketAddress(uint8_t channel)
SocketAddress * init() final
ConfigAddress(net::config::ConfigInstance *instance, const std::string &addressOptionName, const std::string &addressOptionDescription)
ConfigAddress & setChannel(uint8_t channel)
ConfigAddress & setBtAddress(const std::string &btAddress)
ConfigAddress & setSocketAddress(const SocketAddress &socketAddress)
ConfigAddress & setChannelRequired(bool required=true)
ConfigAddress & setBtAddressRequired(bool required=true)
PhysicalSocket(int type, int protocol)
PhysicalSocket(PhysicalSocket &&) noexcept=default
PhysicalSocketServer(PhysicalSocketServer &&) noexcept=default
PhysicalSocket(PhysicalSocket &&) noexcept=default
void listen(const std::string &btAddress, uint8_t channel, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(const std::string &btAddress, uint8_t channel, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(uint8_t channel, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
void listen(uint8_t channel, int backlog, const std::function< void(const SocketAddress &, core::socket::State)> &onStatus) const
ConfigSocketServer(net::config::ConfigInstance *instance)
WebApp Server(const std::string &instanceName, const express::Router &router, const std::function< void(const std::string &, WebApp::SocketAddress, const core::socket::State &)> &reportState, const std::function< void(typename WebApp::Config &)> &configurator)
Definition Server.cpp:55
WebApp Server(const std::string &instanceName, const Router &router, const std::function< void(WebApp::Config &)> &configurator)
Definition Server.cpp:98
SocketServer< SocketContextFactory, SocketContextFactoryArgs... > Server(const std::string &instanceName, const std::function< void(typename SocketServer< SocketContextFactory, SocketContextFactoryArgs... >::Config &)> &configurator, SocketContextFactoryArgs &&... socketContextFactoryArgs)
SocketServer< SocketContextFactory, SocketContextFactoryArgs... > Server(const std::string &instanceName, SocketContextFactoryArgs &&... socketContextFactoryArgs)