is_pending

Author: pavel-kirienko

include/olga_scheduler/olga_scheduler.h

@@ -136,6 +136,14 @@ static inline void olga_cancel(olga_t* const self, olga_event_t* const event)
     event->deadline = INT64_MIN;
 }
 
+/// True if the event is currently pending in the scheduler.
+static inline bool olga_is_pending(const olga_t* const self, const olga_event_t* const event)
+{
+    assert(self != NULL);
+    assert(event != NULL);
+    return cavl2_is_inserted(self->events, &event->base);
+}
+
 /// Execute pending events strictly in the order of their deadlines until there are no pending events left.
 /// Events with the same deadline are executed in the FIFO order.
 /// The handler receives a freshly sampled `now` taken immediately before invocation.

tests/test_olga_scheduler_c.cpp

@@ -202,6 +202,31 @@ TEST(OlgaSchedulerC, Cancel)
     EXPECT_EQ(log.ids, (std::vector<int>{ 2 }));
 }
 
+TEST(OlgaSchedulerC, IsPending)
+{
+    TestClock clock{ .now = 0 };
+    olga_t    sched;
+    olga_init(&sched, &clock, clock_now);
+
+    CallbackCtx  ctx{ .log = nullptr, .id = 0, .expected_deadline = INT64_MIN, .clock = &clock, .advance_by = 0 };
+    olga_event_t evt = OLGA_EVENT_INIT;
+
+    EXPECT_FALSE(olga_is_pending(&sched, &evt));
+
+    olga_defer(&sched, 100, &ctx, record_handler, &evt);
+    EXPECT_TRUE(olga_is_pending(&sched, &evt));
+
+    olga_cancel(&sched, &evt);
+    EXPECT_FALSE(olga_is_pending(&sched, &evt));
+
+    olga_defer(&sched, 100, &ctx, record_handler, &evt);
+    EXPECT_TRUE(olga_is_pending(&sched, &evt));
+
+    clock.now = 100;
+    (void)olga_spin(&sched);
+    EXPECT_FALSE(olga_is_pending(&sched, &evt));
+}
+
 TEST(OlgaSchedulerC, OverdueSingle)
 {
     TestClock clock{ .now = 0 };