Specialization of BroadcastTimeAlarm meant to expire at each minute. More...

#include <BroadcastTimeAlarm.hxx>

Inheritance diagram for openlcb::BroadcastTimeAlarmMinute:

Public Member Functions
	BroadcastTimeAlarmMinute (Node node, BroadcastTime clock, std::function< void(BarrierNotifiable *)> callback)
	Constructor.

	~BroadcastTimeAlarmMinute ()
	Destructor.

Public Member Functions inherited from openlcb::BroadcastTimeAlarm
	BroadcastTimeAlarm (Node node, BroadcastTime clock, std::function< void(BarrierNotifiable *)> callback)
	Constructor.

	~BroadcastTimeAlarm ()
	Destructor.

void	set_period (time_t period)
	Start the alarm to expire at the given period from now.

void	set (time_t time)
	Start the alarm to expire at the given fast time.

void	clear ()
	Inactivate the alarm.

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	entry () override
	Entry point of the state machine.

void	reset_expired_time (bool force_on_match=false)
	Reset the expired time based on what time it is now.

void	expired_callback (BarrierNotifiable *done)
	callback for when the alarm expires

void	update_notify () override
	Called when the clock time has changed.

	DISALLOW_COPY_AND_ASSIGN (BroadcastTimeAlarmMinute)

Private Attributes
std::function< void(BarrierNotifiable *)>	callbackUser_
	callback for when alarm expires

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 Member Functions inherited from Atomic
void	lock ()

void	unlock ()

Protected Attributes inherited from openlcb::BroadcastTimeAlarm
BroadcastTime *	clock_
	clock that our alarm is based off of

Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue

Detailed Description

Specialization of BroadcastTimeAlarm meant to expire at each minute.

Definition at line 389 of file BroadcastTimeAlarm.hxx.

Constructor & Destructor Documentation

◆ BroadcastTimeAlarmMinute()

openlcb::BroadcastTimeAlarmMinute::BroadcastTimeAlarmMinute	(	Node *	node,
		BroadcastTime *	clock,
		std::function< void(BarrierNotifiable *)>	callback
	)

inline

Constructor.

Parameters

node	the virtual node that our StateFlowBase service will be derived from
clock	clock that our alarm is based off of
callback	callback for when alarm expires

Definition at line 397 of file BroadcastTimeAlarm.hxx.

◆ ~BroadcastTimeAlarmMinute()

openlcb::BroadcastTimeAlarmMinute::~BroadcastTimeAlarmMinute ( )

inline

Destructor.

Definition at line 408 of file BroadcastTimeAlarm.hxx.

Member Function Documentation

◆ entry()

Action openlcb::BroadcastTimeAlarmMinute::entry ( )

inlineoverrideprivatevirtual

Entry point of the state machine.

Returns: BroadcastTimeAlarm::entry();

Reimplemented from openlcb::BroadcastTimeAlarm.

Definition at line 415 of file BroadcastTimeAlarm.hxx.

◆ expired_callback()

void openlcb::BroadcastTimeAlarmMinute::expired_callback ( BarrierNotifiable * done )

inlineprivate

callback for when the alarm expires

Parameters

done	used to notify we are finished

Definition at line 451 of file BroadcastTimeAlarm.hxx.

◆ reset_expired_time()

void openlcb::BroadcastTimeAlarmMinute::reset_expired_time ( bool force_on_match = false )

inlineprivate

Reset the expired time based on what time it is now.

Parameters

force_on_match true to force an expiration if on a minute rollover boundary

Definition at line 425 of file BroadcastTimeAlarm.hxx.

◆ update_notify()

void openlcb::BroadcastTimeAlarmMinute::update_notify ( )

inlineoverrideprivatevirtual

Called when the clock time has changed.

Reimplemented from openlcb::BroadcastTimeAlarm.

Definition at line 458 of file BroadcastTimeAlarm.hxx.

Member Data Documentation

◆ callbackUser_

std::function<void(BarrierNotifiable *)> openlcb::BroadcastTimeAlarmMinute::callbackUser_

private

callback for when alarm expires

Definition at line 465 of file BroadcastTimeAlarm.hxx.

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

BroadcastTimeAlarm.hxx

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BroadcastTimeAlarmMinute()

◆ ~BroadcastTimeAlarmMinute()

Member Function Documentation

◆ entry()

◆ expired_callback()

◆ reset_expired_time()

◆ update_notify()

Member Data Documentation

◆ callbackUser_