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
// Copyright (C) 2025 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#ifndef SELECT_EVENT_HANDLER_H
#define SELECT_EVENT_HANDLER_H

#include <util/fd_event_handler.h>

#include <sys/select.h>

namespace isc {
namespace util {

/// @brief File descriptor event handler class handles events for registered
/// file descriptors. This class uses the OS select syscall for event handling.
class SelectEventHandler : public FDEventHandler {
public:
    /// @brief Constructor.
    SelectEventHandler();

    /// @brief Destructor.
    virtual ~SelectEventHandler() = default;<--- Destructor in derived class

    /// @brief Add file descriptor to watch for events.
    ///
    /// @param fd The file descriptor.
    void add(int fd);<--- Function in derived class

    /// @brief Wait for events on registered file descriptors.
    ///
    /// @param timeout_sec The wait timeout in seconds.
    /// @param timeout_usec The wait timeout in micro seconds.
    /// @param use_timeout Flag which indicates if function should wait
    /// with no timeout (wait forever).
    /// @return -1 on error, 0 if no data is available (timeout expired),
    /// 1 if data is ready.
    int waitEvent(uint32_t timeout_sec, uint32_t timeout_usec = 0,<--- Function in derived class
                  bool use_timeout = true);

    /// @brief Check if file descriptor is ready for read operation.
    ///
    /// @param fd The file descriptor.
    ///
    /// @return True if file descriptor is ready for reading.
    bool readReady(int fd);<--- Function in derived class

    /// @brief Check if file descriptor has error.
    ///
    /// @param fd The file descriptor.
    ///
    /// @return True if file descriptor has error.
    virtual bool hasError(int fd);<--- Function in derived class

    /// @brief Clear registered file descriptors.
    void clear();<--- Function in derived class

private:
    /// @brief The maximum value of registered file descriptors.
    int max_fd_;

    /// @brief The read event FD set.
    fd_set read_fd_set_;

    /// @brief The read event FD set.
    fd_set read_fd_set_data_;
};

}  // namespace isc::util;
}  // namespace isc

#endif  // SELECT_EVENT_HANDLER_H