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

#include <state_file.hpp>

Inheritance diagram for winss::SuperviseStateFile:

Collaboration diagram for winss::SuperviseStateFile:

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...

SuperviseStateFile &	operator= (const SuperviseStateFile &)=delete
	No copy. More...

SuperviseStateFile &	operator= (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_dir The 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]	state	The state of the supervisor.
[in]	is_up	Hints 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

Supervisor listener handler.

Parameters

[in]	notification	The event which occurred.
[in]	state	The current state of the supervisor.

Returns: Always true.

Implements winss::SuperviseListener.

References winss::Utils::ConvertToISOString(), winss::SuperviseState::exit_code, FILESYSTEM, winss::SuperviseState::initially_up, winss::SuperviseState::is_run_process, winss::SuperviseState::is_up, winss::SuperviseTmpl< TMutex, TProcess >::kFinishFile, winss::SuperviseTmpl< TMutex, TProcess >::kRunFile, winss::SuperviseState::last, winss::SuperviseState::pid, winss::SuperviseState::remaining_count, winss::SuperviseState::time, and winss::SuperviseState::up_count.

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

Read the state of the supervisor from the file.

Parameters

[out] state The state of the supervisor.

Returns: True if the state read was successful otherwise false.

References winss::Utils::ConvertFromISOString(), winss::SuperviseState::exit_code, FILESYSTEM, winss::SuperviseState::initially_up, winss::SuperviseState::is_run_process, winss::SuperviseState::is_up, winss::SuperviseState::last, winss::SuperviseState::pid, winss::SuperviseState::remaining_count, winss::SuperviseState::time, and winss::SuperviseState::up_count.

Referenced by winss::SuperviseStateListener::HandleConnected().

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:

/home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/supervise/state_file.hpp
/home/docs/checkouts/readthedocs.org/user_builds/winss/checkouts/stable/lib/winss/supervise/state_file.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation