Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openlcb::ReinitAllNodes Class Reference

StateFlow that iterates through all local nodes and sends out node initialization complete for each of them. More...

#include <NodeInitializeFlow.hxx>

Inheritance diagram for openlcb::ReinitAllNodes:
StateFlowBase Executable Notifiable QMember Destructable

Public Member Functions

 ReinitAllNodes (If *iface)
 
- Public Member Functions inherited from StateFlowBase
void run () override
 Callback from the executor.
 
void notify () override
 Wakeup call arrived.
 
Serviceservice ()
 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 allocate_entry ()
 
Action send_init_request ()
 
Action init_done ()
 
InitializeFlowtgt ()
 
Ififace ()
 

Private Attributes

NodenextNode_
 Which node to send identify next. If nullptr, we're done.
 
BarrierNotifiable bn_
 

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
QMembernext
 pointer to the next member in the queue
 

Detailed Description

StateFlow that iterates through all local nodes and sends out node initialization complete for each of them.

Used when a TCP disconnect event causes us to lose network connectivity and later the connection gets reestablished.

Definition at line 156 of file NodeInitializeFlow.hxx.

Constructor & Destructor Documentation

◆ ReinitAllNodes()

openlcb::ReinitAllNodes::ReinitAllNodes ( If iface)
inline

Definition at line 158 of file NodeInitializeFlow.hxx.

Member Function Documentation

◆ allocate_entry()

Action openlcb::ReinitAllNodes::allocate_entry ( )
inlineprivate

Definition at line 164 of file NodeInitializeFlow.hxx.

◆ iface()

If * openlcb::ReinitAllNodes::iface ( )
inlineprivate

Definition at line 188 of file NodeInitializeFlow.hxx.

◆ init_done()

Action openlcb::ReinitAllNodes::init_done ( )
inlineprivate

Definition at line 179 of file NodeInitializeFlow.hxx.

◆ send_init_request()

Action openlcb::ReinitAllNodes::send_init_request ( )
inlineprivate

Definition at line 171 of file NodeInitializeFlow.hxx.

◆ tgt()

InitializeFlow * openlcb::ReinitAllNodes::tgt ( )
inlineprivate

Definition at line 184 of file NodeInitializeFlow.hxx.

Member Data Documentation

◆ bn_

BarrierNotifiable openlcb::ReinitAllNodes::bn_
private

Definition at line 194 of file NodeInitializeFlow.hxx.

◆ nextNode_

Node* openlcb::ReinitAllNodes::nextNode_
private

Which node to send identify next. If nullptr, we're done.

Definition at line 193 of file NodeInitializeFlow.hxx.


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