BlinkerFlow Class Reference

Reusable test flow that just blinks a pair of events. More...

#include <BlinkerFlow.hxx>

Inheritance diagram for BlinkerFlow:

Public Member Functions
	BlinkerFlow (openlcb::Node *node, uint64_t BLINKER_EVENT_ID)
	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	blinker ()
	State that handles sending off the produced event.
Action	handle_sleep ()
	State that sleeps until the next event is due.

Private Attributes
uint8_t	state_
	Which event we produced last.
openlcb::MemoryBit< uint8_t >	bit_
	Helper object for the event producer.
openlcb::BitEventProducer	producer_
	The actual producer object.
openlcb::WriteHelper	helper_
	Helper object to write to the bus in an asynchronous way.
StateFlowTimer	sleepData_
	Object needed for sleeping in a state flow.
BarrierNotifiable	n_
	Helper object for catching callback notifications.

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

Reusable test flow that just blinks a pair of events.

Definition at line 43 of file BlinkerFlow.hxx.

Constructor & Destructor Documentation

BlinkerFlow()

BlinkerFlow::BlinkerFlow ( openlcb::Node *  node, uint64_t  BLINKER_EVENT_ID  )

inline

Constructor.

Parameters

node	source node from which to send the blin events.
BLINKER_EVENT_ID	event id for one event; the other will be BLINKER_EVENT_ID + 1.

Definition at line 51 of file BlinkerFlow.hxx.

Member Function Documentation

blinker()

Action BlinkerFlow::blinker ( )

inlineprivate

State that handles sending off the produced event.

Returns

action.

Definition at line 64 of file BlinkerFlow.hxx.

handle_sleep()

Action BlinkerFlow::handle_sleep ( )

inlineprivate

State that sleeps until the next event is due.

Returns

action.

Definition at line 75 of file BlinkerFlow.hxx.

Member Data Documentation

bit_

openlcb::MemoryBit<uint8_t> BlinkerFlow::bit_

private

Helper object for the event producer.

Definition at line 83 of file BlinkerFlow.hxx.

helper_

openlcb::WriteHelper BlinkerFlow::helper_

private

Helper object to write to the bus in an asynchronous way.

Definition at line 87 of file BlinkerFlow.hxx.

n_

BarrierNotifiable BlinkerFlow::n_

private

Helper object for catching callback notifications.

Definition at line 91 of file BlinkerFlow.hxx.

producer_

openlcb::BitEventProducer BlinkerFlow::producer_

private

The actual producer object.

Definition at line 85 of file BlinkerFlow.hxx.

sleepData_

StateFlowTimer BlinkerFlow::sleepData_

private

Object needed for sleeping in a state flow.

Definition at line 89 of file BlinkerFlow.hxx.

state_

uint8_t BlinkerFlow::state_

private

Which event we produced last.

Definition at line 81 of file BlinkerFlow.hxx.

---

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

• BlinkerFlow.hxx