loop.h

Go to the documentation of this file.

/*
MIT License
 
Copyright (c) 2025 Luan Young
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#pragma once
 
#include <chrono>
#include <cstddef>
#include <functional>
#include <list>
#include <map>
#include <zmq.hpp>
 
#include "cppzmqzoltanext/czze_export.h"
#include "poller.h"
 
namespace zmqzext {
 
class loop_t;
 
using timer_id_t = std::size_t;
 
using fn_socket_handler_t = std::function<bool(loop_t&, zmq::socket_ref)>;
 
using fn_timer_handler_t = std::function<bool(loop_t&, timer_id_t)>;
 
class CZZE_EXPORT loop_t {
private:
    using time_point_t = std::chrono::time_point<std::chrono::steady_clock>;
    using time_milliseconds_t = std::chrono::milliseconds;
 
    struct timer_t {
        timer_id_t id;                      
        std::chrono::milliseconds timeout;  
        std::size_t occurences;             
        time_point_t next_occurence;        
        fn_timer_handler_t handler;         
        bool removed;                       
    };
 
public:
    void add(zmq::socket_ref socket, fn_socket_handler_t fn);
 
    timer_id_t add_timer(std::chrono::milliseconds timeout, std::size_t occurences, fn_timer_handler_t fn);
 
    void remove(zmq::socket_ref socket);
 
    void remove_timer(timer_id_t timer_id);
 
    void run(bool interruptible = true,
             std::chrono::milliseconds interruptCheckInterval = std::chrono::milliseconds{-1});
 
    bool terminated() const noexcept { return _poller.terminated(); }
 
private:
    time_point_t now();
 
    time_milliseconds_t find_next_timeout(time_point_t const& actual_time);
 
    void removeFlagedTimers();
 
    timer_id_t generate_unique_timer_id();
 
private:
    poller_t _poller;                                                 
    std::map<zmq::socket_ref, fn_socket_handler_t> _socket_handlers;  
    std::list<timer_t> _timer_handlers;                               
    timer_id_t _last_timer_id{0};                                     
    bool _timer_id_has_overflowed{false};                             
    time_milliseconds_t _interruptCheckInterval{-1};                  
};
 
}  // namespace zmqzext