MClientLib enumerations

MClientLib global enumerations. More...

Enumerations

enum  kIpVersion { kIPBoth = 0, kIPV4, kIPV6 }
 
enum  kLoginResponse {
  kLoginAdmin = 0x00, kLoginUser, kLoginGuest, kLoginDenied,
  kLoginDeniedLDAPDown
}
 
enum  kLogLevel { kLogLevelSevere = 1, kLogLevelInformation, kLogLevelExtended, kLogLevelDebug }
 
enum  kNetworkCommands {
  kD2HBegin = 0, kD2HStartProcess, kD2HKillProcess, kD2HKillProcessAndRestart,
  kD2HKillProcessAndPause, kD2HPauseNode, kD2HResumeNode, kD2HForceUpdate,
  kD2HSetProcessPriority, kD2HAckAndGoIdle, kD2HPulseHeartbeat, kD2HSoftRestartNode,
  kD2HEnableNodeLog, kD2HDisableNodeLog, kD2HSysEvent, kD2HChangePythonOutput,
  kD2HPythonCommand, kD2HTemplatesStreamingStarting, kD2HTemplatesStreamingCompleted, kD2HTemplatesStreamingEntry,
  kD2HTemplateContent, kD2HTemplatesHashesMap, kD2HTemplatesReconfigurationCompleted, kD2HTemplatesContentChanged,
  kD2HCustomMessage, kD2HSilenceAlarm, kD2HBorrowInstance, kD2HUnborrowInstance,
  kD2HStartReserv, kD2HTerminateReserv, kD2HEnd, kH2DBegin = 200,
  kH2DReportProcResult_WarningOnLog, kH2DReportProcResult_Success, kH2DReportProcResult_ErrorOnLog, kH2DReportProcResult_WarningOnExitcode,
  kH2DReportProcResult_ErrorOnExitcode, kH2DReportProcResult_ProcessSpawnFailure, kH2DReportProcResult_FailureOnPrechunkAction, kH2DReportProcResult_FailureOnPostchunkAction,
  kH2DStatus, kH2DIdle, kH2DPaused, kH2DPulseHeartbeat,
  kH2DClientID, kH2DLockedByLoggedUser, kH2DLockedByProcess, kH2DLockedByTimerule,
  kH2DLogChunk, kH2DUpdateUsage, kH2DPythonOutput, kH2DPythonErrOutput,
  kH2DLockedByPython, kH2DCustomMessage, kH2DRequestTemplates, kH2DRequestNextTemplatesStreamingEntry,
  kH2DRequestTemplatesHashesMap, kH2DRequestTemplate, kH2DAlarm, kH2DLockedByReserv,
  kH2DLockedByInstance, kH2DEnd, kN2DBegin = 400, kN2DNotifyLogin,
  kN2DPulseHeartbeat, kN2DCustomMessage, kN2DEnd, kD2NBegin = 600,
  kD2NNotify, kD2NLoginGranted, kD2NAccessDenied, kD2NCustomMessage,
  kD2NEnd, kC2DBegin = 800, kC2DRequestStatisticsBoundaries, kC2DStartStatisticsRequest,
  kC2DRequestNextStatisticsEntry, kC2DStartHistoryRequest, kC2DRequestNextHistoryEntry, kC2DStartChunksHistoryRequest,
  kC2DRequestNextChunksHistoryEntry, kC2DHistoryClearBounds, kC2DStatisticsClearBounds, kC2DDragJobToNewParent,
  kC2DLogin, kC2DSetNetMask, kC2DSendRegistration, kC2DQueryEngineStatus,
  kC2DSwapEngineStatus, kC2DStartLogsRequest, kC2DRequestNextLogsEntry, kC2DClearInternalLog,
  kC2DStartPathsRequest, kC2DRequestNextPathsEntry, kC2DStartUsersRequest, kC2DRequestNextUsersEntry,
  kC2DStartPoolsRequest, kC2DRequestNextPoolsEntry, kC2DStartJobsRequest, kC2DRequestNextJobsEntry,
  kC2DStartNodesRequest, kC2DRequestNextNodesEntry, kC2DStartChunksRequest, kC2DRequestNextChunksEntry,
  kC2DModifyJob, kC2DRenameJob, kC2DChangeJobPriority, kC2DChangeJobDepartment,
  kC2DChangeJobProject, kC2DChangeJobTemplate, kC2DSubmitJob, kC2DDeleteJob,
  kC2DChangeJobPool, kC2DChangeJobExcludedPool, kC2DChangeJobOwner, kC2DPauseJob,
  kC2DResumeJob, kC2DReinitJob, kC2DChangeJobDependancies, kC2DChangeJobDependanciesMode,
  kC2DChangeJobDependanciesLinkMode, kC2DChangeJobStartOn, kC2DChangeJobResumeOn, kC2DChangeJobPauseOn,
  kC2DUnlockJob, kC2DLockJob, kC2DArchiveJob, kC2DUnarchiveJob,
  kC2DImportQueue, kC2DExportQueue, kC2DPauseNode, kC2DResumeNode,
  kC2DKillNode, kC2DKillAndPauseNode, kC2DKillNodeAndRedoJob, kC2DChangeNodeProcessPriority,
  kC2DPurgeTemplatesExclusion, kC2DPurgeJobsExclusion, kC2DSoftRestartNode, kC2DSoftRestartDispatcher,
  kC2DKillAndPauseNodesWorkingOnJob, kC2DKillAndRedoNodesWorkingOnJob, kC2DKillAndGoOnNodesWorkingOnJob, kC2DPrepareBuffersForBigOP,
  kC2DRestoreBuffersAfterBigOP, kC2DChangePassword, kC2DForceStatisticsUpdate, kC2DResetStatisticsCounters,
  kC2DChangeNodeMemo, kC2DRemoveNodeRegistration, kC2DStartNetworkScan, kC2DRegisterNode,
  kC2DSendSystemEventToNode, kC2DSetChunkOnHold, kC2DSetChunkAsCompleted, kC2DRequestPreferences,
  kC2DSetPreferences, kC2DEnableNodeLog, kC2DDisableNodeLog, kC2DRequestActivityLogsList,
  kC2DRequestActivityLog, kC2DRemoveActivityLog, kC2DRequestActionsLogsList, kC2DRequestActionsLog,
  kC2DRemoveActionsLog, kC2DUpdateNodeWakeupStatus, kC2DAddFolder, kC2DChangeJobMemo,
  kC2DChangeJobMaximumInstances, kC2DForceNodeRefresh, kC2DSetMinimumLogicalUnits, kC2DSetMinimumCores,
  kC2DSetMinimumPhysicalUnits, kC2DSetMinimumCoresSpeed, kC2DSetMinimumRamAmount, kC2DSetMinimumDiskSpaceAmount,
  kC2DSetProcessValidExitCodes, kC2DSetProcessWarningExitCodes, kC2DSetProcessErrorExitCodes, kC2DStartUsersGroupsRequest,
  kC2DRequestNextUsersGroupsEntry, kC2DUpdateLDAPUsers, kC2DRequestLDAPSettings, kC2DConfigureLDAP,
  kC2DStartJobsUpdateRequest, kC2DRequestNextJobsUpdateEntry, kC2DAddUser, kC2DGetUser,
  kC2DConfigureUser, kC2DRemoveUser, kC2DAddGroup, kC2DGetGroup,
  kC2DConfigureGroup, kC2DRemoveGroup, kC2DGetJob, kC2DGetNode,
  kC2DGetChunk, kC2DSetEnvironment, kC2DChangeExitCodesCheck, kC2DChangeLogsCheck,
  kC2DChangeLogsRules, kC2DChangeMissingFramesCheck, kC2DChangeFramesPrefixPath, kC2DRequestPythonOutput,
  kC2DPythonCommand, kC2DChangeJobAttribute, kC2DRemoveJobAttribute, kC2DChangeChunksTimeout,
  kC2DChangeChunksMaximumRequeue, kC2DChangeJobMailNotifications, kC2DChangeChunksMailNotifications, kC2DChangeJobNotificatorNotifications,
  kC2DChangeChunksNotificatorNotifications, kC2DChangeJobMobileNotifications, kC2DChangeChunksMobileNotifications, kC2DChangeJobStartMailNotifications,
  kC2DChangeChunksStartMailNotifications, kC2DChangeJobStartNotificatorNotifications, kC2DChangeChunksStartNotificatorNotifications, kC2DChangeJobStartMobileNotifications,
  kC2DChangeChunksStartMobileNotifications, kC2DResetChunkRequeueCounter, kC2DRequestTemplatesHashesMap, kC2DRequestTemplate,
  kC2DPulseHeartbeat, kC2DUsersStreamingStarting, kC2DUsersStreamingEntry, kC2DUsersStreamingCompleted,
  kC2DUsersGroupsStreamingStarting, kC2DUsersGroupsStreamingEntry, kC2DUsersGroupsStreamingCompleted, kC2DPoolsStreamingStarting,
  kC2DPoolsStreamingEntry, kC2DPoolsStreamingCompleted, kC2DPathsStreamingStarting, kC2DPathsStreamingEntry,
  kC2DPathsStreamingCompleted, kC2DTemplatesHashesMap, kC2DTemplateContent, kC2DChangeJobCamera,
  kC2DChangeJobShot, kC2DChangeJobSequence, kC2DReindex, kC2DRestartFrameCheck,
  kC2DChangeJobEmergencyQueue, kC2DUpdateChunkErrors, kC2DWaitDbFlush, kC2DBackupJob,
  kC2DBackupAndDeleteJob, kC2DBackupRestoreJobs, kC2DBackupDeleteJobs, kC2DBackupQuery,
  kC2DBackupRequestBoundaries, kC2DBackupQueryRequestNextEntry, kC2DDispatcherRemoveBackupTables, kC2DImportJsonQueue,
  kC2DExportJsonQueue, kC2DImportSettings, kC2DExportSettings, kC2DImportJsonSettings,
  kC2DExportJsonSettings, kC2DImportConfig, kC2DExportConfig, kC2DRequestChunkStatistics,
  kC2DUpdateNodeSharedLogsStatus, kC2DRequestIconsHashesMap, kC2DRequestIcon, kC2DSendIcon,
  kC2DCustomMessage, kC2DSetMinimumPhysicalGPUsUnits, kC2DRequestAccountsConnections, kC2DTimedPauseNode,
  kC2DTimedResumeNode, kC2DQueryAlarms, kC2DSilenceAlarm, kC2DSetBorrowInstances,
  kC2DStartReserv, kC2DTerminateReserv, kC2DEnd, kD2CBegin = 1000,
  kD2CStatisticsBoundaries, kD2CStatisticsEntry, kD2CStatisticsStreamingStarting, kD2CStatisticsStreamingCompleted,
  kD2CHistoryEntry, kD2CHistoryStreamingStarting, kD2CHistoryStreamingCompleted, kD2CChunksHistoryEntry,
  kD2CChunksHistoryStreamingStarting, kD2CChunksHistoryStreamingCompleted, kD2CStatisticsBoundsCleared, kD2CHistoryBoundsCleared,
  kD2CPasswordChangeSuccess, kD2CConfigChangeSuccess, kD2CImportResponse, kD2CExportResponse,
  kD2CExportError, kD2CImportError, kD2CExportImportBuffersReady, kD2CStatisticsLiveSnapshot,
  kD2CJobsStreamingEntry, kD2CJobsStreamingCompleted, kD2CJobsStreamingStarting, kD2CJobLiveUpdate,
  kD2CJobLiveAdd, kD2CJobLiveRemove, kD2CForceJobsUpdate, kD2CNodesStreamingEntry,
  kD2CNodesStreamingCompleted, kD2CNodesStreamingStarting, kD2CNodeLiveUpdate, kD2CNodeLiveAdd,
  kD2CNodeLiveRemove, kD2CChunksStreamingEntry, kD2CChunksStreamingCompleted, kD2CChunksStreamingStarting,
  kD2CChunkLiveUpdate, kD2CChunksInvalidated, kD2CPreferencesContent, kD2CPoolsStreamingStarting,
  kD2CPoolsStreamingEntry, kD2CPoolsStreamingCompleted, kD2CPoolsContentChanged, kD2CPathsStreamingStarting,
  kD2CPathsStreamingEntry, kD2CPathsStreamingCompleted, kD2CPathsContentChanged, kD2CLogsStreamingStarting,
  kD2CLogsStreamingEntry, kD2CLogsStreamingCompleted, kD2CInternalLogCleared, kD2CLiveLogAdd,
  kD2CLoginResponse, kD2CUnauthorizedOperationAttempt, kD2CInvalidOperationAttempt, kD2COperationSuccessfully,
  kD2CRegistrationSuccessfully, kD2CRegistrationInvalid, kD2CRegistrationTemporary, kD2CRegistrationExpired,
  kD2CEngineStatus, kD2CLiveLogChunk, kD2CInvalidLogEntryRequested, kD2CUsersGroupsStreamingStarting,
  kD2CUsersGroupsStreamingEntry, kD2CUsersGroupsStreamingCompleted, kD2CUsersGroupsStreamingRequest, kD2CLDAPUsersUpdateComplete,
  kD2CLDAPUsersUpdateInProgress, kD2CLDAPSettings, kD2CLDAPConfigureComplete, kD2CJobsUpdateStreamingEntry,
  kD2CJobsUpdateStreamingCompleted, kD2CJobsUpdateStreamingStarting, kD2CGetJobResponse, kD2CGetNodeResponse,
  kD2CGetChunkResponse, kD2CUpdateUsage, kD2CPythonOutput, kD2CPythonErrOutput,
  kD2CTemplateContent, kD2CTemplatesHashesMap, kD2CTemplatesReconfigurationCompleted, kD2CTemplatesContentChanged,
  kD2CReparentJob, kD2CLDAPUsersUpdateError, kD2CPulseHeartbeat, kD2CUsersStreamingStarting,
  kD2CUsersStreamingEntry, kD2CUsersStreamingCompleted, kD2CRequestActivityLogsList, kD2CRequestActionsLogsList,
  kD2CRequestActivityLog, kD2CRequestActionsLog, kD2CRemoveActivityLog, kD2CRemoveActionsLog,
  kD2CRequestNextPoolsEntry, kD2CRequestTemplate, kD2CRequestNextPathsEntry, kD2CRequestNextUsersEntry,
  kD2CRequestNextUsersGroupsEntry, kD2CReindexProgress, kD2CReindexCompleted, kD2CBackupJobConflict,
  kD2CBackupAndDeleteJobConflict, kD2CBackupJobCompleted, kD2CBackupQueryResponse, kD2CBackupQueryEntry,
  kD2CBackupQueryCompleted, kD2CBackupBoundaries, kD2CBackupRestoreJobCompleted, kD2CBackupDeleteJobCompleted,
  kD2CBackupRestoreJobConflict, kD2CBackupRestoreJobFailed, kD2CDispatcherHasBackupTables, kD2CDispatcherBackupTablesRemoved,
  kD2CConfigChangeFileError, kD2CChunkStatisticsEntry, kD2CChunkStatisticsCompleted, kD2CIconsHashesMap,
  kD2CIconContent, kD2CSendIconResponse, kD2CUpdateIcons, kD2CCustomMessage,
  kD2CAccountsConnections, kD2CAlarm, kD2CAlarmQueryResponse, kD2CAlarmQueryCompleted,
  kD2CEnd, kC2HBegin = 1200, kC2HConfigure, kC2HRequestStatus,
  kC2HPauseNode, kC2HResumeNode, kC2HKillAndPauseNode, kC2HKillAndGoOnNode,
  kC2HKillAndRedoNode, kC2HChangeNodePriority, kC2HRequestInstances, kC2HRequestLogs,
  kC2HRequestLogEntry, kC2HRemoveLog, kC2HRequestActivityLogs, kC2HRequestActivityLogEntry,
  kC2HRemoveActivityLog, kC2HAuthenticate, kC2HConfigurationContent, kC2HSoftRestartNode,
  kC2HConfigurationExport, kC2HConfigurationImport, kC2HEnd, kH2CBegin = 1400,
  kH2CStatusContent, kH2CConfigurationContent, kH2CRequestInstancesResponse, kH2CInvalidLogRequest,
  kH2CUnauthorizedOperationAttempt, kH2CConfigure, kH2CRequestLogs, kH2CRequestLogEntry,
  kH2CRemoveLog, kH2CRequestActivityLogs, kH2CRequestActivityLogEntry, kH2CRemoveActivityLog,
  kH2CConfigurationExport, kH2CEnd
}
 
enum  kNetworkMasks { kNetworkMaskJobs = 0x01, kNetworkMaskHosts = 0x02, kNetworkMaskLogs = 0x04, kNetworkMaskArchivedJobs = 0x08 }
 
enum  kPlatforms { kPlatformWindows = 0x01, kPlatformLinux = 0x02, kPlatformOSX = 0x04 }
 

Detailed Description

MClientLib global enumerations.

Global enumerations of the MClientLib namespace used across the global functions and class members

Enumeration Type Documentation

enum kIpVersion

Ip protocol version enumeration

Enumerator
kIPBoth 

Both IPV4 and IPV6

kIPV4 

IPV4

kIPV6 

IPV6

Definition at line 99 of file MClientLib.h.

enum kLoginResponse

Login response status

Enumerator
kLoginAdmin 

Login accepted, user is an Administrator

kLoginUser 

Login accepted, user is a regular user

kLoginGuest 

Login accepted, user is a guest

kLoginDenied 

Login denied

kLoginDeniedLDAPDown 

Login denied because the LDAP server is down

Definition at line 584 of file MClientLib.h.

enum kLogLevel

Logger severity level

Definition at line 106 of file MClientLib.h.

enum kNetworkCommands

Network commands

Enumerator
kD2HBegin 

Message category start placeholder

kD2HStartProcess 

Starts a task on the node

kD2HKillProcess 

Kills the current running process

kD2HKillProcessAndRestart 

Kills the current running process and restarts the same job

kD2HKillProcessAndPause 

Kills the current running process and pause the node

kD2HPauseNode 

Pause an idle node or schedule a paused status as soon as the job ends

kD2HResumeNode 

Resumes a paused node

kD2HForceUpdate 

Forces a node status update

kD2HSetProcessPriority 

Sets the current job process priority

kD2HAckAndGoIdle 

Acks the current job completion status and send the nodes to an idle status

kD2HPulseHeartbeat 

Sends an heartbeat to the node

kD2HSoftRestartNode 

Soft restart the node

kD2HEnableNodeLog 

Enables the real time log

kD2HDisableNodeLog 

Disables the real time log

kD2HSysEvent 

Send a system event to the node

kD2HChangePythonOutput 

Changes the client python output to network status

kD2HPythonCommand 

Sends a script to the client for immediate execution

kD2HTemplatesStreamingStarting 

Notifies about a templates streaming start event

kD2HTemplatesStreamingCompleted 

Notifies about a templates streaming end event

kD2HTemplatesStreamingEntry 

Sends back a template streaming entry

kD2HTemplateContent 

Sends back a template content

kD2HTemplatesHashesMap 

Sends back the templates hashes map

kD2HTemplatesReconfigurationCompleted 

Notifies about a templates reconfiguration event

kD2HTemplatesContentChanged 

Notifies about a templates content change

kD2HCustomMessage 

Sends a custom message to an host

kD2HSilenceAlarm 

Silences an alarm

kD2HBorrowInstance 

Set the instance status as borrowed

kD2HUnborrowInstance 

Remove the instance status as borrowed

kD2HStartReserv 

Starts a reserv on the node

kD2HTerminateReserv 

Terminate the current reserv on the node

kD2HEnd 

Message category end placeholder

kH2DBegin 

Message category start placeholder

kH2DReportProcResult_WarningOnLog 

Render completed, warning reported on log

kH2DReportProcResult_Success 

Render completed, no errors or warnings

kH2DReportProcResult_ErrorOnLog 

Render completed, error reported on log

kH2DReportProcResult_WarningOnExitcode 

Render completed, warning reported on exit code

kH2DReportProcResult_ErrorOnExitcode 

Render completed, error reported on exit code

kH2DReportProcResult_ProcessSpawnFailure 

Render failed, cannot spawn process

kH2DReportProcResult_FailureOnPrechunkAction 

Render failed, failure on prechunk action

kH2DReportProcResult_FailureOnPostchunkAction 

Render failed, failure on postchunk action

kH2DStatus 

Node status

kH2DIdle 

Node is idle

kH2DPaused 

Node is paused

kH2DPulseHeartbeat 

Sends an heart beat

kH2DClientID 

Reports client ID

kH2DLockedByLoggedUser 

Client locked by logged user

kH2DLockedByProcess 

Client locked by processes check

kH2DLockedByTimerule 

Client locked by time rule

kH2DLogChunk 

Client real time log chunk

kH2DUpdateUsage 

Live update of ram and cpus usage

kH2DPythonOutput 

Send a chunk of python output

kH2DPythonErrOutput 

Send a chunk of python error output

kH2DLockedByPython 

Client locked by a python global template function return

kH2DCustomMessage 

Sends a custom message to the dispatcher, may be handled from the global template

kH2DRequestTemplates 

Sends a custom message to the dispatcher, may be handled from the global template

kH2DRequestNextTemplatesStreamingEntry 

Sends a custom message to the dispatcher, may be handled from the global template

kH2DRequestTemplatesHashesMap 

Sends a custom message to the dispatcher, may be handled from the global template

kH2DRequestTemplate 

Sends a custom message to the dispatcher, may be handled from the global template

kH2DAlarm 

Sends an alarm that just triggered or terminated

kH2DLockedByReserv 

Client locked by a reserv

kH2DLockedByInstance 

Client locked by a instance borrow

kH2DEnd 

Message category end placeholder

kN2DBegin 

Message category start placeholder

kN2DNotifyLogin 

Login informations

kN2DPulseHeartbeat 

Send an heartbeat

kN2DCustomMessage 

Sends a custom message to the Dispatcher

kN2DEnd 

Message category end placeholder

kD2NBegin 

Message category start placeholder

kD2NNotify 

Notify about an event

kD2NLoginGranted 

Notificator logged successfully

kD2NAccessDenied 

Dispatcher denied login attempt

kD2NCustomMessage 

Sends a custom message to notificators

kD2NEnd 

Message category end placeholder

kC2DBegin 

Message category start placeholder

kC2DRequestStatisticsBoundaries 

Gets boundaries of statistics data

kC2DStartStatisticsRequest 

Starts a new statistics collection request

kC2DRequestNextStatisticsEntry 

Requests a new statistics entry

kC2DStartHistoryRequest 

Starts an history collection request

kC2DRequestNextHistoryEntry 

Requests a new history entry

kC2DStartChunksHistoryRequest 

Starts a chunks history collection request

kC2DRequestNextChunksHistoryEntry 

Requests a new chunks history entry

kC2DHistoryClearBounds 

Clears the history

kC2DStatisticsClearBounds 

Clears the statistics

kC2DDragJobToNewParent 

Reparents a job with a drag operation

kC2DLogin 

Login

kC2DSetNetMask 

Sends the active network messages mask

kC2DSendRegistration 

Sends a new licensing registration

kC2DQueryEngineStatus 

Queries the engine status

kC2DSwapEngineStatus 

Swaps the current engine status

kC2DStartLogsRequest 

Starts a new log collection request

kC2DRequestNextLogsEntry 

Requests the next log collection entry

kC2DClearInternalLog 

Clears the internal Dispatcher log

kC2DStartPathsRequest 

Starts the repositories paths query

kC2DRequestNextPathsEntry 

Requests the next repositories paths entry

kC2DStartUsersRequest 

Starts the users query

kC2DRequestNextUsersEntry 

Requests the next user entry

kC2DStartPoolsRequest 

Starts the pools query

kC2DRequestNextPoolsEntry 

Requests the next pool entry

kC2DStartJobsRequest 

Starts the jobs query

kC2DRequestNextJobsEntry 

Requests the next job entry

kC2DStartNodesRequest 

Starts the node query

kC2DRequestNextNodesEntry 

Requests the next node entry

kC2DStartChunksRequest 

Starts a chunk query

kC2DRequestNextChunksEntry 

Requests the next chunk entry

kC2DModifyJob 

Modify an existing job

kC2DRenameJob 

Rename a job

kC2DChangeJobPriority 

Change a job priority

kC2DChangeJobDepartment 

Change a job department

kC2DChangeJobProject 

Change a job project

kC2DChangeJobTemplate 

Change a job template

kC2DSubmitJob 

Submit a new job

kC2DDeleteJob 

Deletes an existing job

kC2DChangeJobPool 

Change a job included pools

kC2DChangeJobExcludedPool 

Change a job excluded pools

kC2DChangeJobOwner 

Change a job owner

kC2DPauseJob 

Pauses a job

kC2DResumeJob 

Resumes a job

kC2DReinitJob 

Reinit a job

kC2DChangeJobDependancies 

Changes a job dependencies

kC2DChangeJobDependanciesMode 

Changes a job dependencies evaluation mode

kC2DChangeJobDependanciesLinkMode 

Changes a job dependencies evaluation link mode

kC2DChangeJobStartOn 

Changes a job starton time

kC2DChangeJobResumeOn 

Changes a job resumeon time

kC2DChangeJobPauseOn 

Changes a job pauseon time

kC2DUnlockJob 

Unlocks a locked job

kC2DLockJob 

Locks a job

kC2DArchiveJob 

Archivies a job

kC2DUnarchiveJob 

Unarchivies a job

kC2DImportQueue 

Import a new native data queue

kC2DExportQueue 

Exports the queue as data base native format

kC2DPauseNode 

Pauses a node or schedule a pause command at the next idle status

kC2DResumeNode 

Resumes a node

kC2DKillNode 

Kills a rendering node

kC2DKillAndPauseNode 

Kills and pause a rendering node

kC2DKillNodeAndRedoJob 

Kills a node and restarts the job

kC2DChangeNodeProcessPriority 

Change a node process priority

kC2DPurgeTemplatesExclusion 

Purges a node templates exclusion list

kC2DPurgeJobsExclusion 

Purges a node jobs exclusion list

kC2DSoftRestartNode 

Issues a soft restart on a node

kC2DSoftRestartDispatcher 

Issues a soft restart on the Dispatcher

kC2DKillAndPauseNodesWorkingOnJob 

Send a kill and pause to the nodes working on a job

kC2DKillAndRedoNodesWorkingOnJob 

Send a kill and redo to the nodes working on a job

kC2DKillAndGoOnNodesWorkingOnJob 

Sends a kill and go on to the nodes working on a job

kC2DPrepareBuffersForBigOP 

Prepares the network buffers for a big buffer operation

kC2DRestoreBuffersAfterBigOP 

Restores the network buffers after a big buffer operation

kC2DChangePassword 

Changes the logged user password

kC2DForceStatisticsUpdate 

Forces an update of the statistics

kC2DResetStatisticsCounters 

Resets the statistics counter

kC2DChangeNodeMemo 

Changes a node memo

kC2DRemoveNodeRegistration 

Remove an offline node registration

kC2DStartNetworkScan 

Starts a node network scan on the Dispatcher

kC2DRegisterNode 

Manually register a new node

kC2DSendSystemEventToNode 

Sends a system event to a node

kC2DSetChunkOnHold 

Sets a chunk to on hold status

kC2DSetChunkAsCompleted 

Forces a chunk to competed status

kC2DRequestPreferences 

Requests the Dispatcher preferences

kC2DSetPreferences 

Set the Dispatcher preferences

kC2DEnableNodeLog 

Enables a node realtime log

kC2DDisableNodeLog 

Disables a node realtime log

kC2DRequestActivityLogsList 

Requests the list of the activity logs

kC2DRequestActivityLog 

Request an activity log file

kC2DRemoveActivityLog 

Remove an activity log file

kC2DRequestActionsLogsList 

Requests the list of the actions logs

kC2DRequestActionsLog 

Request an action log file

kC2DRemoveActionsLog 

Remove an action log file

kC2DUpdateNodeWakeupStatus 

Updates a node wakeup status

kC2DAddFolder 

Add a new folder

kC2DChangeJobMemo 

Changes the memo of a job

kC2DChangeJobMaximumInstances 

Change a job maximum instances

kC2DForceNodeRefresh 

Forces a node status refresh

kC2DSetMinimumLogicalUnits 

Sets a job minimum logical units

kC2DSetMinimumCores 

Sets a job minimum cores

kC2DSetMinimumPhysicalUnits 

Sets a job minimum physical units

kC2DSetMinimumCoresSpeed 

Sets a job minimum cores speed

kC2DSetMinimumRamAmount 

Sets a job minimum RAM amount

kC2DSetMinimumDiskSpaceAmount 

Sets a job minimum free space amount

kC2DSetProcessValidExitCodes 

Sets a job valid exit codes

kC2DSetProcessWarningExitCodes 

Set a job warning exit codes

kC2DSetProcessErrorExitCodes 

Set a job error exit codes

kC2DStartUsersGroupsRequest 

Starts a new user groups collection

kC2DRequestNextUsersGroupsEntry 

Request the next user groups entry

kC2DUpdateLDAPUsers 

Forces LDAP user update

kC2DRequestLDAPSettings 

Requests the LDAP settings

kC2DConfigureLDAP 

Configure the LDAP settings

kC2DStartJobsUpdateRequest 

Starts a job update request

kC2DRequestNextJobsUpdateEntry 

Get a new entry for a job update request

kC2DAddUser 

Add a new user

kC2DGetUser 

Get an existing user

kC2DConfigureUser 

Configure an existing user

kC2DRemoveUser 

Removes an existing user

kC2DAddGroup 

Add a new group

kC2DGetGroup 

Get an existing group

kC2DConfigureGroup 

Configure en existing group

kC2DRemoveGroup 

Removes an existing group

kC2DGetJob 

Get an existing job

kC2DGetNode 

Get an existing node

kC2DGetChunk 

Get an existing chunk

kC2DSetEnvironment 

Set a job environment

kC2DChangeExitCodesCheck 

Set a job exit code check

kC2DChangeLogsCheck 

Set a job logs check

kC2DChangeLogsRules 

Set a job logs parsing rules

kC2DChangeMissingFramesCheck 

Set a job missing frames check

kC2DChangeFramesPrefixPath 

Set a job frames prefix path

kC2DRequestPythonOutput 

Requests python output redirection

kC2DPythonCommand 

Sends a script to the Dispatcher for immediate execution on a specific context

kC2DChangeJobAttribute 

Changes a job attribute on the Dispatcher triggering a job update

kC2DRemoveJobAttribute 

Removes a job attribute on the Dispatcher triggering a job update

kC2DChangeChunksTimeout 

Changes a job chunks timeout triggering a job update

kC2DChangeChunksMaximumRequeue 

Changes a job chunks maximum requeue on the Dispatcher triggering a job update

kC2DChangeJobMailNotifications 

Changes a job mail notifications level

kC2DChangeChunksMailNotifications 

Changes a job chunks mail notification levels

kC2DChangeJobNotificatorNotifications 

Changes a job notificator notifications level

kC2DChangeChunksNotificatorNotifications 

Changes a job chunks notificator notification levels

kC2DChangeJobMobileNotifications 

Changes a job mobile notifications level

kC2DChangeChunksMobileNotifications 

Changes a job chunks mobile notification levels

kC2DChangeJobStartMailNotifications 

Changes a job mail notifications level

kC2DChangeChunksStartMailNotifications 

Changes a job chunks mail notification levels

kC2DChangeJobStartNotificatorNotifications 

Changes a job notificator notifications level

kC2DChangeChunksStartNotificatorNotifications 

Changes a job chunks notificator notification levels

kC2DChangeJobStartMobileNotifications 

Changes a job mobile notifications level

kC2DChangeChunksStartMobileNotifications 

Changes a job chunks mobile notification levels

kC2DResetChunkRequeueCounter 

Resets a chunk requeue counter levels

kC2DRequestTemplatesHashesMap 

Requests the templates hashes map

kC2DRequestTemplate 

Requests a specific template file

kC2DPulseHeartbeat 

Sends an heartbeat

kC2DUsersStreamingStarting 

Starts user streaming

kC2DUsersStreamingEntry 

Receives an user entry

kC2DUsersStreamingCompleted 

Users streaming completed

kC2DUsersGroupsStreamingStarting 

Starts a groups streaming

kC2DUsersGroupsStreamingEntry 

Receives a group entry

kC2DUsersGroupsStreamingCompleted 

Groups streaming completed

kC2DPoolsStreamingStarting 

Starts a pools streaming

kC2DPoolsStreamingEntry 

Receives a pool entry

kC2DPoolsStreamingCompleted 

Pools streaming completed

kC2DPathsStreamingStarting 

Starts a path streaming

kC2DPathsStreamingEntry 

Receives a path entry

kC2DPathsStreamingCompleted 

Path streaming completed

kC2DTemplatesHashesMap 

Receives a templates hashes map

kC2DTemplateContent 

Receives a template content

kC2DChangeJobCamera 

Change a job camera

kC2DChangeJobShot 

Change a job shot

kC2DChangeJobSequence 

Change a job sequence

kC2DReindex 

Reindex the databases on the Dispatcher

kC2DRestartFrameCheck 

Restarts the frames check on a job

kC2DChangeJobEmergencyQueue 

Changes a job emergency queue status

kC2DUpdateChunkErrors 

Updates a chunk errors list

kC2DWaitDbFlush 

Waits for DB flush 8.5.16+

kC2DBackupJob 

Backups job(s) 9.0.0+

kC2DBackupAndDeleteJob 

Backups and delete job(s) 9.0.0+

kC2DBackupRestoreJobs 

Restores job(s) 9.0.0+

kC2DBackupDeleteJobs 

Removes job(s) from the backup DB 9.0.0+

kC2DBackupQuery 

Make a query on the backup db 9.0.0+

kC2DBackupRequestBoundaries 

Make a query on the backup db for boundaries 9.0.0+

kC2DBackupQueryRequestNextEntry 

Request the next query entry from a previously started query 9.0.0+

kC2DDispatcherRemoveBackupTables 

Request the removal of DBs backup tables 9.0.2+

kC2DImportJsonQueue 

Imports a new json data queue 9.0.3+

kC2DExportJsonQueue 

Exports a json data queue 9.0.3+

kC2DImportSettings 

Imports Dispatcher settings in native database format 9.0.3+

kC2DExportSettings 

Exports Dispatcher settings in native database format 9.0.3+

kC2DImportJsonSettings 

Imports Dispatcher settings in json format 9.0.3+

kC2DExportJsonSettings 

Exports Dispatcher settings in json format 9.0.3+

kC2DImportConfig 

Imports Dispatcher config 9.0.3+

kC2DExportConfig 

Exports Dispatcher config 9.0.3+

kC2DRequestChunkStatistics 

Requests a chunk statistics entry from the Dispatcher 9.0.5+

kC2DUpdateNodeSharedLogsStatus 

Updates a node shared logs status

kC2DRequestIconsHashesMap 

Requests the icons hashes map

kC2DRequestIcon 

Requests a specific icon file

kC2DSendIcon 

Sends a new icon for a template to Dispatcher

kC2DCustomMessage 

Sends a custom message to the Dispatcher

kC2DSetMinimumPhysicalGPUsUnits 

Sets a job minimum physical GPUs units

kC2DRequestAccountsConnections 

Requests the connected accounts from the Dispatcher

kC2DTimedPauseNode 

Sets a time to pause a node

kC2DTimedResumeNode 

Sets a time to resume a node

kC2DQueryAlarms 

Queries for alarms

kC2DSilenceAlarm 

Silence an alarm

kC2DSetBorrowInstances 

Sets borrow instances

kC2DStartReserv 

Starts a reserv on the instance

kC2DTerminateReserv 

Terminate a reserv on the instance

kC2DEnd 

Message category end placeholder

kD2CBegin 

Message category start placeholder

kD2CStatisticsBoundaries 

Sends back the statistics boundaries

kD2CStatisticsEntry 

Sends back a statistic entry

kD2CStatisticsStreamingStarting 

Sends back a statistics collection start event

kD2CStatisticsStreamingCompleted 

Sends back a statistics collection end event

kD2CHistoryEntry 

Sends back an history entry

kD2CHistoryStreamingStarting 

Sends back an history collection start event

kD2CHistoryStreamingCompleted 

Sends back an history collection end event

kD2CChunksHistoryEntry 

Sends back a chunk history entry

kD2CChunksHistoryStreamingStarting 

Sends back a chunk history collection start event

kD2CChunksHistoryStreamingCompleted 

Sends back a chunk history collection end event

kD2CStatisticsBoundsCleared 

Sends back an ACK for a statistics clear event

kD2CHistoryBoundsCleared 

Sends back an ACK for a history clear event

kD2CPasswordChangeSuccess 

Sends back an ACK for a password change event

kD2CConfigChangeSuccess 

Sends back an ACK for a config change event

kD2CImportResponse 

Sends back a queue import response

kD2CExportResponse 

Sends back a queue export response

kD2CExportError 

Sends back a queue export error response

kD2CImportError 

Sends back a queue import error response

kD2CExportImportBuffersReady 

Notify about export buffers ready for a big operation

kD2CStatisticsLiveSnapshot 

Sends a statistics live snapshot

kD2CJobsStreamingEntry 

Sends back a jobs streaming entry

kD2CJobsStreamingCompleted 

Sends back a jobs streaming end event

kD2CJobsStreamingStarting 

Sends back a jobs streaming start event

kD2CJobLiveUpdate 

Sends a job live update

kD2CJobLiveAdd 

Sends a job live add event

kD2CJobLiveRemove 

Sends a job live remove event

kD2CForceJobsUpdate 

Forces a queue complete update

kD2CNodesStreamingEntry 

Sends back a node streaming entry

kD2CNodesStreamingCompleted 

Sends back a node streaming end event

kD2CNodesStreamingStarting 

Sends back a node streaming start event

kD2CNodeLiveUpdate 

Sends a node live update

kD2CNodeLiveAdd 

Sends a node live add event

kD2CNodeLiveRemove 

Sends a node live remove event

kD2CChunksStreamingEntry 

Sends back a chunk streaming entry

kD2CChunksStreamingCompleted 

Sends back a chunk streaming end event

kD2CChunksStreamingStarting 

Sends back a chunk streaming start event

kD2CChunkLiveUpdate 

Sends a chunk live update

kD2CChunksInvalidated 

Sends a chunks complete invalidation event

kD2CPreferencesContent 

Sends back the Dispatcher preferences

kD2CPoolsStreamingStarting 

Sends back a pools streaming start event

kD2CPoolsStreamingEntry 

Sends back a pools streaming entry

kD2CPoolsStreamingCompleted 

Sends back a pools streaming end event

kD2CPoolsContentChanged 

Notifies about a change into the pool structure

kD2CPathsStreamingStarting 

Sends back a repository streaming start event

kD2CPathsStreamingEntry 

Sends back a repository streaming entry

kD2CPathsStreamingCompleted 

Sends back a repository streaming end event

kD2CPathsContentChanged 

Notifies about a change into the repositories

kD2CLogsStreamingStarting 

Sends back a log streaming start event

kD2CLogsStreamingEntry 

Sends back a log entry

kD2CLogsStreamingCompleted 

Sends back a log streaming end event

kD2CInternalLogCleared 

Notifies about a full clear of the internal log

kD2CLiveLogAdd 

Sends a log add live event

kD2CLoginResponse 

Respond to a login request

kD2CUnauthorizedOperationAttempt 

Notifies about an unauthorized operation attempt

kD2CInvalidOperationAttempt 

Notifies about an invalid operation attempt

kD2COperationSuccessfully 

Notifies about a successfully operation

kD2CRegistrationSuccessfully 

Notifies about a successfully license registration

kD2CRegistrationInvalid 

Notifies about an invalid registration

kD2CRegistrationTemporary 

Notifies about a temporary successfully license registration

kD2CRegistrationExpired 

Notifies about an invalid expired registration

kD2CEngineStatus 

Sends back the Dispatcher engine status

kD2CLiveLogChunk 

Sends a chunk log live event

kD2CInvalidLogEntryRequested 

Notifies about an invalid log request

kD2CUsersGroupsStreamingStarting 

Sends back a group streaming start event

kD2CUsersGroupsStreamingEntry 

Sends back a group streaming entry

kD2CUsersGroupsStreamingCompleted 

Sends back a group streaming end event

kD2CUsersGroupsStreamingRequest 

Request the user groups streaming

kD2CLDAPUsersUpdateComplete 

Notify about a successfully LDAP update

kD2CLDAPUsersUpdateInProgress 

Notify about an in progress LDAP update

kD2CLDAPSettings 

Sends back the LDAP settings

kD2CLDAPConfigureComplete 

Notify about a successfully LDAP configuration

kD2CJobsUpdateStreamingEntry 

Sends back a job update streaming entry

kD2CJobsUpdateStreamingCompleted 

Sends back a job update streaming end event

kD2CJobsUpdateStreamingStarting 

Sends back a job update streaming start event

kD2CGetJobResponse 

Sends back a single job entry

kD2CGetNodeResponse 

Sends back a single node entry

kD2CGetChunkResponse 

Sends back a single chunk entry

kD2CUpdateUsage 

Updates client usage

kD2CPythonOutput 

Send a chunk of python output

kD2CPythonErrOutput 

Send a chunk of python error output

kD2CTemplateContent 

Sends back a template content

kD2CTemplatesHashesMap 

Sends back the templates hashes map

kD2CTemplatesReconfigurationCompleted 

Notifies about a templates reconfiguration event

kD2CTemplatesContentChanged 

Notifies about a templates content change

kD2CReparentJob 

Reparent a job

kD2CLDAPUsersUpdateError 

Reports an LDAP user update error

kD2CPulseHeartbeat 

Sends an heartbeat

kD2CUsersStreamingStarting 

Starts user streaming

kD2CUsersStreamingEntry 

Receives an user entry

kD2CUsersStreamingCompleted 

Users streaming completed

kD2CRequestActivityLogsList 

Requests the activity logs list

kD2CRequestActionsLogsList 

Requests the actions logs list

kD2CRequestActivityLog 

Requests one activity log

kD2CRequestActionsLog 

Requests one action log

kD2CRemoveActivityLog 

Removes activity logs

kD2CRemoveActionsLog 

Removes actions logs

kD2CRequestNextPoolsEntry 

Request the next pool entry

kD2CRequestTemplate 

Requests a template

kD2CRequestNextPathsEntry 

Requests the next repository path entry

kD2CRequestNextUsersEntry 

Requests the next users entry

kD2CRequestNextUsersGroupsEntry 

Requests the next groups entry

kD2CReindexProgress 

Notify about DB reindex progress

kD2CReindexCompleted 

Notify about reindex completed

kD2CBackupJobConflict 

Sends a conflict warning back 9.0.0+

kD2CBackupAndDeleteJobConflict 

Sends a conflict warning back 9.0.0+

kD2CBackupJobCompleted 

Sends ack to console 9.0.0+

kD2CBackupQueryResponse 

Sends a response back for a backup query 9.0.0+

kD2CBackupQueryEntry 

Sends a response back for a backup query 9.0.0+

kD2CBackupQueryCompleted 

Sends a response back for a backup query 9.0.0+

kD2CBackupBoundaries 

Sends a response back for a backup boundaries query 9.0.0+

kD2CBackupRestoreJobCompleted 

Sends a response back for a backup restore query 9.0.0+

kD2CBackupDeleteJobCompleted 

Sends a response back for a backup delete query 9.0.0+

kD2CBackupRestoreJobConflict 

Sends a conflict warning back 9.0.0+

kD2CBackupRestoreJobFailed 

Sends a failure back 9.0.0+

kD2CDispatcherHasBackupTables 

Sends a warning about the presence of backup DB tables 9.0.2+

kD2CDispatcherBackupTablesRemoved 

Sends a confirmation about the removal of backup DB tables 9.0.2+

kD2CConfigChangeFileError 

Sends back an ACK for a config change file save error event 9.0.3+

kD2CChunkStatisticsEntry 

Sends a chunk statistics entry to Console 9.0.5+

kD2CChunkStatisticsCompleted 

No more chunk statistics entry 9.0.5+

kD2CIconsHashesMap 

Sends back the icons hashes map

kD2CIconContent 

Sends back an icon content

kD2CSendIconResponse 

Sends back a response about an icon upload operation

kD2CUpdateIcons 

Brodcast to consoles to update the icons

kD2CCustomMessage 

Sends a custom message to a console connection

kD2CAccountsConnections 

Sends back a resume of the connected accounts

kD2CAlarm 

Sends an alarm that just triggered

kD2CAlarmQueryResponse 

Sends an entry of the alarms list query

kD2CAlarmQueryCompleted 

Alarms list query completed

kD2CEnd 

Message category end placeholder

kC2HBegin 

Message category start placeholder

kC2HConfigure 

Configure an host

kC2HRequestStatus 

Request the host status

kC2HPauseNode 

Pauses a node

kC2HResumeNode 

Resumes a node

kC2HKillAndPauseNode 

Kills and pause on a node

kC2HKillAndGoOnNode 

Kills and go on a node

kC2HKillAndRedoNode 

Kills and redo on a node

kC2HChangeNodePriority 

Changes the node priority

kC2HRequestInstances 

Requests the instances collection from a node

kC2HRequestLogs 

Requests the processes logs list from a node

kC2HRequestLogEntry 

Requests a specific processes logs file from a node

kC2HRemoveLog 

Removes a processes log from a node

kC2HRequestActivityLogs 

Requests the activity logs list from a node

kC2HRequestActivityLogEntry 

Requests a specific activity logs file from a node

kC2HRemoveActivityLog 

Removes an activity log from a node

kC2HAuthenticate 

Authenticate on a node

kC2HConfigurationContent 

Send configuration content

kC2HSoftRestartNode 

Send a soft restart

kC2HConfigurationExport 

Requests the rc.conf file 9.0.3+

kC2HConfigurationImport 

Imports the rc.conf file 9.0.3+

kC2HEnd 

Message category end placeholder

kH2CBegin 

Message category start placeholder

kH2CStatusContent 

Sends back a status content

kH2CConfigurationContent 

Sends back the node configuration

kH2CRequestInstancesResponse 

Sends back the instances collection

kH2CInvalidLogRequest 

Reports an invalid node request

kH2CUnauthorizedOperationAttempt 

Reports an unauthorized operation

kH2CConfigure 

Confirm configuration

kH2CRequestLogs 

Sends logs list

kH2CRequestLogEntry 

Sends a log content

kH2CRemoveLog 

Confirm a log removal

kH2CRequestActivityLogs 

Sends activity logs list

kH2CRequestActivityLogEntry 

Sends an activity log content

kH2CRemoveActivityLog 

Confirm a log removal

kH2CConfigurationExport 

Sends back the node rc.conf 9.0.3+

kH2CEnd 

Message category end placeholder

Definition at line 114 of file MClientLib.h.

enum kNetworkMasks

Network data flow mask

Enumerator
kNetworkMaskJobs 

Jobs add and update data

kNetworkMaskHosts 

Nodes add and update data

kNetworkMaskLogs 

Logs add and update data

kNetworkMaskArchivedJobs 

Archived jobs add and update data

Definition at line 593 of file MClientLib.h.

enum kPlatforms

Platforms enumerations

Enumerator
kPlatformWindows 

The Windows platform

kPlatformLinux 

The Linux platform

kPlatformOSX 

The Apple Mac OS X platform

Definition at line 92 of file MClientLib.h.