StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
endpoint.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Network.
5 *
6 * StormByte-Network original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Network source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Buffer tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Network is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Network. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/buffer/pipeline.hxx>
44#include <StormByte/logger/threaded_log.hxx>
46
47#include <string_view>
48
53namespace StormByte {
58 namespace Network {
63 namespace Connection {
68 class Client;
69 }
70
82 public:
88 Endpoint(DeserializePacketFunction deserialize_packet_function, StormByte::Safe::Shared<Logger::Log> logger) noexcept;
89
94 Endpoint(const Endpoint& other) = delete;
95
100 Endpoint(Endpoint&& other) noexcept;
101
105 virtual ~Endpoint() noexcept;
106
112 Endpoint& operator=(const Endpoint& other) = delete;
113
119 Endpoint& operator=(Endpoint&& other) noexcept;
120
128 virtual bool Connect(const Connection::Protocol& protocol, std::string_view address, const unsigned short& port) = 0;
129
133 virtual void Disconnect() noexcept = 0;
134
139 virtual Connection::Status Status() const noexcept = 0;
140
141 protected:
146
151
158
165 PacketPointer Send(StormByte::Safe::Shared<Connection::Client> client_connection, const Transport::Packet& packet) noexcept;
166
173 bool Reply(StormByte::Safe::Shared<Connection::Client> client_connection, const Transport::Packet& packet) noexcept;
174
175 private:
182 bool SendPacket(StormByte::Safe::Shared<Connection::Client> client_connection, const Transport::Packet& packet) noexcept;
183 };
184 }
185}
186
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Abstract application client.
Definition client.hxx:124
Caller-owned callback that builds a packet from opcode and payload.
Definition typedefs.hxx:143
Endpoint(Endpoint &&other) noexcept
Move constructor.
virtual bool Connect(const Connection::Protocol &protocol, std::string_view address, const unsigned short &port)=0
Connect or listen (meaning depends on the derived class).
StormByte::Safe::Shared< Connection::Client > CreateConnection(StormByte::Safe::Shared< Socket::Client > socket) noexcept
Wrap a socket client with initially empty input/output pipelines.
virtual Connection::Status Status() const noexcept=0
Current connection/listen status.
Endpoint(DeserializePacketFunction deserialize_packet_function, StormByte::Safe::Shared< Logger::Log > logger) noexcept
Construct with a packet factory and a logger.
Endpoint(const Endpoint &other)=delete
Copy constructor (deleted).
PacketPointer Send(StormByte::Safe::Shared< Connection::Client > client_connection, const Transport::Packet &packet) noexcept
Send packet and wait for a response frame.
virtual void Disconnect() noexcept=0
Tear down the endpoint.
bool Reply(StormByte::Safe::Shared< Connection::Client > client_connection, const Transport::Packet &packet) noexcept
Send packet without waiting for a reply.
StormByte::Safe::Shared< Logger::Log > m_logger
Shared diagnostic logger for this endpoint.
Definition endpoint.hxx:150
virtual ~Endpoint() noexcept
Destructor.
DeserializePacketFunction m_deserialize_packet_function
Packet factory used to deserialize received wire data.
Definition endpoint.hxx:145
Connection namespace.
Private native transport implementation.
Transport namespace.
Network module of the StormByte suite.
StormByte::Safe::Shared< Transport::Packet > PacketPointer
Base-heap shared packet pointer.
Definition typedefs.hxx:132
Root namespace of the StormByte suite.
STL namespace.
#define STORMBYTE_NETWORK_PUBLIC
Definition visibility.h:51