StormByte-Network 2.0.0
C++26 networking module of the StormByte suite
 
Loading...
Searching...
No Matches
status.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
44
53 enum class STORMBYTE_NETWORK_PUBLIC Status: unsigned short {
54 Connected,
59 Rejected,
61 Error
62 };
63
69 constexpr STORMBYTE_NETWORK_PUBLIC const char* StatusToString(const Status& status) noexcept {
70 switch (status) {
71 case Status::Connected: return "Connected";
72 case Status::Disconnected: return "Disconnected";
73 case Status::Connecting: return "Connecting";
74 case Status::Disconnecting: return "Disconnecting";
75 case Status::Negotiating: return "Negotiating";
76 case Status::Rejected: return "Rejected";
77 case Status::PeerClosed: return "PeerClosed";
78 case Status::Error:
79 default: return "Error";
80 }
81 }
82
88 constexpr STORMBYTE_NETWORK_PUBLIC bool IsConnected(const Status& status) noexcept {
89 return status == Status::Connected || status == Status::Negotiating;
90 }
91}
Connection types of the Network module.
Definition client.hxx:55
constexpr const char * StatusToString(const Status &status) noexcept
Status as text.
Definition status.hxx:69
constexpr bool IsConnected(const Status &status) noexcept
Whether the connection is usable for I/O (Connected or Negotiating).
Definition status.hxx:88
Status
Lifecycle of a connection or listener.
Definition status.hxx:53
@ Disconnecting
Shutdown in progress.
@ Connected
Connection established.
@ Rejected
Peer or local rejection.
@ PeerClosed
Peer closed the connection.
@ Connecting
Connect or listen in progress.
@ Negotiating
Application-level handshake.
#define STORMBYTE_NETWORK_PUBLIC
Definition visibility.h:51