winss
Public Member Functions | Static Public Attributes | List of all members
winss::SuperviseStateFile Class Reference

Serializes the state file but can also read it as a human-readable message. More...

#include <state_file.hpp>

Inheritance diagram for winss::SuperviseStateFile:
Inheritance graph
[legend]
Collaboration diagram for winss::SuperviseStateFile:
Collaboration graph
[legend]

Public Member Functions

 SuperviseStateFile (fs::path service_dir)
 Supervise state file constructor. More...
 
 SuperviseStateFile (const SuperviseStateFile &)=delete
 No copy. More...
 
 SuperviseStateFile (SuperviseStateFile &&)=delete
 No move. More...
 
virtual const fs::path & GetPath () const
 Gets the path of the state file. More...
 
virtual bool Notify (winss::SuperviseNotification notification, const winss::SuperviseState &state)
 Supervisor listener handler. More...
 
virtual bool Read (winss::SuperviseState *state) const
 Read the state of the supervisor from the file. More...
 
virtual std::string Format (const winss::SuperviseState &state, bool is_up) const
 Format the state as a human-readable string. More...
 
SuperviseStateFileoperator= (const SuperviseStateFile &)=delete
 No copy. More...
 
SuperviseStateFileoperator= (SuperviseStateFile &&)=delete
 No move. More...
 
- Public Member Functions inherited from winss::SuperviseListener
virtual ~SuperviseListener ()
 Default virtual destructor. More...
 

Static Public Attributes

static const char kStateFile [] = "state"
 The state file name. More...
 

Detailed Description

Serializes the state file but can also read it as a human-readable message.

Constructor & Destructor Documentation

winss::SuperviseStateFile::SuperviseStateFile ( fs::path  service_dir)
explicit

Supervise state file constructor.

Parameters
service_dirThe service directory.
winss::SuperviseStateFile::SuperviseStateFile ( const SuperviseStateFile )
delete

No copy.

winss::SuperviseStateFile::SuperviseStateFile ( SuperviseStateFile &&  )
delete

No move.

Member Function Documentation

std::string winss::SuperviseStateFile::Format ( const winss::SuperviseState state,
bool  is_up 
) const
virtual

Format the state as a human-readable string.

Parameters
[in]stateThe state of the supervisor.
[in]is_upHints if the supervisor is currently up.
Returns
Human-readable string.

References winss::SuperviseState::exit_code, winss::SuperviseState::initially_up, winss::SuperviseState::is_run_process, winss::SuperviseState::is_up, winss::SuperviseState::last, winss::SuperviseState::pid, winss::SuperviseState::remaining_count, and winss::SuperviseState::up_count.

const fs::path & winss::SuperviseStateFile::GetPath ( ) const
virtual

Gets the path of the state file.

Returns
The state file path.
bool winss::SuperviseStateFile::Notify ( winss::SuperviseNotification  notification,
const winss::SuperviseState state 
)
virtual
SuperviseStateFile& winss::SuperviseStateFile::operator= ( const SuperviseStateFile )
delete

No copy.

SuperviseStateFile& winss::SuperviseStateFile::operator= ( SuperviseStateFile &&  )
delete

No move.

bool winss::SuperviseStateFile::Read ( winss::SuperviseState state) const
virtual

Member Data Documentation

const char winss::SuperviseStateFile::kStateFile = "state"
static

The state file name.


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