deskflow::ArgsBase Class Reference

This is the base Argument class that will store the generic arguments passed into the applications this will be derived from and expanded to include application specific arguments. More...

#include <ArgsBase.h>

Inheritance diagram for deskflow::ArgsBase:

Public Types
enum class	ClassType { Base , Server , Client }
	This sets the type of the derived class. More...

Public Member Functions
	ArgsBase ()=default
virtual	~ArgsBase ()=default

Public Attributes
ClassType	m_classType = ClassType::Base
	Stores what type of object this is.
bool	m_daemon = true
	Should run as a daemon.
bool	m_restartable = true
	Should the app restart automatically.
bool	m_noHooks = false
	Should the app use hooks.
const char *	m_pname = nullptr
	The filename of the running process.
const char *	m_logFilter = nullptr
	The logging level of the application.
const char *	m_logFile = nullptr
	The full path to the logfile.
const char *	m_display = nullptr
	Contains the X-Server display to use.
std::string	m_name
	The name of the current computer.
bool	m_disableTray = false
	Should the app add a tray icon.
bool	m_shouldExitOk = false
	Will cause the application to exit with OK code when set to true.
bool	m_shouldExitFail = false
	Will cause the application to exit with fail code when set to true.
std::string	m_deskflowAddress
	Bind to this address.
bool	m_enableCrypto = false
	Should the connections be TLS encrypted.
std::string	m_tlsCertFile
	Contains the location of the TLS certificate file.
bool	m_preventSleep = false
	Stop this computer from sleeping.

Static Protected Member Functions
template<class T>
static void	destroy (T *&p)
	deletes pointers and sets the value to null

Detailed Description

This is the base Argument class that will store the generic arguments passed into the applications this will be derived from and expanded to include application specific arguments.

Member Enumeration Documentation

ClassType

enum class deskflow::ArgsBase::ClassType

strong

This sets the type of the derived class.

Enumerator
Base
Server
Client

Constructor & Destructor Documentation

ArgsBase()

deskflow::ArgsBase::ArgsBase ( )

default

~ArgsBase()

virtual deskflow::ArgsBase::~ArgsBase ( )

virtualdefault

Member Function Documentation

destroy()

template<class T>

void deskflow::ArgsBase::destroy ( T *& p )

inlinestaticprotected

deletes pointers and sets the value to null

Member Data Documentation

m_classType

ClassType deskflow::ArgsBase::m_classType = ClassType::Base

Stores what type of object this is.

m_daemon

bool deskflow::ArgsBase::m_daemon = true

Should run as a daemon.

m_deskflowAddress

std::string deskflow::ArgsBase::m_deskflowAddress

Bind to this address.

m_disableTray

bool deskflow::ArgsBase::m_disableTray = false

Should the app add a tray icon.

m_display

const char* deskflow::ArgsBase::m_display = nullptr

Contains the X-Server display to use.

m_enableCrypto

bool deskflow::ArgsBase::m_enableCrypto = false

Should the connections be TLS encrypted.

m_logFile

const char* deskflow::ArgsBase::m_logFile = nullptr

The full path to the logfile.

m_logFilter

const char* deskflow::ArgsBase::m_logFilter = nullptr

The logging level of the application.

m_name

std::string deskflow::ArgsBase::m_name

The name of the current computer.

m_noHooks

bool deskflow::ArgsBase::m_noHooks = false

Should the app use hooks.

m_pname

const char* deskflow::ArgsBase::m_pname = nullptr

The filename of the running process.

m_preventSleep

bool deskflow::ArgsBase::m_preventSleep = false

Stop this computer from sleeping.

m_restartable

bool deskflow::ArgsBase::m_restartable = true

Should the app restart automatically.

m_shouldExitFail

bool deskflow::ArgsBase::m_shouldExitFail = false

Will cause the application to exit with fail code when set to true.

m_shouldExitOk

bool deskflow::ArgsBase::m_shouldExitOk = false

Will cause the application to exit with OK code when set to true.

m_tlsCertFile

std::string deskflow::ArgsBase::m_tlsCertFile

Contains the location of the TLS certificate file.

---

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

• src/lib/deskflow/ArgsBase.h