Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
AutoSyncFileFlow Class Reference

Simple state flow to configure automatic calls to fsync on a single file handle at regular intervals. More...

#include <AutoSyncFileFlow.hxx>

Inheritance diagram for AutoSyncFileFlow:
StateFlowBase Executable Notifiable QMember Destructable

Public Member Functions

 AutoSyncFileFlow (Service *service, int sync_fd, uint64_t interval=SEC_TO_NSEC(1))
 Constructor.
 
void shutdown (Notifiable *n)
 Requests the discontinuation of automatic calls to fsync.
 
- 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 sleep_and_call_sync ()
 
Action sync ()
 

Private Attributes

const int fd_
 
const uint64_t interval_
 
const std::string name_
 
StateFlowTimer timer_ {this}
 
bool shutdown_ {false}
 
NotifiableshutdownDone_ {nullptr}
 

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

Simple state flow to configure automatic calls to fsync on a single file handle at regular intervals.

Definition at line 44 of file AutoSyncFileFlow.hxx.

Constructor & Destructor Documentation

◆ AutoSyncFileFlow()

AutoSyncFileFlow::AutoSyncFileFlow ( Service service,
int  sync_fd,
uint64_t  interval = SEC_TO_NSEC(1) 
)
inline

Constructor.

Parameters
serviceis the Service to hook into for periodic callbacks.
sync_fdis the file handle to sync.
intervalis the interval at which to sync the file handle. Default is once per second.

Definition at line 53 of file AutoSyncFileFlow.hxx.

Member Function Documentation

◆ shutdown()

void AutoSyncFileFlow::shutdown ( Notifiable n)
inline

Requests the discontinuation of automatic calls to fsync.

Parameters
nis the Notifiable to call when this flow exits.

Definition at line 69 of file AutoSyncFileFlow.hxx.

◆ sleep_and_call_sync()

Action AutoSyncFileFlow::sleep_and_call_sync ( )
inlineprivate

Definition at line 88 of file AutoSyncFileFlow.hxx.

◆ sync()

Action AutoSyncFileFlow::sync ( )
inlineprivate

Definition at line 93 of file AutoSyncFileFlow.hxx.

Member Data Documentation

◆ fd_

const int AutoSyncFileFlow::fd_
private

Definition at line 81 of file AutoSyncFileFlow.hxx.

◆ interval_

const uint64_t AutoSyncFileFlow::interval_
private

Definition at line 82 of file AutoSyncFileFlow.hxx.

◆ name_

const std::string AutoSyncFileFlow::name_
private

Definition at line 83 of file AutoSyncFileFlow.hxx.

◆ shutdown_

bool AutoSyncFileFlow::shutdown_ {false}
private

Definition at line 85 of file AutoSyncFileFlow.hxx.

◆ shutdownDone_

Notifiable* AutoSyncFileFlow::shutdownDone_ {nullptr}
private

Definition at line 86 of file AutoSyncFileFlow.hxx.

◆ timer_

StateFlowTimer AutoSyncFileFlow::timer_ {this}
private

Definition at line 84 of file AutoSyncFileFlow.hxx.


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