rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle Struct Reference

Inheritance diagram for rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle:

Collaboration diagram for rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle:

Public Member Functions
	CallbackGroupHandle (CBGScheduler &scheduler, CallbackGroupType type)
	CallbackGroupHandle (const CallbackGroupHandle &)=delete
	CallbackGroupHandle (CallbackGroupHandle &&)=delete
CallbackGroupHandle &	operator= (const CallbackGroupHandle &)=delete
CallbackGroupHandle &	operator= (CallbackGroupHandle &&)=delete
virtual std::function< void(size_t)>	get_ready_callback_for_entity (const rclcpp::SubscriptionBase::WeakPtr &entity)=0
virtual std::function< void(std::function< void()> executed_callback)>	get_ready_callback_for_entity (const rclcpp::TimerBase::WeakPtr &entity)=0
virtual std::function< void(size_t)>	get_ready_callback_for_entity (const rclcpp::ClientBase::WeakPtr &entity)=0
virtual std::function< void(size_t)>	get_ready_callback_for_entity (const rclcpp::ServiceBase::WeakPtr &entity)=0
virtual std::function< void(size_t, int)>	get_ready_callback_for_entity (const rclcpp::Waitable::WeakPtr &entity)=0
virtual std::function< void(size_t)>	get_ready_callback_for_entity (const CallbackEventType &entity)=0
void	mark_as_executed ()
CallbackGroupType	get_type ()
bool	is_ready ()

Public Attributes
bool	in_queue = false

Protected Member Functions
virtual bool	has_ready_entities () const =0
template<typename add_fun >
void	add_ready_entity (const add_fun &fun)
void	mark_as_skipped ()
void	mark_as_executing ()

Protected Attributes
CBGScheduler &	scheduler
std::mutex	ready_mutex

Detailed Description

Definition at line 60 of file scheduler.hpp.

Member Function Documentation

add_ready_entity()

template<typename add_fun >

void rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle::add_ready_entity ( const add_fun &  fun )

inlineprotected

Executes the given function to add an entity under the ready mutex. Afterwards the function checks if the scheduler needs to be informed that the callback group got ready and informs it if needed.

Definition at line 129 of file scheduler.hpp.

References rclcpp::executors::cbg_executor::CBGScheduler::callback_group_ready().

Here is the call graph for this function:

has_ready_entities()

virtual bool rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle::has_ready_entities ( ) const

protectedpure virtual

Will always be called under lock of ready_mutex

Implemented in rclcpp::executors::cbg_executor::FirstInFirstOutCallbackGroupHandle.

Referenced by mark_as_executed().

Here is the caller graph for this function:

mark_as_executed()

void rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle::mark_as_executed ( )

inline

Marks the last removed ready entity as executed.

Definition at line 91 of file scheduler.hpp.

References rclcpp::executors::cbg_executor::CBGScheduler::callback_group_ready(), and has_ready_entities().

Referenced by rclcpp::executors::cbg_executor::CBGScheduler::mark_entity_as_executed().

Here is the call graph for this function:

Here is the caller graph for this function:

mark_as_executing()

void rclcpp::executors::cbg_executor::CBGScheduler::CallbackGroupHandle::mark_as_executing ( )

inlineprotected

Must be called by derived classes if a ready entity is returned. This call must happen under a lock holding the ready_mutex.

Definition at line 161 of file scheduler.hpp.

---

The documentation for this struct was generated from the following file:

• rclcpp/src/rclcpp/executors/events_cbg_executor/scheduler.hpp