openlcb::BroadcastTimeServerSet Class Reference

State machine for sending the clock set sequence. More...

Inheritance diagram for openlcb::BroadcastTimeServerSet:

Public Member Functions
	BroadcastTimeServerSet (BroadcastTimeServer *server)
	Constuctor.
	~BroadcastTimeServerSet ()
	Destructor.
void	request_set (uint16_t suffix)
	Request a time parameter set.
Public Member Functions inherited from CallableFlow< BroadcastTimeServerSetInput >
	CallableFlow (Service *s)
	Creates a callable flow.
Public Member Functions inherited from StateFlow< MessageType, QueueType >
	StateFlow (Service *service)
	Constructor.
Public Member Functions inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
	TypedStateFlow (Service *service)
	Constructor.
virtual	~TypedStateFlow ()
	Destructor.
void	send (MessageType *msg, unsigned priority=UINT_MAX) OVERRIDE
	Sends a message to the state flow for processing.
Public Member Functions inherited from UntypedStateFlow< QueueType >
	UntypedStateFlow (Service *service)
	Constructor.
Public Member Functions inherited from StateFlowWithQueue
void	notify () override
	Wakeup call arrived. Schedules *this on the executor.
bool	is_waiting ()
Public Member Functions inherited from StateFlowBase
void	run () override
	Callback from the executor.
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.
Public Member Functions inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_next ()
Public Member Functions inherited from FlowInterface< MessageType >
virtual Pool *	pool ()
virtual MessageType *	type_helper ()
	This function is never user in the code, but GDB can use it to infer the correct message types.
MessageType *	alloc ()
	Synchronously allocates a message buffer from the pool of this flow.
void	alloc_async (Executable *target)
	Asynchronously allocates a message buffer from the pool of this flow.

Private Member Functions
Action	entry () override
	Set a clock attribute and send the appropriate event report.
Action	write_done ()
	The previous event write has completed.
Action	send_sync ()
	Request the sync sequence if timer has not been triggered early.
	DISALLOW_COPY_AND_ASSIGN (BroadcastTimeServerSet)

Private Attributes
BroadcastTimeServer *	server_
	reference to our parent
WriteHelper	writer_
	helper for sending event messages
StateFlowTimer	timer_
	timer helper
uint8_t	requestCount_
	counter to know when there are no more requests

Additional Inherited Members
Public Types inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
typedef Base::Action	Action
	Allows using Action without having StateFlowBase:: prefix in front of it.
Public Types inherited from FlowInterface< MessageType >
typedef MessageType	message_type
	Stores the message template type for external reference.
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.
Static Public Member Functions inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	link_head ()
static Atomic *	head_mu ()
	Locks the list for modification (at any entry!).
Static Public Member Functions inherited from FlowInterface< MessageType >
static MessageType *	cast_alloc (QMember *entry)
	Down casts and initializes an asynchronous allocation result to the appropriate flow's buffer type.
Protected Types inherited from CallableFlow< BroadcastTimeServerSetInput >
using	Action = StateFlowBase::Action
Protected Types inherited from UntypedStateFlow< QueueType >
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.
Protected Types inherited from StateFlowBase
typedef Action(StateFlowBase::*	Callback) ()
	State Flow callback prototype.
Protected Member Functions inherited from CallableFlow< BroadcastTimeServerSetInput >
BroadcastTimeServerSetInput *	request ()
bool	has_request ()
Action	return_ok ()
	Terminates the flow and returns the request buffer to the caller with an error code of OK (zero).
Action	wait_and_return_ok ()
	Waits to be notified before moving onto the next state for termination.
Action	wait_done ()
	Terminates the flow and returns the request buffer to the caller with an error code of OK (zero).
Action	return_with_error (int error)
	Terminates the flow and returns the request buffer to the caller with an specific error code.
Protected Member Functions inherited from TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >
void	release () OVERRIDE
	Unrefs the current buffer.
void	return_buffer ()
	For state flows that are operated using invoke_subflow_and_wait this is a way to hand back the buffer to the caller.
MessageType *	message ()
MessageType *	transfer_message ()
	Releases ownership of the current message.
Protected Member Functions inherited from UntypedStateFlow< QueueType >
void	send (BufferBase *msg, unsigned priority=UINT_MAX)
	Sends a message to the state flow for processing.
QMember *	queue_next (unsigned *priority) OVERRIDE
	Takes the front entry in the queue.
bool	queue_empty () OVERRIDE
Action	call_immediately (Callback c)
	Imediately call the next state upon return.
Protected Member Functions inherited from StateFlowWithQueue
	StateFlowWithQueue (Service *service)
	Constructor.
Action	exit ()
	Terminates the processing of this flow.
Action	release_and_exit ()
	Terminates the processing of the current message.
BufferBase *	message ()
BufferBase *	transfer_message ()
	Releases ownership of the current message.
void	reset_message (BufferBase *message, unsigned priority)
	Sets the current message being processed.
unsigned	priority ()
void	set_priority (unsigned priority)
	Overrides the current priority.
void	start_flow_at_init (Callback c)
	Call this from the constructor of the child class to do some work before the main queue processing loop begins.
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 Member Functions inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_this ()
	LinkedObject ()
	Constructor. Puts *this on the linked list.
	~LinkedObject ()
	Constructor. Removes *this from the linked list.
StateFlowWithQueue *	link_next ()
Static Protected Member Functions inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	link_head ()
static Atomic *	head_mu ()
	Locks the list for modification (at any entry!).
Protected Attributes inherited from QMember
QMember *	next
	pointer to the next member in the queue
Protected Attributes inherited from LinkedObject< StateFlowWithQueue >
StateFlowWithQueue *	link_
	Linked list pointer.
Static Protected Attributes inherited from LinkedObject< StateFlowWithQueue >
static StateFlowWithQueue *	head_
	Beginning of the list.

Detailed Description

State machine for sending the clock set sequence.

Definition at line 502 of file BroadcastTimeServer.cxx.

Constructor & Destructor Documentation

BroadcastTimeServerSet()

openlcb::BroadcastTimeServerSet::BroadcastTimeServerSet ( BroadcastTimeServer *  server )

inline

Constuctor.

Parameters

server

reference to our parent

Definition at line 508 of file BroadcastTimeServer.cxx.

~BroadcastTimeServerSet()

openlcb::BroadcastTimeServerSet::~BroadcastTimeServerSet ( )

inline

Destructor.

Definition at line 519 of file BroadcastTimeServer.cxx.

Member Function Documentation

entry()

Action openlcb::BroadcastTimeServerSet::entry ( )

inlineoverrideprivatevirtual

Set a clock attribute and send the appropriate event report.

Returns

write_done()

Implements TypedStateFlow< MessageType, UntypedStateFlow< QueueType > >.

Definition at line 541 of file BroadcastTimeServer.cxx.

request_set()

void openlcb::BroadcastTimeServerSet::request_set ( uint16_t  suffix )

inline

Request a time parameter set.

Parameters

suffix

the clock set event suffix

Definition at line 525 of file BroadcastTimeServer.cxx.

send_sync()

Action openlcb::BroadcastTimeServerSet::send_sync ( )

inlineprivate

Request the sync sequence if timer has not been triggered early.

Returns

return_ok()

Definition at line 631 of file BroadcastTimeServer.cxx.

write_done()

Action openlcb::BroadcastTimeServerSet::write_done ( )

inlineprivate

The previous event write has completed.

Returns

next state send_sync after 3 second delay if no more pening requests, else if requests pending, return_ok()

Definition at line 617 of file BroadcastTimeServer.cxx.

Member Data Documentation

requestCount_

uint8_t openlcb::BroadcastTimeServerSet::requestCount_

private

counter to know when there are no more requests

Definition at line 644 of file BroadcastTimeServer.cxx.

server_

BroadcastTimeServer* openlcb::BroadcastTimeServerSet::server_

private

reference to our parent

Definition at line 641 of file BroadcastTimeServer.cxx.

timer_

StateFlowTimer openlcb::BroadcastTimeServerSet::timer_

private

timer helper

Definition at line 643 of file BroadcastTimeServer.cxx.

writer_

WriteHelper openlcb::BroadcastTimeServerSet::writer_

private

helper for sending event messages

Definition at line 642 of file BroadcastTimeServer.cxx.

---

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

• BroadcastTimeServer.cxx