ost::Runable(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::Runable — the manual page, but make it make sense 💖

okay bestie, gather round, because we're talking about ost::Runable from the GNU CommonC++ library functions manual, and honestly? it's giving quietly essential. no cap. ✨

🌸 NAME 🌸

ost::Runable — a container for objects that can be queued against a runlist.

like… it's the little box your object lives in while it waits its turn. iconic behavior fr fr. 🎀

🦋 SYNOPSIS 🦋

#include <misc.h>

✨ Public Member Functions ✨

  • bool starting (Runlist *list) — start the object against a run list. 🚀
  • void stoping (void) — stop the object, called when stopping or ready completes.

🔒 Protected Member Functions 🔒

  • Runable ()
  • virtual ~Runable ()
  • virtual void ready (void)=0 — the method handler that gets invoked when a wait-listed object becomes ready to run. (yes, the =0 is there, she's pure virtual and she knows it 💅)

🫶 Friends 🫶

  • class Runlist

🌈 Detailed Description 🌈

A container for objects that can be queued against a runlist.

Author: David Sugar dyfet@ostel.com

runable object with notify when ready.

that's the whole vibe, honestly — you sit in the runlist, and when your moment comes, you get notified. main character energy only. 👑

🎀 Constructor & Destructor Documentation 🎀

ost::Runable::Runable () [protected]

virtual ost::Runable::~Runable () [protected], [virtual]

⭐ Member Function Documentation ⭐

virtual void ost::Runable::ready (void) [protected], [pure virtual]

Method handler that is invoked when a wait-listed object becomes ready to run.

bool ost::Runable::starting (Runlist * list)

Start the object against a run list.

Returns: true if immediately available to run.

Parameters: list to start under.

void ost::Runable::stoping (void)

Stop the object, called when stopping or ready completes. May also be used for a task that has not yet started to remove it from the wait list.

heads up bestie: yes, it's spelled stoping with one p. do NOT "fix" it, that's literally the function name. copy it exactly or the compiler will simply pass away. 💀

friend class Runlist [friend]

👑 Author 👑

Generated automatically by Doxygen for GNU CommonC++ from the source code.

and that's the whole page, bestie 🫶 this one came from the GNU CommonC++ crew, dated Sun Dec 27 2020, and it's page ost::Runable(3) in the manual — slay, go queue something. 🌸✨💅

📦 where this page comes from