1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
// SPDX-License-Identifier: GPL-2.0-or-later
/*
This file is part of Warzone 2100.
Copyright (C) 2025 Warzone 2100 Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include "lib/netplay/net_result.h"
#include <chrono>
#include <memory>
class IClientConnection;
enum class PollEventType
{
READABLE,
WRITABLE
};
/// <summary>
/// Abstract class for describing polling descriptor sets used by various polling APIs (e.g. `select()` and `poll()`).
///
/// This is a low-level utility and it's not intended for direct use in high-level networking code.
/// </summary>
class IDescriptorSet
{
public:
virtual ~IDescriptorSet() = default;
virtual bool add(IClientConnection* conn) = 0;
virtual bool remove(IClientConnection* conn) = 0;
virtual void clear() = 0;
virtual bool empty() const = 0;
/// <summary>
/// Polling algorithm implementation for this descriptor set kind.
/// Should represent the same semantics as `select()` or `poll()` APIs, i.e. after calling `pollImpl()` one
/// should check individual descriptors via `isSet()` to see, which of them were marked as ready.
/// </summary>
/// <param name="timeout">Timeout value in milliseconds</param>
/// <returns>
/// * Non-negative integer indicating the number of descriptors that have a return event set
/// by the internal polling function.
/// * Zero if none of the descriptors have been set (polling function timed out).
/// * `std::error_code` containing error condition otherwise.
/// </returns>
virtual net::result<int> poll(std::chrono::milliseconds timeout) = 0;
enum class ErroredState
{
InvalidConn,
Error, // POLLERR
HangUp, // POLLHUP
};
/// <summary>
/// Check if a given connection is marked as `ready`, i.e.: the previous `poll()` operation
/// has successfully set a readable/writable flag (depending on the `EventType` template argument)
/// on this connection.
/// </summary>
virtual ::tl::expected<bool, ErroredState> isSet(const IClientConnection* conn) const = 0;
};
|
