ExecutorWatchdog Class Reference

This stateflow checks an executor every 50 msec. More...

#include <ExecutorWatchdog.hxx>

Inheritance diagram for ExecutorWatchdog:

Public Member Functions
	ExecutorWatchdog (Service *service)
	Constructor.
Public Member Functions inherited from StateFlowBase
void	run () override
	Callback from the executor.
void	notify () override
	Wakeup call arrived.
Service *	service ()
	Return a pointer to the service I am bound to.
Public Member Functions inherited from Executable
void	test_deletion ()
Public Member Functions inherited from QMember
void	init ()
	Initiailize a QMember, in place of a public placement construction.

Private Member Functions
Action	take_stamp ()
Action	woken ()

Private Attributes
StateFlowTimer	timer_ {this}
uint32_t	lastTimeMsec_ {0}
	Timestamp when we last went to sleep.
int	count_ {0}
	Counter that controls printing a heartbeat message that we are fine.

Additional Inherited Members
Static Public Member Functions inherited from StateFlowBase
template<class T , typename... Args>
static void	invoke_subflow_and_ignore_result (FlowInterface< Buffer< T > > *target_flow, Args &&... args)
	Calls a helper flow to perform some actions.
Protected Types inherited from StateFlowBase
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.
Protected Member Functions inherited from StateFlowBase
	StateFlowBase (Service *service)
	Constructor.
	~StateFlowBase ()
	Destructor.
void	reset_flow (Callback c)
	Resets the flow to the specified state.
bool	is_state (Callback c)
bool	is_terminated ()
void	start_flow (Callback c)
	Resets the flow to the specified state and starts it.
Action	again ()
	Call the current state again via call_immediately.
Action	exit ()
	Terminate current StateFlow activity.
Action	delete_this ()
	Terminates the flow and deletes *this.
Action	set_terminated ()
	Sets the flow to terminated state.
Action	call_immediately (Callback c)
	Imediately call the next state upon return.
Action	wait ()
	Wait for an asynchronous call.
Action	wait_and_call (Callback c)
	Wait for resource to become available before proceeding to next state.
template<class T >
Action	allocate_and_call (FlowInterface< Buffer< T > > *target_flow, Callback c, Pool *pool=nullptr)
	Allocates a buffer from a pool and proceed to the next state when allocation is successful.
Action	allocate_and_call (Callback c, QAsync *queue)
	Allocates an entry from an asynchronous queue, and transitions to a state once the allocation is complete.
template<class T >
Buffer< T > *	full_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
T *	full_allocation_result (TypedQAsync< T > *queue)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
void	cast_allocation_result (T **member)
	Takes the result of the asynchronous allocation without resetting the object.
template<class T >
Buffer< T > *	get_allocation_result (FlowInterface< Buffer< T > > *target_flow)
	Takes the result of the asynchronous allocation.
Action	yield_and_call (Callback c)
	Place the current flow to the back of the executor, and transition to a new state after we get the CPU again.
Action	yield ()
	Place the current flow to the back of the executor, and re-try the current state after we get the CPU again.
Action	sleep_and_call (::Timer *timer, long long timeout_nsec, Callback c)
	Suspends execution of this control flow for a specified time.
template<class T , typename... Args>
Action	invoke_subflow_and_wait (FlowInterface< Buffer< T > > *target_flow, Callback c, Args &&... args)
	Calls a helper flow to perform some actions.
Action	read_repeated (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read and then invokes the next state.
Action	read_single (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size_t bytes, and blocks the caller until at least one byte is read.
Action	read_nonblocking (StateFlowSelectHelper *helper, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Attempts to read at most size bytes, and then invokes the next state, even if only zero bytes are available right now.
Action	read_repeated_with_timeout (StateFlowTimedSelectHelper *helper, long long timeout_nsec, int fd, void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Blocks until size bytes are read, or a timeout expires.
Action	internal_try_read ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on reading.
Action	write_repeated (StateFlowSelectHelper *helper, int fd, const void *buf, size_t size, Callback c, unsigned priority=Selectable::MAX_PRIO)
	Writes some data into a file descriptor, repeating the operation as necessary until all bytes are written.
Action	internal_try_write ()
	Implementation state that gets repeatedly called upon every wakeup and tries to make progress on writing.
Protected Member Functions inherited from QMember
	QMember ()
	Constructor.
	~QMember ()
	Destructor.
Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue

Detailed Description

This stateflow checks an executor every 50 msec.

If the latency of a wakeup is more than 50 msec, then prints a warning of how long the executor was blocked.

Definition at line 45 of file ExecutorWatchdog.hxx.

Constructor & Destructor Documentation

ExecutorWatchdog()

ExecutorWatchdog::ExecutorWatchdog ( Service *  service )

inline

Constructor.

Parameters

service

defines which executor to watch.

Definition at line 50 of file ExecutorWatchdog.hxx.

Member Function Documentation

take_stamp()

Action ExecutorWatchdog::take_stamp ( )

inlineprivate

Definition at line 57 of file ExecutorWatchdog.hxx.

woken()

Action ExecutorWatchdog::woken ( )

inlineprivate

Definition at line 63 of file ExecutorWatchdog.hxx.

Member Data Documentation

count_

int ExecutorWatchdog::count_ {0}

private

Counter that controls printing a heartbeat message that we are fine.

Definition at line 84 of file ExecutorWatchdog.hxx.

lastTimeMsec_

uint32_t ExecutorWatchdog::lastTimeMsec_ {0}

private

Timestamp when we last went to sleep.

Definition at line 82 of file ExecutorWatchdog.hxx.

timer_

StateFlowTimer ExecutorWatchdog::timer_ {this}

private

Definition at line 80 of file ExecutorWatchdog.hxx.

---

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

• ExecutorWatchdog.hxx