cpp-rotor-docs/supervisor__thread_8h_source.html

#pragma once


//

// Copyright (c) 2019-2022 Ivan Baidakou (basiliscos) (the dot dmol at gmail dot com)

//

// Distributed under the MIT Software License

//


#include "rotor/supervisor.h"

#include "rotor/thread/export.h"

#include "system_context_thread.h"


namespace rotor {

namespace thread {


struct ROTOR_THREAD_API supervisor_thread_t : public supervisor_t {

    inline supervisor_thread_t(supervisor_config_t &cfg) : supervisor_t{cfg} {}


    void start() noexcept override;

    void shutdown() noexcept override;

    void enqueue(message_ptr_t message) noexcept override;

    void intercept(message_ptr_t &message, const void *tag, const continuation_t &continuation) noexcept override;


    void update_time() noexcept;


    void do_start_timer(const pt::time_duration &interval, timer_handler_base_t &handler) noexcept override;

    void do_cancel_timer(request_id_t timer_id) noexcept override;

};


} // namespace thread

} // namespace rotor

rotor::message
namespace for rotor core messages (which just transform payloads)
Definition messages.hpp:317

rotor::thread
namespace for pure thread backend (supervisor) for rotor
Definition thread.hpp:19

rotor
Basic namespace for all rotor functionalities.
Definition rotor.hpp:21

rotor::message_ptr_t
intrusive_ptr_t< message_base_t > message_ptr_t
intrusive pointer for message
Definition message.h:118

rotor::request_id_t
std::size_t request_id_t
timer identifier type in the scope of the actor
Definition forward.hpp:34

rotor::continuation_t
continue handler invocation (used for intercepting)
Definition handler.h:175

rotor::supervisor_config_t
base supervisor config, which holds shutdown timeout value
Definition supervisor_config.h:23

rotor::supervisor_t::supervisor_t
supervisor_t(supervisor_config_t &config)
constructs new supervisor with optional parent supervisor

rotor::thread::supervisor_thread_t::shutdown
void shutdown() noexcept override
thread-safe version of do_shutdown, i.e. send shutdown request let it be processed by the supervisor

rotor::thread::supervisor_thread_t::update_time
void update_time() noexcept
updates timer and fires timer handlers, which have been expired

rotor::thread::supervisor_thread_t::start
void start() noexcept override
thread-safe version of do_process

rotor::thread::supervisor_thread_t::do_cancel_timer
void do_cancel_timer(request_id_t timer_id) noexcept override
cancels timer (to be implemented in descendants)

rotor::thread::supervisor_thread_t::do_start_timer
void do_start_timer(const pt::time_duration &interval, timer_handler_base_t &handler) noexcept override
starts non-recurring timer (to be implemented in descendants)

rotor::thread::supervisor_thread_t::enqueue
void enqueue(message_ptr_t message) noexcept override
enqueues messages thread safe way and triggers processing

rotor::thread::supervisor_thread_t::supervisor_thread_t
supervisor_thread_t(supervisor_config_t &cfg)
constructs new thread supervisor
Definition supervisor_thread.h:26

rotor::thread::supervisor_thread_t::intercept
void intercept(message_ptr_t &message, const void *tag, const continuation_t &continuation) noexcept override
intercepts message delivery for the tagged handler

rotor::timer_handler_base_t
Base class for timer handler.
Definition timer_handler.hpp:17