MClientLib classes

MClientLib classes. More...

Data Structures
class	MAlarm
	Class holding an alarm data. More...
class	MBackupJob
	Class holding a backup job query result. More...
class	MBackupQuery
	Class holding a backup job query result. More...
class	MBackupQueryBoundaries
	Class holding the backup database jobs boundaries result. More...
class	MChunk
	Class holding a chunk data. More...
class	MChunkUsage
	Class holding a chunk usage sample over time. More...
class	MClient
	Class holding a client connection details. More...
class	MDispatcherConfiguration
	Class holding a Dispatcher configuration. More...
class	MDispatcherConfigurationActions
	Class holding a Dispatcher actions section configuration. More...
class	MDispatcherConfigurationBehaviours
	Class holding a Dispatcher behaviours section configuration. More...
class	MDispatcherConfigurationDatabase
	Class holding a Dispatcher database section configuration. More...
class	MDispatcherConfigurationFaults
	Class holding a Dispatcher faults section configuration. More...
class	MDispatcherConfigurationGeneral
	Class holding a Dispatcher general section configuration. More...
class	MDispatcherConfigurationLDAP
	Class holding a Dispatcher LDAP configuration. More...
class	MDispatcherConfigurationLogs
	Class holding a Dispatcher logs section configuration. More...
class	MDispatcherConfigurationMailer
	Class holding a Dispatcher mailer section configuration. More...
class	MDispatcherConfigurationNetwork
	Class holding a Dispatcher network section configuration. More...
class	MDispatcherConfigurationNotificator
	Class holding a Dispatcher notificator section configuration. More...
class	MDispatcherConfigurationWebserver
	Class holding a Dispatcher web server section configuration. More...
class	MDispatcherStatistics
	Class holding a Dispatcher statistics sample. More...
class	MDrive
	Class holding a drive status data. More...
class	MDriveMap
	Class holding a Windows static drive mapping entry. More...
class	MFramesRange
	Class holding an API frames range object. More...
class	MGroup
	Class holding a user group. More...
class	MHistoryChunk
	Class holding an history chunk. More...
class	MJob
	Class holding a job data structure. More...
class	MJobFramesCheck
	Class holding a job frames check behaviours. More...
class	MLog
	Class holding a log entry data. More...
class	MMFGroup
	Class holding a missing frames group data. More...
class	MNClient
	Class holding a client connection details. More...
class	MNode
	Class holding an instance entry. More...
class	MNodeConfigurationTuning
	Class holding a node tuning configurations data. More...
class	MPoolItem
	Class holding a pool item entry (an instance) More...
class	MPriorityOverride
	Class holding a priority override rule. More...
struct	MProcessSnapshot
	Class holding a process entry in a processes snapshot. More...
class	MRepository
	Class holding an entry of a repository. More...
class	MSamplesBoundaries
	Class holding a samples boundaries for an history query. More...
class	MServerStatus
	Class holding the status of a Dispatcher service. More...
class	MStatisticsSample
	Class holding a statistics sample. More...
class	MStringRef
	Class holding a string used across the API. More...
class	MTemplateVariable
	Class holding an entry of a template variable. More...
class	MTextFileMarker
	Class holding a chunk data. More...
class	MTextFileRule
	lass holding a chunk data More...
class	MUser
	Class holding an entry for a user. More...
struct	MUSTER
	Client lib MUSTER session structure. More...
struct	MUSTERAUTH
	Structure holding a Muster login authorization result. More...
class	MUSTERERR
	Class holding an API error object. More...

Typedefs
typedef struct MClientLib::MUSTERAUTH	MUSTERAUTH
	Structure holding a Muster login authorization result. More...

Enumerations
enum	kAlarmType {   kProcDrop, kProcOver, kInstanceProcDrop, kInstanceProcOver,   kRamOver, kProcRamOver, kSwapOver, kDiskUsageOver,   kCustomAlarm }
	Enumeration of alarms types. More...
enum	kChunksStatus {   kChunkStatusOnHold = 0x01, kChunkStatusSubmitted = 0x02, kChunkStatusCompleted = 0x04, kChunkStatusWarning = 0x08,   kChunkStatusError = 0x10 }
	Chunk status enumeration. More...
enum	kDispatcherSupportedFeatures { kSupportIconsStreaming = 0x1, kSupportTemplatesAndPoolsUserFiltering = 0x2 }
enum	kDriveMappingsConnectionPolicies { kOnServiceStartup, kOnJobStartup }
enum	kDriveMappingsDisconnectionPolicies { kOnServiceShutdown, kOnJobEnd, kOnNever }
enum	kErrorChecksType { kDefaultErrorCheck, kSkipWarnings, kSkipErrors, kSkipBoth }
	Job error check type enumeration. More...
enum	kFramesCheckFileMode { kFramesCheckFileNone, kFramesCheckFileSize, kFramesCheckFileBoundaries }
	Job frames check file check enumeration. More...
enum	kFramesCheckMode { kFramesCheckNone, kFramesCheckJob, kFramesCheckChunk }
	Job frames check mode enumeration. More...
enum	kHistoryChunksStatus {   kHistoryChunkStatusCompleted = 0x01, kHistoryChunkStatusWarning = 0x02, kHistoryChunkStatusAborted = 0x04, kHistoryChunkStatusError = 0x08,   kHistoryChunkStatusTimeout = 0x10 }
enum	kInstancesStatus {   kInstanceStatusUndefined = 0x00, kInstanceStatusIdle = 0x01, kInstanceStatusPaused = 0x02, kInstanceStatusCompleted = 0x04,   kInstanceStatusInprogress = 0x08, kInstanceStatusStarting = 0x10, kInstanceStatusPrechunk = 0x20, kInstanceStatusPostchunk = 0x1000,   kInstanceStatusStreamingTemplates = 0x2000, kInstanceStatusJustKilledTheProcess = 0x4000, kInstanceStatusRequiresUpgrade = 0x8000, kInstanceStatusLockedByTimetable = 0x10000,   kInstanceStatusLockedByLoggedUser = 0x20000, kInstanceStatusOffline = 0x40000, kInstanceStatusLockedByProcess = 0x80000, kInstanceStatusLockedByPython = 0x100000,   kInstanceStatusRegularQueue = 0x200000, kInstanceStatusEmergencyQueue = 0x400000, kInstanceStatusLockedByInstance = 0x800000, kInstanceStatusLockedByReserv = 0x1000000 }
enum	kJobsBackupAction { kJobsBackupActionNone = 0x00, kJobsBackupActionOverwriteExistings = 0x01, kJobsBackupActionDuplicateEntry = 0x02 }
	Job backup restore operation action modes enumeration. More...
enum	kJobsBackupRestoreAction {   kJobsBackupRestoreActionNone = 0x00, kJobsBackupRestoreActionOverwriteExistings = 0x01, kJobsBackupRestoreActionDuplicateEntry = 0x02, kJobsBackupRestoreActionRestoreParents = 0x04,   kJobsBackupRestoreActionReparent = 0x08 }
	Job backup restore action enumeration. More...
enum	kJobsBackupRestoreState { kJobsBackupRestoreNone, kJobsBackupRestoreObjectsExist = 0x01, kJobsBackupRestoreMissingParents = 0x02 }
	Job backup restore operation conflicts enumeration. More...
enum	kJobsBackupStates { kJobsBackupStatesNone = 0x00, kJobsBackupStatesObjectExist = 0x01 }
	Job backup conflic state enumeration. More...
enum	kJobsChunksPrioritiesType {   kRampingDown, kRampingUp, kCenterUp, kCenterDown,   kInterleavedDown, kInterleavedUp }
	Job chunks priority mode enumeration. More...
enum	kJobsCompletationStatus {   kJobCompletionStatusSuccessfull, kJobCompletionStatusProcessStartingError, kJobCompletionStatusLogParsingWarning, kJobCompletionStatusLogParsingError,   kJobCompletionStatusExitCodeWarning, kJobCompletionStatusExitCodeError, kJobCompletionStatusPreChunkActionError, kJobCompletionStatusPostChunkActionError }
	Job completion status enumeration. More...
enum	kJobsDependLinkMode { kJobDependLinkOnJob = 0, kJobDependLinkOnChunks }
	Job dependancies link mode enumeration. More...
enum	kJobsDependMode { kJobDependUncompleted = -1, kJobDependSuccess, kJobDependWarnings, kJobDependErrors }
	Job dependancies type enumeration. More...
enum	kJobsNotificationsType { kNotificationsDisabled, kNotificationsOnComplete, kNotificationsOnWarning, kNotificationsOnError }
	Job notifications type enumeration. More...
enum	kJobsPriorityMode { kFoldersPriorityDefault, kFoldersPriorityFlatten, kFoldersPriorityCumulative }
	Enumeration holding the priority calculation mode used in getFoldersPriorityMode() and setFoldersPriorityMode() More...
enum	kJobsStatus {   kJobStatusOnQueue = 0x01, kJobStatusStarted = 0x02, kJobStatusInprogressWarnings = 0x04, kJobStatusInprogressErrors = 0x08,   kJobStatusPreJobAction = 0x10, kJobStatusPostJobAction = 0x20, kJobStatusPendingPreJobAction = 0x40, kJobStatusPendingPostJobAction = 0x80,   kJobStatusPendingFramecheck = 0x100, kJobStatusFramecheck = 0x200, kJobStatusJobCompleted = 0x400, kJobStatusCompletedWithWarnings = 0x800,   kJobStatusCompletedWithErrors = 0x1000, kJobStatusPendingPostJobPyAction = 0x2000, kJobStatusPostJobPyAction = 0x4000, kJobStatusLocked = 0x100000,   kJobStatusArchived = 0x200000, kJobStatusPaused = 0x400000, kJobEmergencyQueue = 0x800000, kJobRegularQueue = 0x1000000,   kJobStatusUnlocked = 0x2000000, kJobStatusUnarchived = 0x4000000, kJobStatusUnpaused = 0x8000000 }
	Job status enumeration. More...
enum	kJobsType { kJobTypeJob, kJobTypeFolder }
	Job types enumeration. More...
enum	kLogsSource { kLogSourceSystem = 0x01, kLogSourceUser = 0x02, kLogSourceInstanceWithSuccess = 0x04, kLogSourceInstanceWithFailure = 0x08 }
enum	kMissingFramesStatus {   kMissingFrameStatusValid, kMissingFrameStatusMissing, kMissingFrameStatusSizeError, kMissingFrameStatusFileOpenError,   kMissingFrameStatusDimensionsError }
	Job frmae check result enumeration. More...
enum	kProcessPriorityLevel { kProcessPriorityIdle = 1, kProcessPriorityNormal = 2, kProcessPriorityHigh = 3, kProcessPriorityRealtime = 4 }
enum	kPropertyOverride { kPropertyDisabled, kPropertyEnabled }
	Enumeration of a property override status. More...
enum	kPropertyOverride { kPropertyInherited, kPropertyDisabled, kPropertyEnabled }
	Properties overrides enumerations. More...
enum	kScope { kScopeGlobal, kScopeUser, kScopeClient }
	Enumeration of repositories scopes. More...
enum	kSystemEvents {   kSysEventShutdown, kSysEventSuspend, kSysEventIbernate, kSysEventRestart,   kSysEventForceLogout, kSysEventWakeup }
enum	kTextFileMarkerType {   kFileMarkerPass = 0x00, kFileMarkerNone = 0x01, kFileMarkerError = 0x02, kFileMarkerWarning = 0x03,   kFileMarkerSilenceError = 0x04, kFileMarkerSilenceWarning = 0x05 }
enum	kTextFileRuleAction {   kRulePass = 0x00, kRuleNone = 0x01, kRuleError = 0x02, kRuleWarning = 0x03,   kRuleSilenceError = 0x04, kRuleSilenceWarning = 0x05 }
enum	kTextFileRuleErrorExtractMode { kExtractExactString = 0x00, kExtractUntilLineEnding = 0x01, kExtractUntilMarker = 0x02, kExtractUntilMarkerOrLineEnding = 0x03 }
enum	kTextFileRulePositionType { kMatchAnyPositionInLine, kMustMatchAtLineBeginning }
enum	kTextFileRuleType { kStringMatch = 0x00, kRegExpMatch = 0x01 }
enum	kLicenseStatus { kLicenseStatusSuccess = 0x01, kLicenseStatusInvalid = 0x02, kLicenseStatusTemporary = 0x03, kLicenseStatusExpired = 0x04 }
	Enumeratation holding the current Dispatcher licensing status. More...
typedef std::map< std::string, itemAttribute >	itemAttributesMap
typedef struct MClientLib::itemAttribute	itemAttribute
	itemAttribute structure that holds the status of an item inside the MPropertiesMap More...
typedef struct MClientLib::MUSTER	MUSTER
	Client lib MUSTER session structure. More...
typedef struct MClientLib::MUSTERCLIENT	MUSTERCLIENT
	Client lib MUSTERCLIENT session structure. More...

Detailed Description

MClientLib classes.

Collection of the MClientLib classes

Typedef Documentation

typedef struct MClientLib::itemAttribute itemAttribute

itemAttribute structure that holds the status of an item inside the MPropertiesMap

typedef std::map<std::string, itemAttribute> itemAttributesMap

Declares an item attributes map type

Definition at line 52 of file MProperties.h.

typedef struct MClientLib::MUSTER MUSTER

Client lib MUSTER session structure.

Define a session structure. The MUSTER session structure is used for connections versus the Dispatcher service

typedef struct MClientLib::MUSTERAUTH MUSTERAUTH

Structure holding a Muster login authorization result.

Holds data related to an authorization result after a successfully login

typedef struct MClientLib::MUSTERCLIENT MUSTERCLIENT

Client lib MUSTERCLIENT session structure.

Define a session structure. The MUSTERCLIENT session structure is used for connections versus a renderclient service

Enumeration Type Documentation

enum kAlarmType

Enumeration of alarms types.

Enumerates an alarm type

Enumerator
kProcDrop	Processor usages dropped below a certain threshold
kProcOver	Processor usages gone over a certain threshold
kInstanceProcDrop	Instance processor usages dropped below a certain threshold
kInstanceProcOver	Instance processor usages gone over a certain threshold

Definition at line 78 of file MAlarm.h.

enum kChunksStatus

Chunk status enumeration.

Enumerates the status of a chunk

Enumerator
kChunkStatusOnHold	The chunk is on hold waiting to be processed
kChunkStatusSubmitted	The chunk has been submitted and is currently being processed
kChunkStatusCompleted	The chunk has been processed successfully
kChunkStatusWarning	The chunk has been processed with at least a warning
kChunkStatusError	The chunk has been processed with at least an error

Definition at line 71 of file MChunk.h.

enum kDispatcherSupportedFeatures

Enumerator
kSupportIconsStreaming	Dispatcher supports icons streaming
kSupportTemplatesAndPoolsUserFiltering	Dispatcher supports pools and templates filtering

Definition at line 63 of file MServerStatus.h.

enum kDriveMappingsConnectionPolicies

Connection policies enumeration Enumerates the connection policies of a drive mapping entry

Enumerator
kOnServiceStartup	Maps the drive on service startup
kOnJobStartup	Maps the drive on a job startup

Definition at line 66 of file MDriveMap.h.

enum kDriveMappingsDisconnectionPolicies

Disconnection policies enumeration Enumerates the disconnection policies of a drive mapping entry

Enumerator
kOnServiceShutdown	Disconnects the drive on service shutdown
kOnJobEnd	Disconnects the drive on a job completion
kOnNever	Do not disconnect the mapped drive

Definition at line 73 of file MDriveMap.h.

enum kErrorChecksType

Job error check type enumeration.

Enumerates a job error check type

Enumerator
kDefaultErrorCheck	Uses default error check
kSkipWarnings	Skip warnings
kSkipErrors	Skip errors
kSkipBoth	Skip warnings and errors

Definition at line 208 of file MJob.h.

enum kFramesCheckFileMode

Job frames check file check enumeration.

Enumerates the file check mode on a frames check

Enumerator
kFramesCheckFileNone	Do not check files sizes
kFramesCheckFileSize	Checks an exact files sizes
kFramesCheckFileBoundaries	Checks file sizes between valid boundaries

Definition at line 231 of file MJob.h.

enum kFramesCheckMode

Job frames check mode enumeration.

Enumerates a job frames check mode

Enumerator
kFramesCheckNone	No frames check
kFramesCheckJob	Check frames at the end of the job and requeue just the wrong frames
kFramesCheckChunk	Check frames at the end of a chunk and requeue the entire chunk in case of failure

Definition at line 220 of file MJob.h.

enum kHistoryChunksStatus

History chunk status enumeration Enumerates the status of an history chunk

Enumerator
kHistoryChunkStatusCompleted	The chunk has been completed
kHistoryChunkStatusWarning	The chunk has been completed with warnings
kHistoryChunkStatusAborted	The chunk has been aborted
kHistoryChunkStatusError	The chunk has been completed with errors
kHistoryChunkStatusTimeout	The chunk has been aborted due to a timeout

Definition at line 72 of file MHistoryChunk.h.

enum kInstancesStatus

Status enumeration Enumerates an instance status

Enumerator
kInstanceStatusUndefined	Instance status is undefined
kInstanceStatusIdle	Instance is idle
kInstanceStatusPaused	Instance is paused
kInstanceStatusCompleted	Instance just completed a job
kInstanceStatusInprogress	Instance is processing a job
kInstanceStatusStarting	Instance is starting a job
kInstanceStatusPrechunk	Instance is performing a pre chunk action
kInstanceStatusPostchunk	Instance is performing a post chunk action
kInstanceStatusStreamingTemplates	Instance is streaming templates changes
kInstanceStatusJustKilledTheProcess	Instance just killed the job process
kInstanceStatusRequiresUpgrade	Instance requires an update
kInstanceStatusLockedByTimetable	Instance is locked by the time table
kInstanceStatusLockedByLoggedUser	Instance is locked by a logged user
kInstanceStatusOffline	Instance is offline
kInstanceStatusLockedByProcess	Instance is locked by a running process
kInstanceStatusLockedByPython	Instance is locked by python evaluation
kInstanceStatusRegularQueue	Instance is working on a regular priority job
kInstanceStatusEmergencyQueue	Instance is working on an emergency priority job
kInstanceStatusLockedByReserv	< Instance is locked by another instance requesting more resources

Definition at line 87 of file MNode.h.

enum kJobsBackupAction

Job backup restore operation action modes enumeration.

Enumerates a job backup restore operation action mode

Enumerator
kJobsBackupActionNone	No errors
kJobsBackupActionOverwriteExistings	Overwrites existing backups entries
kJobsBackupActionDuplicateEntry	Creates a new copy into the backup

Definition at line 306 of file MJob.h.

enum kJobsBackupRestoreAction

Job backup restore action enumeration.

Enumerates a job backup restore operation action modes

Enumerator
kJobsBackupRestoreActionNone	No errors
kJobsBackupRestoreActionOverwriteExistings	Overwrites existing backups entries
kJobsBackupRestoreActionDuplicateEntry	Creates a new copy into the backup
kJobsBackupRestoreActionRestoreParents	Restores job parents too
kJobsBackupRestoreActionReparent	Reparent job to a new folder

Definition at line 328 of file MJob.h.

enum kJobsBackupRestoreState

Job backup restore operation conflicts enumeration.

Enumerates a job backup restore operation conflict states

Enumerator
kJobsBackupRestoreNone	No errors
kJobsBackupRestoreObjectsExist	Object already exists
kJobsBackupRestoreMissingParents	Missing object original parents

Definition at line 317 of file MJob.h.

enum kJobsBackupStates

Job backup conflic state enumeration.

Enumerates a job backup operation conflict state

Enumerator
kJobsBackupStatesNone	No errors
kJobsBackupStatesObjectExist	Object already exists in the backup

Definition at line 296 of file MJob.h.

enum kJobsChunksPrioritiesType

Job chunks priority mode enumeration.

Enumerates a job chunks priority mode

Enumerator
kRampingDown	Ending chunks have the highest priority
kRampingUp	Beginning chunks have the highest priority
kCenterUp	Centering chunks have the highest priority
kCenterDown	Centering chunks have the lowest priority
kInterleavedDown	Interleaves the priority giving less priority to the beginning chunks
kInterleavedUp	Interleaves the priority giving more priority to the beginning chunks

Definition at line 282 of file MJob.h.

enum kJobsCompletationStatus

Job completion status enumeration.

Enumerates a job completion status

Enumerator
kJobCompletionStatusSuccessfull	Job has been processed successfully
kJobCompletionStatusProcessStartingError	Job failed to start due to a process spawn error
kJobCompletionStatusLogParsingWarning	Job has warnings inside the log
kJobCompletionStatusLogParsingError	Job has errors inside the log
kJobCompletionStatusExitCodeWarning	Job returned an exit code flagged as warning
kJobCompletionStatusExitCodeError	Job returned an exit code flagged as error
kJobCompletionStatusPreChunkActionError	Job reported an error during the pre chunk action
kJobCompletionStatusPostChunkActionError	Job reported an error during the post chunk action

Definition at line 254 of file MJob.h.

enum kJobsDependLinkMode

Job dependancies link mode enumeration.

Enumerates a job dependancies link mode

Enumerator
kJobDependLinkOnJob	Depends on a job
kJobDependLinkOnChunks	Depends on the status on another job's chunks

Definition at line 198 of file MJob.h.

enum kJobsDependMode

Job dependancies type enumeration.

Enumerates a job dependancies status

Enumerator
kJobDependUncompleted	Depends on an uncompleted job
kJobDependSuccess	Depends on a job with a full success, no errors and no warnings
kJobDependWarnings	Depends on a job with no errors, but accepts warnings
kJobDependErrors	Depends on a completed job, even it has errors and warnings

Definition at line 186 of file MJob.h.

enum kJobsNotificationsType

Job notifications type enumeration.

Enumerates a job notification type

Enumerator
kNotificationsDisabled	Disables notifications
kNotificationsOnComplete	Notify on completion of job or chunk
kNotificationsOnWarning	Notify on completion of job or chunk if there's a warning or an error
kNotificationsOnError	Notify on completion of job or chunk if there's an error

Definition at line 270 of file MJob.h.

enum kJobsPriorityMode

Enumeration holding the priority calculation mode used in getFoldersPriorityMode() and setFoldersPriorityMode()

Enumerator
kFoldersPriorityDefault	Default priority
kFoldersPriorityFlatten	Flatten folders and jobs
kFoldersPriorityCumulative	Sums folders and jobs priorities

Definition at line 315 of file MConfiguration.h.

enum kJobsStatus

Job status enumeration.

Enumerates a job status

Enumerator
kJobStatusOnQueue	The Job is on queue
kJobStatusStarted	The Job has started
kJobStatusInprogressWarnings	The Job is in progress and has warnings
kJobStatusInprogressErrors	The Job is in progress and has errors
kJobStatusPreJobAction	The Job is executing a pre job action
kJobStatusPostJobAction	The Job is executing a post job action
kJobStatusPendingPreJobAction	The Job is pending the execution of a pre job action
kJobStatusPendingPostJobAction	The Job is pending the execution of a post job action
kJobStatusPendingFramecheck	The Job is pending the execution of a frame check action
kJobStatusFramecheck	The Job is executing a frame check action
kJobStatusJobCompleted	The Job is completed
kJobStatusCompletedWithWarnings	The Job is completed and has warnings
kJobStatusCompletedWithErrors	The Job is completed and has errors
kJobStatusPendingPostJobPyAction	The Job is pending the execution of a post job Python action
kJobStatusPostJobPyAction	The Job is executing a post job Python action
kJobStatusLocked	Fake status, used in filtering masks
kJobStatusArchived	Fake status, used in filtering masks
kJobStatusPaused	Fake status, used in filtering masks
kJobEmergencyQueue	Fake status, used in filtering masks
kJobRegularQueue	Fake status, used in filtering masks
kJobStatusUnlocked	Fake status, used in filtering masks
kJobStatusUnarchived	Fake status, used in filtering masks
kJobStatusUnpaused	Fake status, used in filtering masks

Definition at line 144 of file MJob.h.

enum kJobsType

Job types enumeration.

Enumerates a job object type

Enumerator
kJobTypeJob	The job is a real job
kJobTypeFolder	The job is a folder

Definition at line 176 of file MJob.h.

enum kLicenseStatus

Enumeratation holding the current Dispatcher licensing status.

Enumerator
kLicenseStatusSuccess	Dispatcher is licensed successfully
kLicenseStatusInvalid	Dispatcher has an invalid license
kLicenseStatusTemporary	Dispatcher is running with a temporary license
kLicenseStatusExpired	Dispatcher has an expired license

Definition at line 58 of file MConfiguration.h.

enum kLogsSource

Source enumeration Enumerates the log source

Enumerator
kLogSourceSystem	Log comes from the system
kLogSourceUser	Log comes from a user action
kLogSourceInstanceWithSuccess	Log comes from an instance success
kLogSourceInstanceWithFailure	Log comes from an instance failure or warning

Definition at line 67 of file MLog.h.

enum kMissingFramesStatus

Job frmae check result enumeration.

Enumerates the result of a frame check

Enumerator
kMissingFrameStatusValid	Frames are valid
kMissingFrameStatusMissing	Some frames are missing
kMissingFrameStatusSizeError	Some frames have an invalid size
kMissingFrameStatusFileOpenError	Cannot open file as image file
kMissingFrameStatusDimensionsError	Cannot open file as image file

Definition at line 241 of file MJob.h.

enum kProcessPriorityLevel

Processes priorities enumeration

Definition at line 114 of file MNode.h.

enum kPropertyOverride

Enumeration of a property override status.

Enumerates a property override status

Enumerator
kPropertyDisabled	Property is disabled
kPropertyEnabled	Proerty is enabled

Definition at line 99 of file MGroup.h.

enum kPropertyOverride

Properties overrides enumerations.

Defines how a property is overriden from inherited groups

Enumerator
kPropertyInherited	Property is inherited
kPropertyDisabled	Property is disasbled
kPropertyEnabled	Property is enabled

Definition at line 175 of file MUser.h.

enum kScope

Enumeration of repositories scopes.

Enumerates a repository scope, used in MRepository::setScope()

Enumerator
kScopeGlobal	The repository is global
kScopeUser	The repository is user side
kScopeClient	The repository is client side

Definition at line 71 of file MRepository.h.

enum kSystemEvents

System events enumeration

Definition at line 122 of file MNode.h.

enum kTextFileMarkerType

Text file marker type enumeration Enumerates the type of text marker into a log line

Enumerator
kFileMarkerPass	Pass parsing to the template code
kFileMarkerNone	Do not mark as any kind of error or warning
kFileMarkerError	Marks an error
kFileMarkerWarning	Marks a warning
kFileMarkerSilenceError	Marks a skippable error line
kFileMarkerSilenceWarning	Marks a skippable warning line

Definition at line 72 of file MTextFileMarker.h.

enum kTextFileRuleAction

Text file rules action Enumerates the type of actions for a matched text file rule in a log line

Enumerator
kRulePass	Do not handle the line marker, pass to the template custom handler
kRuleNone	Handle the line marker as no-error, do not pass to the template custom handler
kRuleError	Marks as an error
kRuleWarning	Marks as warning
kRuleSilenceError	Marks as a silenced error
kRuleSilenceWarning	Marks as a silenced warning

Definition at line 100 of file MTextFileRule.h.

enum kTextFileRuleErrorExtractMode

Text file rules error extraction mode Enumerates the type of text extraction modes for a log line

Definition at line 91 of file MTextFileRule.h.

enum kTextFileRulePositionType

Text file rules position types enumeration Enumerates the type of text file rules position for a log line

Definition at line 84 of file MTextFileRule.h.

enum kTextFileRuleType

Text file rules types enumeration Enumerates the type of text file rules for a log line

Enumerator
kStringMatch	String must be present in the line
kRegExpMatch	Regular expression must match in the line

Definition at line 77 of file MTextFileRule.h.