vlink::DiscoveryReporter Class Reference

Background MessageLoop that reports active nodes to the discovery subsystem. More...

#include <discovery_reporter.h>

Inheritance diagram for vlink::DiscoveryReporter:

Collaboration diagram for vlink::DiscoveryReporter:

Public Member Functions
	DiscoveryReporter ()
	Constructs the reporter and starts its background loop.
	~DiscoveryReporter () override
	Destructor – sends an offline notification and stops the loop.
void	add (NodeImpl *node)
	Registers a NodeImpl endpoint for periodic reporting.
void	remove (NodeImpl *node)
	Unregisters a NodeImpl endpoint from periodic reporting.
Public Member Functions inherited from vlink::MessageLoop
	MessageLoop ()
	Constructs a MessageLoop with kNormalType queue.
	MessageLoop (Type type)
	Constructs a MessageLoop with the specified queue type.
virtual	~MessageLoop ()
	Destructor. Calls quit(true) and waits for the background thread (if any).
void	set_name (const std::string &name)
	Sets a human-readable name for this loop (visible in profiling tools).
const std::string &	get_name () const
	Returns the name set via set_name().
Type	get_type () const
	Returns the queue type this loop was constructed with.
Strategy	get_strategy () const
	Returns the current idle dispatch strategy.
void	set_strategy (Strategy strategy)
	Changes the idle dispatch strategy.
void	register_begin_handler (Callback &&callback)
	Registers a callback invoked once when the loop thread starts.
void	register_end_handler (Callback &&callback)
	Registers a callback invoked once when the loop thread exits.
void	register_idle_handler (Callback &&callback)
	Registers a callback invoked each time the task queue becomes empty.
bool	run ()
	Runs the message loop on the calling thread (blocking).
bool	async_run ()
	Starts the message loop on a new background thread (non-blocking).
bool	spin ()
	Runs the loop continuously in a spin mode (blocking; no background thread).
bool	spin_once (bool block=true)
	Processes one batch of pending tasks and timers.
bool	quit (bool force=false)
	Requests the loop to exit cleanly.
bool	wait_for_idle (int ms=Timer::kInfinite, bool check=true)
	Waits until the task queue is drained.
bool	wait_for_quit (int ms=Timer::kInfinite, bool check=true)
	Waits until the loop has fully exited (after quit() was called).
bool	post_task (Callback &&callback)
	Posts a task to the queue for execution on the loop thread.
bool	post_task_with_priority (Callback &&callback, uint16_t priority)
	Posts a task with an explicit priority (requires kPriorityType loop).
template<typename CallbackT, typename = std::enable_if_t<!std::is_convertible_v<CallbackT, Schedule::RetCallback>>>
Schedule::Status	exec_task (const Schedule::Config &config, CallbackT &&callback)
	Posts a scheduled task and returns a Schedule::Status for chaining callbacks.
template<typename CallbackT, typename = std::enable_if_t<std::is_convertible_v<CallbackT, Schedule::RetCallback>>>
Schedule::RetStatus	exec_task (const Schedule::Config &config, CallbackT &&callback)
	Posts a scheduled task and returns a Schedule::RetStatus for chaining callbacks.
bool	wakeup ()
	Wakes the loop thread if it is sleeping (e.g., in kBlockStrategy).
void	reset_lockfree_capacity ()
	Resets the lock-free queue to its initial capacity.
bool	is_running () const
	Returns true if the loop is currently running (started and not quit).
bool	is_ready_to_quit () const
	Returns true if quit() has been called and the loop is winding down.
bool	is_busy () const
	Returns true if the loop is currently executing a task.
size_t	get_task_count () const
	Returns the number of tasks currently in the queue.
virtual size_t	get_max_timer_count () const
	Returns the maximum number of timers that can be attached to this loop.
virtual bool	is_in_same_thread () const
	Returns true if the calling thread is the same as the loop thread.
template<class FunctionT, class... ArgsT, typename ResultT = std::invoke_result_t<FunctionT, ArgsT...>>
std::future< ResultT >	invoke_task (FunctionT &&function, ArgsT &&... args)
	Dispatches a callable to the loop thread and returns a std::future for the result.
template<class FunctionT, class... ArgsT, typename ResultT = std::invoke_result_t<FunctionT, ArgsT...>>
std::future< ResultT >	invoke_task_with_priority (FunctionT &&function, uint16_t priority, ArgsT &&... args)
	Dispatches a callable with an explicit priority and returns a std::future.

Static Public Member Functions
static DiscoveryReporter *	global_get ()
	Returns the process-global DiscoveryReporter singleton.

Protected Member Functions
size_t	get_max_task_count () const override
	Returns the maximum queue depth.
uint32_t	get_max_elapsed_time () const override
	Returns the maximum allowed task execution time in milliseconds.
void	on_begin () override
	Called from the loop thread just before the first task is processed.
void	on_end () override
	Called from the loop thread just after the last task has been processed.
Protected Member Functions inherited from vlink::MessageLoop
virtual void	on_idle ()
	Called from the loop thread each time the queue becomes empty.
virtual void	on_task_changed (Callback &&callback, uint32_t start_time)
	Called before each task is executed.
virtual void	on_task_timeout (Callback &&callback, uint32_t elapsed_time)
	Called when a task's execution time exceeds get_max_elapsed_time().

Additional Inherited Members
Public Types inherited from vlink::MessageLoop
enum	Type : uint8_t { kNormalType = 0 , kLockfreeType = 1 , kPriorityType = 2 }
	Queue implementation type. More...
enum	Strategy : uint8_t { kOptimizationStrategy = 0 , kPopStrategy = 1 , kBlockStrategy = 2 }
	Idle strategy controlling CPU and latency trade-offs. More...
enum	Priority : uint16_t {   kNoPriority = 0 , kLowestPriority = 1 , kTimerPriority = 50 , kNormalPriority = 100 ,   kHighestPriority = std::numeric_limits<uint16_t>::max() }
	Pre-defined task priority levels for kPriorityType loops. More...
using	Callback = std::function<void()>
	Callback type for tasks and event handlers.

Detailed Description

Background MessageLoop that reports active nodes to the discovery subsystem.

Automatically started and stopped by the VLink runtime. Callers should not need to manage this object directly unless building custom tooling.

Constructor & Destructor Documentation

DiscoveryReporter()

vlink::DiscoveryReporter::DiscoveryReporter

(

)

Constructs the reporter and starts its background loop.

Here is the caller graph for this function:

~DiscoveryReporter()

vlink::DiscoveryReporter::~DiscoveryReporter ( )

override

Destructor – sends an offline notification and stops the loop.

Member Function Documentation

add()

void vlink::DiscoveryReporter::add

(

NodeImpl *

node

)

Registers a NodeImpl endpoint for periodic reporting.

Called automatically by NodeImpl on construction.

Parameters

node	Node to add.

get_max_elapsed_time()

uint32_t vlink::DiscoveryReporter::get_max_elapsed_time ( ) const

overrideprotectedvirtual

Returns the maximum allowed task execution time in milliseconds.

When a task exceeds this duration, on_task_timeout() is called. Returns 0 to disable timeout checking.

Returns

Maximum execution time in ms.

Reimplemented from vlink::MessageLoop.

get_max_task_count()

size_t vlink::DiscoveryReporter::get_max_task_count ( ) const

overrideprotectedvirtual

Returns the maximum queue depth.

Returns

kMaxTaskSize (10000) by default.

Reimplemented from vlink::MessageLoop.

global_get()

DiscoveryReporter * vlink::DiscoveryReporter::global_get ( )

static

Returns the process-global DiscoveryReporter singleton.

Created on first call. The singleton is destroyed when the process exits.

Returns

Raw pointer to the global DiscoveryReporter.

Here is the call graph for this function:

on_begin()

void vlink::DiscoveryReporter::on_begin ( )

overrideprotectedvirtual

Called from the loop thread just before the first task is processed.

Override in subclasses to perform per-thread initialisation.

Reimplemented from vlink::MessageLoop.

on_end()

void vlink::DiscoveryReporter::on_end ( )

overrideprotectedvirtual

Called from the loop thread just after the last task has been processed.

Override in subclasses to perform per-thread cleanup.

Reimplemented from vlink::MessageLoop.

Here is the call graph for this function:

remove()

void vlink::DiscoveryReporter::remove

(

NodeImpl *

node

)

Unregisters a NodeImpl endpoint from periodic reporting.

Called automatically by NodeImpl on destruction.

Parameters

node	Node to remove.

---

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

• include/vlink/extension/discovery_reporter.h