Skip to content

Commit

Permalink
Makes task_timer generic and introduce default_task_timer and millise…
Browse files Browse the repository at this point in the history 
…conds_task_timer
  • Loading branch information
@StefanoPetrilli
StefanoPetrilli committed Sep 12, 2024
1 parent dfbce12 commit 3328412
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 44 deletions.
6 changes: 3 additions & 3 deletions include/crow/http_connection.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ namespace crow
const std::string& server_name,
std::tuple<Middlewares...>* middlewares,
std::function<std::string()>& get_cached_date_str_f,
detail::task_timer& task_timer,
detail::default_task_timer& task_timer,
typename Adaptor::context* adaptor_ctx_,
std::atomic<unsigned int>& queue_length):
adaptor_(io_service, adaptor_ctx_),
Expand Down Expand Up @@ -615,7 +615,7 @@ namespace crow
std::string date_str_;
std::string res_body_copy_;

detail::task_timer::identifier_type task_id_{};
detail::default_task_timer::identifier_type task_id_{};

bool continue_requested{};
bool need_to_call_after_handlers_{};
Expand All @@ -626,7 +626,7 @@ namespace crow
detail::context<Middlewares...> ctx_;

std::function<std::string()>& get_cached_date_str;
detail::task_timer& task_timer_;
detail::default_task_timer& task_timer_;

size_t res_stream_threshold_;

Expand Down
2 changes: 1 addition & 1 deletion include/crow/http_server.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ namespace crow // NOTE: Already documented in "crow/app.h"
private:
std::vector<std::unique_ptr<asio::io_service>> io_service_pool_;
asio::io_service io_service_;
std::vector<detail::task_timer*> task_timer_pool_;
std::vector<detail::default_task_timer*> task_timer_pool_;
std::vector<std::function<std::string()>> get_cached_date_str_pool_;
tcp::acceptor acceptor_;
bool shutting_down_ = false;
Expand Down
71 changes: 39 additions & 32 deletions include/crow/task_timer.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ namespace crow
namespace detail
{

/// A class for scheduling functions to be called after a specific amount of ticks. A tick is equal to 1 second.
/// A class for scheduling functions to be called after a specific
/// amount of ticks. A tick is equal to 1 second.
template <typename DurationType = std::chrono::seconds>
class task_timer
{
public:
Expand All @@ -44,9 +46,10 @@ namespace crow
task_timer(asio::io_service& io_service):
io_service_(io_service), timer_(io_service_)
{
timer_.expires_after(std::chrono::seconds(1));
timer_.expires_after(DurationType(1));
timer_.async_wait(
std::bind(&task_timer::tick_handler, this, std::placeholders::_1));
std::bind(&task_timer::tick_handler,
this, std::placeholders::_1));
}

~task_timer() { timer_.cancel(); }
Expand All @@ -57,48 +60,46 @@ namespace crow
CROW_LOG_DEBUG << "task_timer cancelled: " << this << ' ' << id;
}

/// Schedule the given task to be executed after the default amount of ticks.
/// Schedule the given task to be executed after the default amount
/// of ticks.

///
/// \return identifier_type Used to cancel the thread.
/// It is not bound to this task_timer instance and in some cases could lead to
/// undefined behavior if used with other task_timer objects or after the task
/// has been successfully executed.
/// It is not bound to this task_timer instance and in some cases
/// could lead to undefined behavior if used with other task_timer
/// objects or after the task has been successfully executed.
identifier_type schedule(const task_type& task)
{
tasks_.insert(
{++highest_id_,
{clock_type::now() + std::chrono::seconds(get_default_timeout()),
task}});
CROW_LOG_DEBUG << "task_timer scheduled: " << this << ' ' << highest_id_;
return highest_id_;
return schedule(task, get_default_timeout());
}

/// Schedule the given task to be executed after the given time.

///
/// \param timeout The amount of ticks (seconds) to wait before execution.
/// \param timeout The amount of ticks (seconds) to wait before
/// execution.
///
/// \return identifier_type Used to cancel the thread.
/// It is not bound to this task_timer instance and in some cases could lead to
/// undefined behavior if used with other task_timer objects or after the task
/// has been successfully executed.
/// It is not bound to this task_timer instance and in some cases
/// could lead to undefined behavior if used with other task_timer
/// objects or after the task has been successfully executed.
identifier_type schedule(const task_type& task, std::uint8_t timeout)
{
tasks_.insert({++highest_id_,
{clock_type::now() + std::chrono::seconds(timeout), task}});
CROW_LOG_DEBUG << "task_timer scheduled: " << this << ' ' << highest_id_;
{clock_type::now() +
DurationType(timeout), task}});
CROW_LOG_DEBUG << "task_timer scheduled: " << this << ' ' <<
highest_id_;
return highest_id_;
}

/// Set the default timeout for this task_timer instance. (Default: 5)

///
/// \param timeout The amount of ticks (seconds) to wait before execution.
void set_default_timeout(std::uint8_t timeout) { default_timeout_ = timeout; }
void set_default_timeout(std::uint8_t timeout) {
default_timeout_ = timeout;
}

/// Get the default timeout. (Default: 5)
std::uint8_t get_default_timeout() const { return default_timeout_; }
std::uint8_t get_default_timeout() const {
return default_timeout_;
}

private:
void process_tasks()
Expand All @@ -112,14 +113,16 @@ namespace crow
{
(task.second.second)();
finished_tasks.push_back(task.first);
CROW_LOG_DEBUG << "task_timer called: " << this << ' ' << task.first;
CROW_LOG_DEBUG << "task_timer called: " << this <<
' ' << task.first;
}
}

for (const auto& task : finished_tasks)
tasks_.erase(task);

// If no task is currently scheduled, reset the issued ids back to 0.
// If no task is currently scheduled, reset the issued ids back
// to 0.
if (tasks_.empty()) highest_id_ = 0;
}

Expand All @@ -129,9 +132,10 @@ namespace crow

process_tasks();

timer_.expires_after(std::chrono::seconds(1));
timer_.expires_after(DurationType(1));
timer_.async_wait(
std::bind(&task_timer::tick_handler, this, std::placeholders::_1));
std::bind(&task_timer::tick_handler,
this, std::placeholders::_1));
}

private:
Expand All @@ -140,9 +144,12 @@ namespace crow
asio::basic_waitable_timer<clock_type> timer_;
std::map<identifier_type, std::pair<time_type, task_type>> tasks_;

// A continuosly increasing number to be issued to threads to identify them.
// If no tasks are scheduled, it will be reset to 0.
// A continuosly increasing number to be issued to threads to
// identify them. If no tasks are scheduled, it will be reset to 0.
identifier_type highest_id_{0};
};

using default_task_timer = task_timer<>;
using milliseconds_task_timer = task_timer<std::chrono::milliseconds>;
} // namespace detail
} // namespace crow
15 changes: 7 additions & 8 deletions tests/unittest.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3839,26 +3839,25 @@ TEST_CASE("task_timer")
bool a = false;
bool b = false;

crow::detail::task_timer timer(io_service);
crow::detail::milliseconds_task_timer timer(io_service);
CHECK(timer.get_default_timeout() == 5);
timer.set_default_timeout(7);
CHECK(timer.get_default_timeout() == 7);
timer.set_default_timeout(50);
CHECK(timer.get_default_timeout() == 50);

timer.schedule([&a]() {
a = true;
},
5);
}, 5);
timer.schedule([&b]() {
b = true;
});

this_thread::sleep_for(chrono::seconds(4));
this_thread::sleep_for(chrono::milliseconds(4));
CHECK(a == false);
CHECK(b == false);
this_thread::sleep_for(chrono::seconds(2));
this_thread::sleep_for(chrono::milliseconds(26));
CHECK(a == true);
CHECK(b == false);
this_thread::sleep_for(chrono::seconds(2));
this_thread::sleep_for(chrono::milliseconds(30));
CHECK(a == true);
CHECK(b == true);

Expand Down

0 comments on commit 3328412

Please sign in to comment.