MClientLib functions

MClientLib global functions. More...

Functions
MCLIENTLIB_API MUSTERERR	AcquireServerStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionChangePassword (MUSTER *m, const char *oldPassword, const char *newPassword)
MCLIENTLIB_API MUSTERERR	ActionChangeStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionCreateFolder (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	ActionEditJob (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	ActionExportQueue (MUSTER *m, MStringRef &queueOutput)
MCLIENTLIB_API MUSTERERR	ActionForceLDAPUpdate (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionImportQueue (MUSTER *m, MStringRef &queueInput)
MCLIENTLIB_API MUSTERERR	ActionResetCounters (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionRunPython (MUSTER *m, const char *pythonCode)
MCLIENTLIB_API MUSTERERR	ActionRunPythonFile (MUSTER *m, const char *pythonFilePath)
MCLIENTLIB_API MUSTERERR	ActionSendJob (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	ActionSoftRestart (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionWaitDbFlush (MUSTER *m)
MCLIENTLIB_API MUSTERERR	AddGroup (MUSTER *m, MGroup &group)
MCLIENTLIB_API MUSTERERR	AddUser (MUSTER *m, MUser &user)
MCLIENTLIB_API MUSTERERR	Authenticate (MUSTERCLIENT *m, const char *password)
MCLIENTLIB_API MUSTERERR	Authenticate (MUSTER *m, const char *username, const char *password, bool skipDirectoryServer=false)
MCLIENTLIB_API MUSTERERR	ChunkActionResetRequeue (MUSTER *m, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	ChunkActionResetRequeue (MUSTER *m, long jobId, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	ChunkActionSetCompleted (MUSTER *m, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	ChunkActionSetCompleted (MUSTER *m, long jobId, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	ChunkActionSetOnHold (MUSTER *m, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	ChunkActionSetOnHold (MUSTER *m, long jobId, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	ClearJobsHistory (MUSTER *m, long startingTime, long endingTime)
MCLIENTLIB_API MUSTERERR	ClearStatisticsHistory (MUSTER *m, long startingTime, long endingTime)
MCLIENTLIB_API MUSTERERR	ConfigureGroup (MUSTER *m, MGroup &group)
MCLIENTLIB_API MUSTERERR	ConfigureUser (MUSTER *m, MUser &user)
MCLIENTLIB_API MUSTERERR	Connect (MUSTERCLIENT *m, const char *clientAddress, int clientPort, long maxSocketReadBytes=65000000, long maxSocketWriteBytes=65000000)
MCLIENTLIB_API MUSTERERR	Connect (MUSTER *m, const char *dispatcherAddress, int dispatcherPort, long maxSocketReadBytes=65000000, long maxSocketWriteBytes=65000000)
MCLIENTLIB_API MUSTERERR	Disconnect (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	Disconnect (MUSTER *m)
MCLIENTLIB_API MUSTERERR	GetAccounts (MUSTER *m, std::vector< MUser > &users, std::vector< MGroup > &groups)
MCLIENTLIB_API MUSTERERR	GetActionLogContent (MUSTER *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	GetActionLogs (MUSTER *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetActivityLogContent (MUSTERCLIENT *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	GetActivityLogContent (MUSTER *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	GetActivityLogs (MUSTERCLIENT *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetActivityLogs (MUSTER *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERAUTH	GetAuthenticationStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	GetBackupBounds (MUSTER *m, MBackupQueryBoundaries &boundaries)
MCLIENTLIB_API MUSTERERR	GetBackupJobs (MUSTER *m, MBackupQuery &query, std::vector< MBackupJob > &jobs)
MCLIENTLIB_API MUSTERERR	GetChunk (MUSTER *m, MChunk &chunk, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	GetChunks (MUSTER *m, long jobId, int filterMask, std::vector< MChunk > &chunks)
MCLIENTLIB_API MUSTERERR	GetDispatcherConfiguration (MUSTER *m, MDispatcherConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	GetDispatcherLDAPConfiguration (MUSTER *m, MDispatcherConfigurationLDAP &configurationObject)
MCLIENTLIB_API MUSTERERR	GetGroup (MUSTER *m, const char *groupName, MGroup &group)
MCLIENTLIB_API MUSTERERR	GetHistoryBounds (MUSTER *m, MSamplesBoundaries &boundaries)
MCLIENTLIB_API MUSTERERR	GetJob (MUSTER *m, MJob &job, long jobId)
MCLIENTLIB_API MUSTERERR	GetJobHistory (MUSTER *m, long jobId, std::vector< MHistoryChunk > &samples)
MCLIENTLIB_API MUSTERERR	GetJobs (MUSTER *m, int filterMask, std::vector< MJob > &jobs, bool queryArchived)
MCLIENTLIB_API MUSTERERR	GetJobsHistory (MUSTER *m, long startingTime, long endingTime, const char *filterField, const char *filter, std::vector< MHistoryChunk > &samples)
MCLIENTLIB_API std::string	GetLibraryPath ()
MCLIENTLIB_API MUSTERERR	GetLogs (MUSTER *m, int filterMask, std::vector< MLog > &logs)
MCLIENTLIB_API MUSTERERR	GetNode (MUSTER *m, MNode &node, long nodeId)
MCLIENTLIB_API MUSTERERR	GetNodeConfiguration (MUSTERCLIENT *m, MNodeConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	GetNodes (MUSTER *m, int filterMask, std::vector< MNode > &nodes)
MCLIENTLIB_API int	GetPlatform ()
MCLIENTLIB_API MUSTERERR	GetPools (MUSTER *m, MPools &pools)
MCLIENTLIB_API MUSTERERR	GetProcessesLogContent (MUSTERCLIENT *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	GetProcessesLogs (MUSTERCLIENT *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetRepositories (MUSTER *m, std::vector< MRepository > &repositories)
MCLIENTLIB_API MServerStatus	GetServerStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	GetStatistics (MUSTER *m, MDispatcherStatistics &statistics)
MCLIENTLIB_API MUSTERERR	GetStatisticsHistory (MUSTER *m, long startingTime, long endingTime, std::vector< MStatisticsSample > &samples)
MCLIENTLIB_API MUSTERERR	GetUser (MUSTER *m, const char *userName, MUser &user)
MCLIENTLIB_API MUSTERCLIENT *	InitializeClientSession (void)
MCLIENTLIB_API MUSTERERR	InitializeLibrary (const char *module)
MCLIENTLIB_API MUSTER *	InitializeSession (void)
MCLIENTLIB_API MUSTERERR	JobActionArchive (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionArchive (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionBackup (MUSTER *m, long jobId, int jobBackupOverwriteMode)
MCLIENTLIB_API MUSTERERR	JobActionBackup (MUSTER *m, std::vector< long > ids, int jobBackupOverwriteMode)
MCLIENTLIB_API MUSTERERR	JobActionBackupAndDelete (MUSTER *m, long jobId, int jobBackupOverwriteMode)
MCLIENTLIB_API MUSTERERR	JobActionBackupAndDelete (MUSTER *m, std::vector< long > ids, int jobBackupOverwriteMode)
MCLIENTLIB_API MUSTERERR	JobActionDelete (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionDelete (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionKillAndGoOn (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionKillAndGoOn (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionKillAndPause (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionKillAndPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionKillAndRedo (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionKillAndRedo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionLock (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionLock (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionPause (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionReinit (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionReinit (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionRemoveAttribute (MUSTER *m, long jobId, const char *attributeName)
MCLIENTLIB_API MUSTERERR	JobActionRemoveAttribute (MUSTER *m, std::vector< long > id, const char *attributeName)
MCLIENTLIB_API MUSTERERR	JobActionRename (MUSTER *m, long jobId, const char *name)
MCLIENTLIB_API MUSTERERR	JobActionRename (MUSTER *m, std::vector< long > id, const char *name)
MCLIENTLIB_API MUSTERERR	JobActionRestartFrameCheck (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionRestartFrameCheck (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionRestore (MUSTER *m, long jobId, int jobRestoreActionMode, int jobRestoreReparentId)
MCLIENTLIB_API MUSTERERR	JobActionRestore (MUSTER *m, std::vector< long > ids, int jobRestoreActionMode, int jobRestoreReparentId)
MCLIENTLIB_API MUSTERERR	JobActionResume (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionResume (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionSetAttribute (MUSTER *m, long jobId, const char *attributeName, bool enable, const char *attributeValue)
MCLIENTLIB_API MUSTERERR	JobActionSetAttribute (MUSTER *m, std::vector< long > id, const char *attributeName, bool enable, const char *attributeValue)
MCLIENTLIB_API MUSTERERR	JobActionSetBorrowInstances (MUSTER *m, long jobId, bool enable, int borrowInstances)
MCLIENTLIB_API MUSTERERR	JobActionSetBorrowInstances (MUSTER *m, std::vector< long > id, bool enable, int borrowInstances)
MCLIENTLIB_API MUSTERERR	JobActionSetCamera (MUSTER *m, long jobId, const char *cameraName)
MCLIENTLIB_API MUSTERERR	JobActionSetCamera (MUSTER *m, std::vector< long > id, const char *cameraName)
MCLIENTLIB_API MUSTERERR	JobActionSetChunkMaximumRequeueOverride (MUSTER *m, long jobId, bool enable, int maximumRequeue)
MCLIENTLIB_API MUSTERERR	JobActionSetChunkMaximumRequeueOverride (MUSTER *m, std::vector< long > id, bool enable, int maximumRequeue)
MCLIENTLIB_API MUSTERERR	JobActionSetChunkTimeoutOverride (MUSTER *m, long jobId, bool enable, int timeout)
MCLIENTLIB_API MUSTERERR	JobActionSetChunkTimeoutOverride (MUSTER *m, std::vector< long > id, bool enable, int timeout)
MCLIENTLIB_API MUSTERERR	JobActionSetDepartment (MUSTER *m, long jobId, const char *departmentName)
MCLIENTLIB_API MUSTERERR	JobActionSetDepartment (MUSTER *m, std::vector< long > id, const char *departmentName)
MCLIENTLIB_API MUSTERERR	JobActionSetDependLinkMode (MUSTER *m, long jobId, int dependLinkMode)
MCLIENTLIB_API MUSTERERR	JobActionSetDependLinkMode (MUSTER *m, std::vector< long > id, int dependLinkMode)
MCLIENTLIB_API MUSTERERR	JobActionSetDependMode (MUSTER *m, long jobId, int dependMode)
MCLIENTLIB_API MUSTERERR	JobActionSetDependMode (MUSTER *m, std::vector< long > id, int dependMode)
MCLIENTLIB_API MUSTERERR	JobActionSetDepends (MUSTER *m, long jobId, const char *depends)
MCLIENTLIB_API MUSTERERR	JobActionSetDepends (MUSTER *m, std::vector< long > id, const char *depends)
MCLIENTLIB_API MUSTERERR	JobActionSetEmergencyQueue (MUSTER *m, long jobId, bool state)
MCLIENTLIB_API MUSTERERR	JobActionSetEmergencyQueue (MUSTER *m, std::vector< long > id, bool enabled)
MCLIENTLIB_API MUSTERERR	JobActionSetExcludedPools (MUSTER *m, long jobId, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetExcludedPools (MUSTER *m, std::vector< long > id, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetExitCodesErrorCheckType (MUSTER *m, long jobId, MJob::kErrorChecksType type)
MCLIENTLIB_API MUSTERERR	JobActionSetExitCodesErrorCheckType (MUSTER *m, std::vector< long > id, MJob::kErrorChecksType type)
MCLIENTLIB_API MUSTERERR	JobActionSetLogsErrorCheckType (MUSTER *m, long jobId, MJob::kErrorChecksType type)
MCLIENTLIB_API MUSTERERR	JobActionSetLogsErrorCheckType (MUSTER *m, std::vector< long > id, MJob::kErrorChecksType type)
MCLIENTLIB_API MUSTERERR	JobActionSetLogsParsingRules (MUSTER *m, long jobId, const std::vector< MClientLib::MTextFileRule > &rules)
MCLIENTLIB_API MUSTERERR	JobActionSetLogsParsingRules (MUSTER *m, std::vector< long > id, const std::vector< MClientLib::MTextFileRule > &rules)
MCLIENTLIB_API MUSTERERR	JobActionSetMaximumNodes (MUSTER *m, long jobId, int maximumNodes)
MCLIENTLIB_API MUSTERERR	JobActionSetMaximumNodes (MUSTER *m, std::vector< long > id, int maximumNodes)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCores (MUSTER *m, long jobId, bool enable, int minimumCores)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCores (MUSTER *m, std::vector< long > id, bool enable, int minimumCores)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCoresSpeed (MUSTER *m, long jobId, bool enable, double minimumCoreSpeed)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCoresSpeed (MUSTER *m, std::vector< long > id, bool enable, double minimumCoreSpeed)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumDiskSpaceAmount (MUSTER *m, long jobId, bool enable, double minimumDiskSpace)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumDiskSpaceAmount (MUSTER *m, std::vector< long > id, bool enable, double minimumDiskSpace)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumLogicalUnits (MUSTER *m, long jobId, bool enable, int minimumLogicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumLogicalUnits (MUSTER *m, std::vector< long > id, bool enable, int minimumLogicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalGPUsUnits (MUSTER *m, long jobId, bool enable, int minimumPhysicalGPUsUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalGPUsUnits (MUSTER *m, std::vector< long > id, bool enable, int minimumPhysicalGPUsUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalUnits (MUSTER *m, long jobId, bool enable, int minimumPhysicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalUnits (MUSTER *m, std::vector< long > id, bool enable, int minimumPhysicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumRamAmount (MUSTER *m, long jobId, bool enable, double minimumRamAmount)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumRamAmount (MUSTER *m, std::vector< long > id, bool enable, double minimumRamAmount)
MCLIENTLIB_API MUSTERERR	JobActionSetNotes (MUSTER *m, long jobId, const char *notes)
MCLIENTLIB_API MUSTERERR	JobActionSetNotes (MUSTER *m, std::vector< long > id, const char *notes)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMailNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMailNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMailNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMailNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMobileNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMobileNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMobileNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideMobileNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideNotificatorNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideNotificatorNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideNotificatorNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideNotificatorNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMailNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMailNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMailNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMailNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMobileNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMobileNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMobileNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartMobileNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartNotificatorNotificationsAtChunkLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartNotificatorNotificationsAtChunkLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartNotificatorNotificationsAtJobLevel (MUSTER *m, long jobId, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOverrideStartNotificatorNotificationsAtJobLevel (MUSTER *m, std::vector< long > id, bool enable, int notificationType)
MCLIENTLIB_API MUSTERERR	JobActionSetOwner (MUSTER *m, long jobId, const char *ownerName)
MCLIENTLIB_API MUSTERERR	JobActionSetOwner (MUSTER *m, std::vector< long > id, const char *ownerName)
MCLIENTLIB_API MUSTERERR	JobActionSetParent (MUSTER *m, long jobId, long parentId)
MCLIENTLIB_API MUSTERERR	JobActionSetParent (MUSTER *m, std::vector< long > id, long parentId)
MCLIENTLIB_API MUSTERERR	JobActionSetPauseOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetPauseOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetPools (MUSTER *m, long jobId, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetPools (MUSTER *m, std::vector< long > id, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetPriority (MUSTER *m, long jobId, int priority)
MCLIENTLIB_API MUSTERERR	JobActionSetPriority (MUSTER *m, std::vector< long > id, int priority)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorExitCodes (MUSTER *m, long jobId, bool enable, const char *errorExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *errorExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidExitCodes (MUSTER *m, long jobId, bool enable, const char *validExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *validExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningExitCodes (MUSTER *m, long jobId, bool enable, const char *warningExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *warningExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProject (MUSTER *m, long jobId, const char *groupName)
MCLIENTLIB_API MUSTERERR	JobActionSetProject (MUSTER *m, std::vector< long > id, const char *groupName)
MCLIENTLIB_API MUSTERERR	JobActionSetResumeOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetResumeOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetSequence (MUSTER *m, long jobId, const char *sequenceName)
MCLIENTLIB_API MUSTERERR	JobActionSetSequence (MUSTER *m, std::vector< long > id, const char *sequenceName)
MCLIENTLIB_API MUSTERERR	JobActionSetShot (MUSTER *m, long jobId, const char *shotName)
MCLIENTLIB_API MUSTERERR	JobActionSetShot (MUSTER *m, std::vector< long > id, const char *shotName)
MCLIENTLIB_API MUSTERERR	JobActionSetStartsOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetStartsOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetTemplate (MUSTER *m, long jobId, int templateId, const std::string &version)
MCLIENTLIB_API MUSTERERR	JobActionSetTemplate (MUSTER *m, std::vector< long > id, int templateId, const std::string &version)
MCLIENTLIB_API MUSTERERR	JobActionUnarchive (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionUnarchive (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionUnlock (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionUnlock (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobBackupRemove (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobBackupRemove (MUSTER *m, std::vector< long > ids)
MCLIENTLIB_API void	LoadTemplates (const char *templatesPath)
MCLIENTLIB_API int	MNetGetCurrentMessage (MUSTERCLIENT *m)
MCLIENTLIB_API int	MNetGetCurrentMessage (MUSTER *m)
MCLIENTLIB_API int	MNetGetCurrentMessageActionId (MUSTERCLIENT *m)
MCLIENTLIB_API int	MNetGetCurrentMessageActionId (MUSTER *m)
MCLIENTLIB_API char *	MNetGetCurrentMessageData (MUSTERCLIENT *m)
MCLIENTLIB_API char *	MNetGetCurrentMessageData (MUSTER *m)
MCLIENTLIB_API std::vector< std::string >	MNetGetCurrentMessageParameters (MUSTERCLIENT *m)
MCLIENTLIB_API std::vector< std::string >	MNetGetCurrentMessageParameters (MUSTER *m)
MCLIENTLIB_API MUSTERERR	MNetGetNextMessage (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	MNetGetNextMessage (MUSTER *m)
MCLIENTLIB_API MUSTERERR	MNetSendMessage (MUSTERCLIENT *m, int message, int actionId, const char *parameters=0, bool waitForCompletion=true)
MCLIENTLIB_API MUSTERERR	MNetSendMessage (MUSTER *m, int message, int actionId, const char *parameters=0, bool waitForCompletion=true)
MCLIENTLIB_API MUSTERERR	MNetTask (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	MNetTask (MUSTER *m)
MCLIENTLIB_API MUSTERERR	MNetWaitForActionCompletation (MUSTERCLIENT *m, int actionId)
MCLIENTLIB_API MUSTERERR	MNetWaitForActionCompletation (MUSTER *m, int actionId)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessage (MUSTERCLIENT *m, int message, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessage (MUSTER *m, int message, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessages (MUSTERCLIENT *m, int messages[], int messagesCount, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessages (MUSTER *m, int messages[], int messagesCount, int actionId=0)
MCLIENTLIB_API MUSTERERR	NodeActionChangeNotes (MUSTER *m, long nodeId, const char *notes)
MCLIENTLIB_API MUSTERERR	NodeActionChangeNotes (MUSTER *m, std::vector< long > id, const char *notes)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndGo (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndGo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndPause (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndRedo (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndRedo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionPause (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionRemove (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionRemove (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionResume (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionResume (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionRunPython (MUSTER *m, long nodeId, const char *pythonCode)
MCLIENTLIB_API MUSTERERR	NodeActionRunPython (MUSTER *m, std::vector< long > id, const char *pythonCode)
MCLIENTLIB_API MUSTERERR	NodeActionRunPythonFile (MUSTER *m, long nodeId, const char *pythonFilePath)
MCLIENTLIB_API MUSTERERR	NodeActionRunPythonFile (MUSTER *m, std::vector< long > id, const char *pythonFilePath)
MCLIENTLIB_API MUSTERERR	NodeActionSoftRestart (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionSoftRestart (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionStartReserv (MUSTER *m, long nodeId, long reservId, const std::string &reservVersion)
MCLIENTLIB_API MUSTERERR	NodeActionStartReserv (MUSTER *m, std::vector< long > id, long reservId, const std::string &reservVersion)
MCLIENTLIB_API MUSTERERR	NodeActionTerminateReserv (MUSTER *m, long nodeId, long reservId, const std::string &reservVersion)
MCLIENTLIB_API MUSTERERR	NodeActionTerminateReserv (MUSTER *m, std::vector< long > id, long reservId, const std::string &reservVersion)
MCLIENTLIB_API MUSTERERR	NodeActionTimedPause (MUSTER *m, long nodeId, unsigned long long time)
MCLIENTLIB_API MUSTERERR	NodeActionTimedPause (MUSTER *m, std::vector< long > id, unsigned long long time)
MCLIENTLIB_API MUSTERERR	NodeActionTimedResume (MUSTER *m, long nodeId, unsigned long long time)
MCLIENTLIB_API MUSTERERR	NodeActionTimedResume (MUSTER *m, std::vector< long > id, unsigned long long time)
MCLIENTLIB_API MUSTERERR	RemoveActionLog (MUSTER *m, const char *filename)
MCLIENTLIB_API MUSTERERR	RemoveActivityLog (MUSTERCLIENT *m, const char *filename)
MCLIENTLIB_API MUSTERERR	RemoveActivityLog (MUSTER *m, const char *filename)
MCLIENTLIB_API MUSTERERR	RemoveGroup (MUSTER *m, const char *groupName)
MCLIENTLIB_API MUSTERERR	RemoveProcessesLog (MUSTERCLIENT *m, const char *filename)
MCLIENTLIB_API MUSTERERR	RemoveUser (MUSTER *m, const char *userName)
MCLIENTLIB_API MUSTERERR	SendAccounts (MUSTER *m, std::vector< MUser > &users, std::vector< MGroup > &groups)
MCLIENTLIB_API MUSTERERR	SendDispatcherConfiguration (MUSTER *m, MDispatcherConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	SendDispatcherLDAPConfiguration (MUSTER *m, MDispatcherConfigurationLDAP &configurationObject)
MCLIENTLIB_API MUSTERERR	SendNodeConfiguration (MUSTERCLIENT *m, MNodeConfiguration &configurationObject)
MCLIENTLIB_API void	SetClientSessionAsync (MUSTERCLIENT *m, bool state)
MCLIENTLIB_API MUSTERERR	SetPools (MUSTER *m, MPools &pools)
MCLIENTLIB_API MUSTERERR	SetRepositories (MUSTER *m, std::vector< MRepository > &repositories)
MCLIENTLIB_API void	SetSessionAsync (MUSTER *m, bool state)
MCLIENTLIB_API void	ShutdownClientSession (MUSTERCLIENT *m)
MCLIENTLIB_API void	ShutdownLibrary ()
MCLIENTLIB_API void	ShutdownSession (MUSTER *m)
MCLIENTLIB_API MUSTERERR	SynchronizeTemplates (MUSTER *m)
MCLIENTLIB_API std::string	GetSequenceMask (const std::string &path, bool hashedFormat, int &frame)
MCLIENTLIB_API std::string	GetSequenceMask (const std::string &path)
MCLIENTLIB_API std::string	GetFileFromMask (const std::string &mask, int frameNumber)
MCLIENTLIB_API std::string	GetLayerFolderFromPath (const std::string &path)

Detailed Description

MClientLib global functions.

Global functions of the MClientLib namespace

Function Documentation

MCLIENTLIB_API MUSTERERR MClientLib::AcquireServerStatus

(

MUSTER *

m

)

Queries the Dispatcher about its current status, must be called before using GetAuthenticationStatus() to retrieve the MServerStatus class

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionChangePassword	(	MUSTER *	m,
		const char *	oldPassword,
		const char *	newPassword
	)

Changes the password of the currently logged user

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	oldPassword	the old user account password
[in]	newPassword	the new user account password

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionChangeStatus

(

MUSTER *

m

)

Changes the current selection status of the Dispatcher service

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionCreateFolder	(	MUSTER *	m,
		MJob &	job
	)

Sends a new folder to the Dispatcher queue

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	job	a reference to an MJob object holding the folder informations

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionEditJob	(	MUSTER *	m,
		MJob &	job
	)

Edits an existing job to the Dispatcher queue

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	job	a reference to an MJob object holding the job informations, the job must have the job ID set to match with the existing one

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionExportQueue	(	MUSTER *	m,
		MStringRef &	queueOutput
	)

Exports a Dispatcher SQL queue dump

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	queueOutput	a reference to an MStringRef object to store the SQL data

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionForceLDAPUpdate

(

MUSTER *

m

)

Forces an LDAP update on the Dispatcher service

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionImportQueue	(	MUSTER *	m,
		MStringRef &	queueInput
	)

Imports a Dispatcher SQL queue dump

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	queueInput	a reference to an MStringRef object holding the SQL data

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionResetCounters

(

MUSTER *

m

)

Reset the statistics counters on the Dispatcher service

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionRunPython	(	MUSTER *	m,
		const char *	pythonCode
	)

Runs the supplied python code on the Dispatcher context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	pythonCode	buffer holding the python code

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionRunPythonFile	(	MUSTER *	m,
		const char *	pythonFilePath
	)

Runs the supplied python file on the Dispatcher context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	pythonFilePath	path to the python file to source and run

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionSendJob	(	MUSTER *	m,
		MJob &	job
	)

Sends a new job to the Dispatcher queue

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	job	a reference to an MJob object holding the job informations

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionSoftRestart

(

MUSTER *

m

)

Issues a soft restart on the Dispatcher service

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ActionWaitDbFlush

(

MUSTER *

m

)

Waits for DB queries to be flushed on the Dispatcher

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::AddGroup	(	MUSTER *	m,
		MGroup &	group
	)

Adds a new group to the Dispatcher groups database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	group	a reference to an MGroup object to read the group configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::AddUser	(	MUSTER *	m,
		MUser &	user
	)

Adds a new user to the Dispatcher users database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	user	a reference to an MUser object to read the users configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Authenticate	(	MUSTERCLIENT *	m,
		const char *	password
	)

Authenticate over a management connection, it may be required if a node as a password protected configuration

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	password	the management password on the node

Returns

char* the address of the data buffer

MCLIENTLIB_API MUSTERERR MClientLib::Authenticate	(	MUSTER *	m,
		const char *	username,
		const char *	password,
		bool	skipDirectoryServer = false
	)

Authenticates on the Dispatcher server

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	username	the login name for the authentication
[in]	password	password of the user used in the login name
[in]	skipDirectoryServer	skips the authentication on a directory server if enabled

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionResetRequeue	(	MUSTER *	m,
		long	jobId,
		long	chunkId
	)

Resets the requeue counter of a chunk

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	chunkId	the ID of the target chunk

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionResetRequeue	(	MUSTER *	m,
		long	jobId,
		std::vector< long >	id
	)

Resets the requeue counter of multiple chunks

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	id	a vector of long values holding the chunks IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionSetCompleted	(	MUSTER *	m,
		long	jobId,
		long	chunkId
	)

Forces the status of a chunk to completed

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	chunkId	the ID of the target chunk

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionSetCompleted	(	MUSTER *	m,
		long	jobId,
		std::vector< long >	id
	)

Forces the status of multiple chunks to Completed

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	id	a vector of long values holding the chunks IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionSetOnHold	(	MUSTER *	m,
		long	jobId,
		long	chunkId
	)

Forces the status of a chunk to On Hold

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	chunkId	the ID of the target chunk

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ChunkActionSetOnHold	(	MUSTER *	m,
		long	jobId,
		std::vector< long >	id
	)

Forces the status of multiple chunks to On Hold

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the job holding the chunk
[in]	id	a vector of long values holding the chunks IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ClearJobsHistory	(	MUSTER *	m,
		long	startingTime,
		long	endingTime
	)

Clear the jobs history database between the time range specified

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	startingTime	the starting time, as a time_c object to remove the samples
[in]	endingTime	the ending time, as a time_c object to remove the samples

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ClearStatisticsHistory	(	MUSTER *	m,
		long	startingTime,
		long	endingTime
	)

Clear the statistics history database between the time range specified

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	startingTime	the starting time, as a time_c object to remove the samples
[in]	endingTime	the ending time, as a time_c object to remove the samples

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ConfigureGroup	(	MUSTER *	m,
		MGroup &	group
	)

Configures a group on the Dispatcher groups database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	group	a reference to an MGRoup object to read the group configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::ConfigureUser	(	MUSTER *	m,
		MUser &	user
	)

Configures a user on the Dispatcher users database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	user	a reference to an MUser object to read the user configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Connect	(	MUSTERCLIENT *	m,
		const char *	clientAddress,
		int	clientPort,
		long	maxSocketReadBytes = 65000000,
		long	maxSocketWriteBytes = 65000000
	)

Connects to a node to establish a management session

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	clientAddress	the host name of IP address of the client
[in]	clientPort	the management port of the client
[in]	maxSocketReadBytes	the size in bytes of the socket read buffer
[in]	maxSocketWriteBytes	the size in bytes of the socket write buffer

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Connect	(	MUSTER *	m,
		const char *	dispatcherAddress,
		int	dispatcherPort,
		long	maxSocketReadBytes = 65000000,
		long	maxSocketWriteBytes = 65000000
	)

Connect to the Dispatcher to establish a session

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	dispatcherAddress	the host name of IP address of the dispatcher
[in]	dispatcherPort	the management port of the Dispatcher
[in]	maxSocketReadBytes	the size in bytes of the socket read buffer
[in]	maxSocketWriteBytes	the size in bytes of the socket write buffer

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Disconnect

(

MUSTERCLIENT *

m

)

Disconnect an existing client management session

Parameters

m	pointer to an existing MUSTERCLIENT session structure

Returns

[in] MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Disconnect

(

MUSTER *

m

)

Disconnect an existing Dispatcher management session

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetAccounts	(	MUSTER *	m,
		std::vector< MUser > &	users,
		std::vector< MGroup > &	groups
	)

Gets the Dispatcher users and groups configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	users	a reference to an MUser vector object to store the users configuration
[out]	groups	a reference to an MGroup vector object to store the groups configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActionLogContent	(	MUSTER *	m,
		const char *	filename,
		MStringRef &	out
	)

Gets the content of a Dispatcher action log

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filename	The filename of the log to retrieve
[out]	out	a reference to an MStringRef object to store the log content

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActionLogs	(	MUSTER *	m,
		std::vector< std::string > &	logs
	)

Gets the Dispatcher actions logs list

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	logs	a reference to a std::string vector object to store the logs filenames list

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActivityLogContent	(	MUSTERCLIENT *	m,
		const char *	filename,
		MStringRef &	out
	)

Gets the content of an activity log

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	filename	the filename of the log to retrieve
[out]	out	an MStringRef() where to store the output

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActivityLogContent	(	MUSTER *	m,
		const char *	filename,
		MStringRef &	out
	)

Gets the content of a Dispatcher activity log

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filename	The filename of the log to retrieve
[out]	out	a reference to an MStringRef object to store the log content

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActivityLogs	(	MUSTERCLIENT *	m,
		std::vector< std::string > &	logs
	)

Gets the list of the activity logs available on the node

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	logs	a vector of strings used to store the list

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetActivityLogs	(	MUSTER *	m,
		std::vector< std::string > &	logs
	)

Gets the Dispatcher activity logs list

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	logs	a reference to a std::string vector object to store the logs filenames list

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERAUTH MClientLib::GetAuthenticationStatus

(

MUSTER *

m

)

Gets the Dispatcher server current authentication status

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERAUTH a structure holding the current Dispatcher authentication status

MCLIENTLIB_API MUSTERERR MClientLib::GetBackupBounds	(	MUSTER *	m,
		MBackupQueryBoundaries &	boundaries
	)

Get the bounds and number of jobs from the backup database as an MBackupQueryBoundaries object

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	boundaries	A reference to an MBackupQueryBoundaries object to store the boundaries

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetBackupJobs	(	MUSTER *	m,
		MBackupQuery &	query,
		std::vector< MBackupJob > &	jobs
	)

Get the backup jobs entries that matches the parameters inside the MBackupQuery object

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	query	A reference to an MBackupQuery object that specifies the query filters
[out]	jobs	A reference to an MBackupJob vector to store the result of the query

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetChunk	(	MUSTER *	m,
		MChunk &	chunk,
		long	jobId,
		long	chunkId
	)

Gets a node from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	chunk	reference to an MChunk object
[in]	jobId	ID of the job to query
[in]	chunkId	ID of the chunk to query

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetChunks	(	MUSTER *	m,
		long	jobId,
		int	filterMask,
		std::vector< MChunk > &	chunks
	)

Gets the chunks list of a job from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	ID of the job to query
[in]	filterMask	specify a bit mask for the query operation made with the constants from MChunk::kChunksStatus
[out]	chunks	reference to an MChunk vector

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetDispatcherConfiguration	(	MUSTER *	m,
		MDispatcherConfiguration &	configurationObject
	)

Gets the Dispatcher active configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	configurationObject	a reference to a MDispatcherConfiguration object to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetDispatcherLDAPConfiguration	(	MUSTER *	m,
		MDispatcherConfigurationLDAP &	configurationObject
	)

Gets the Dispatcher active LDAP configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	configurationObject	a reference to a MDispatcherConfigurationLDAP object to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API std::string MClientLib::GetFileFromMask	(	const std::string &	mask,
		int	frameNumber
	)

Converts an image sequence mask to an effective file path

Parameters

mask	The path mask
frameNumber	The frame number to be substituted with the mask

Returns

A string containing the file path or empty is not available

MCLIENTLIB_API MUSTERERR MClientLib::GetGroup	(	MUSTER *	m,
		const char *	groupName,
		MGroup &	group
	)

Gets a group from the Dispatcher groups database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	groupName	the group name of the group to retrieve
[out]	group	a reference to an MGroup object to store the group configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetHistoryBounds	(	MUSTER *	m,
		MSamplesBoundaries &	boundaries
	)

Get the bounds as time_c objects of the history and jobs history database as an MSamplesBoundaries object

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	boundaries	A reference to an MSamplesBoundaries object to store the boundaries

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetJob	(	MUSTER *	m,
		MJob &	job,
		long	jobId
	)

Gets a job from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	job	reference to an MJob object
[in]	jobId	ID of the job to query

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetJobHistory	(	MUSTER *	m,
		long	jobId,
		std::vector< MHistoryChunk > &	samples
	)

Gets a set of jobs history samples belonging to a specific job ID

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the job ID to query
[out]	samples	A reference to a vector of MHistoryChunk objects to store the samples

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetJobs	(	MUSTER *	m,
		int	filterMask,
		std::vector< MJob > &	jobs,
		bool	queryArchived
	)

Gets the jobs list from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filterMask	specify a bit mask for the query operation made with the constants from MJob::kJobsStatus
[out]	jobs	reference to an MJob vector
[in]	queryArchived	includes the archivied jobs in the query

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetJobsHistory	(	MUSTER *	m,
		long	startingTime,
		long	endingTime,
		const char *	filterField,
		const char *	filter,
		std::vector< MHistoryChunk > &	samples
	)

Gets a set of jobs history samples

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	startingTime	the starting time, as a time_c object to collect the samples
[in]	endingTime	the ending time, as a time_c object to collect the samples
[in]	filterField	the name of the field to use as a filter to collect the samples
[in]	filter	the content of the filter that must match to query the samples
[out]	samples	A reference to a vector of MHistoryChunk objects to store the samples

Returns

MUSTERERR error code

MCLIENTLIB_API std::string MClientLib::GetLayerFolderFromPath

(

const std::string &

path

)

Gets the folder name containing the frames, usefull to detect the layer name for multilayer renders

Parameters

path	The path mask

Returns

A string containing the folder name

MCLIENTLIB_API std::string MClientLib::GetLibraryPath

(

)

Gets the library execution path. When invoked from within a template, it returns the Muster installation path

Returns

std::string path to the library execution path

MCLIENTLIB_API MUSTERERR MClientLib::GetLogs	(	MUSTER *	m,
		int	filterMask,
		std::vector< MLog > &	logs
	)

Gets the logs list from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filterMask	specify a bit mask for the query operation made with the constants from MLog::kLogsSource
[out]	logs	reference to an MLog vector

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetNode	(	MUSTER *	m,
		MNode &	node,
		long	nodeId
	)

Gets a node from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	node	reference to an MNode object
[in]	nodeId	ID of the node to query

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetNodeConfiguration	(	MUSTERCLIENT *	m,
		MNodeConfiguration &	configurationObject
	)

Retrieves the node current configuration as an MNodeConfiguration object

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	configurationObject	the MNodeConfiguration object used to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetNodes	(	MUSTER *	m,
		int	filterMask,
		std::vector< MNode > &	nodes
	)

Gets the nodes list from the Dispatcher

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filterMask	specify a bit mask for the query operation made with the constants from MNode::kInstancesStatus
[out]	nodes	reference to an MNode vector

Returns

MUSTERERR error code

MCLIENTLIB_API int MClientLib::GetPlatform

(

)

Gets the current active platform

Returns

int a platform enumeration from MClientLib::kPlatformEnumeration

MCLIENTLIB_API MUSTERERR MClientLib::GetPools	(	MUSTER *	m,
		MPools &	pools
	)

Gets the Dispatcher pools configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	pools	a reference to a MPools object to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetProcessesLogContent	(	MUSTERCLIENT *	m,
		const char *	filename,
		MStringRef &	out
	)

Gets the content of a process log

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	filename	the filename of the log to retrieve
[out]	out	an MStringRef() where to store the output

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetProcessesLogs	(	MUSTERCLIENT *	m,
		std::vector< std::string > &	logs
	)

Gets the list of the processes logs available on the node

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[out]	logs	a vector of strings used to store the list

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetRepositories	(	MUSTER *	m,
		std::vector< MRepository > &	repositories
	)

Gets the Dispatcher repositories list configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	repositories	a reference to an MRepository vector object to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API std::string MClientLib::GetSequenceMask	(	const std::string &	path,
		bool	hashedFormat,
		int &	frame
	)

Converts an image frame to a frame sequence mask with # for number padding

Parameters

path	The frame path
hashedFormat	Specifies if an hashed format should be generated (file.####.) or a ffmpeg style one (file.%4d..)
frame	An int reference for the frame detected inside the path

Returns

A string containing the mask or empty if not available

MCLIENTLIB_API std::string MClientLib::GetSequenceMask

(

const std::string &

path

)

Converts an image frame to a frame sequence mask with # for number padding

Parameters

path	The frame path

Returns

A string containing the mask or empty if not available

MCLIENTLIB_API MServerStatus MClientLib::GetServerStatus

(

MUSTER *

m

)

Gets the Dispatcher server current status

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERSERVER a structure holding the current dispatcher status

MCLIENTLIB_API MUSTERERR MClientLib::GetStatistics	(	MUSTER *	m,
		MDispatcherStatistics &	statistics
	)

Gets the current statistic samples from the Dispatcher service

Parameters

[in]	m	pointer to an existing MUSTER session structure
[out]	statistics	A reference to a MDispatcherStatistics objects to store the samples

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetStatisticsHistory	(	MUSTER *	m,
		long	startingTime,
		long	endingTime,
		std::vector< MStatisticsSample > &	samples
	)

Gets a set of statistics history samples

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	startingTime	the starting time, as a time_c object to collect the samples
[in]	endingTime	the ending time, as a time_c object to collect the samples
[out]	samples	A reference to a vector of MStatisticsSample objects to store the samples

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetUser	(	MUSTER *	m,
		const char *	userName,
		MUser &	user
	)

Gets a user from the Dispatcher users database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	userName	the login name of the user to retrieve
[out]	user	a reference to an MUser object to store the user configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERCLIENT* MClientLib::InitializeClientSession

(

void

)

Initializes a new connection session to a render client node

Returns

pointer to a MUSTERCLIENT session structure

MCLIENTLIB_API MUSTERERR MClientLib::InitializeLibrary

(

const char *

module

)

Initializes the client library. This must be the first function called!

Parameters

[in]

module

path to the executable, usually argv[0]

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTER* MClientLib::InitializeSession

(

void

)

Initializes a new connection session to the Dispatcher

Returns

pointer to a MUSTER session structure

MCLIENTLIB_API MUSTERERR MClientLib::JobActionArchive	(	MUSTER *	m,
		long	jobId
	)

Archives a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionArchive	(	MUSTER *	m,
		std::vector< long >	id
	)

Archives multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionBackup	(	MUSTER *	m,
		long	jobId,
		int	jobBackupOverwriteMode
	)

Backups the job specified by the id.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	a long value of the job ID
[in]	jobBackupOverwriteMode	a bitmask of the modes specified in MJob::kJobsBackupAction

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionBackup	(	MUSTER *	m,
		std::vector< long >	ids,
		int	jobBackupOverwriteMode
	)

Backups the jobs specified by the ids list.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	ids	a vector of long values holding the jobs IDs
[in]	jobBackupOverwriteMode	a bitmask of the modes specified in MJob::kJobsBackupAction

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionBackupAndDelete	(	MUSTER *	m,
		long	jobId,
		int	jobBackupOverwriteMode
	)

Backups and deletes the job specified by the id.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	a long value of the job ID
[in]	jobBackupOverwriteMode	a bitmask of the modes specified in MJob::kJobsBackupAction

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionBackupAndDelete	(	MUSTER *	m,
		std::vector< long >	ids,
		int	jobBackupOverwriteMode
	)

Backups and deletes the jobs specified by the ids list.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	ids	a vector of long values holding the jobs IDs
[in]	jobBackupOverwriteMode	a bitmask of the modes specified in MJob::kJobsBackupAction

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionDelete	(	MUSTER *	m,
		long	jobId
	)

Deletes an existing job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionDelete	(	MUSTER *	m,
		std::vector< long >	id
	)

Deletes multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndGoOn	(	MUSTER *	m,
		long	jobId
	)

Sends a kill and go on command to a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndGoOn	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and go on command to multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndPause	(	MUSTER *	m,
		long	jobId
	)

Sends a kill and pause command to a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndPause	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and pause command to multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndRedo	(	MUSTER *	m,
		long	jobId
	)

Sends a kill and redo command to a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionKillAndRedo	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and redo command to multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionLock	(	MUSTER *	m,
		long	jobId
	)

Locks an unlocked job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionLock	(	MUSTER *	m,
		std::vector< long >	id
	)

Locks multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionPause	(	MUSTER *	m,
		long	jobId
	)

Pauses a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionPause	(	MUSTER *	m,
		std::vector< long >	id
	)

Pauses multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionReinit	(	MUSTER *	m,
		long	jobId
	)

Reinits a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionReinit	(	MUSTER *	m,
		std::vector< long >	id
	)

Reinits multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRemoveAttribute	(	MUSTER *	m,
		long	jobId,
		const char *	attributeName
	)

Removes a job attribute

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	attributeName	the key name of the attribute

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRemoveAttribute	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	attributeName
	)

Removes jobs attributes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	attributeName	the key name of the attribute

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRename	(	MUSTER *	m,
		long	jobId,
		const char *	name
	)

Renames a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	name	the new job name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRename	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	name
	)

Renames multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	name	the name for the jobs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRestartFrameCheck	(	MUSTER *	m,
		long	jobId
	)

Restarts the scene frame check on a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRestartFrameCheck	(	MUSTER *	m,
		std::vector< long >	id
	)

Restarts frame check on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRestore	(	MUSTER *	m,
		long	jobId,
		int	jobRestoreActionMode,
		int	jobRestoreReparentId
	)

Restores the job specified by the id. Job ID's must be backup database IDs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	a long value of the job ID
[in]	jobRestoreActionMode	a bitmask of the action mode specified in MJob::kJobsBackupRestoreAction
[in]	jobRestoreReparentId	a parent ID of reparent is selected in jobRestoreActionMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionRestore	(	MUSTER *	m,
		std::vector< long >	ids,
		int	jobRestoreActionMode,
		int	jobRestoreReparentId
	)

Restores the jobs specified by the ids list. Job ID's must be backup database IDs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	ids	a vector of long values holding the jobs IDs
[in]	jobRestoreActionMode	a bitmask of the action mode specified in MJob::kJobsBackupRestoreAction
[in]	jobRestoreReparentId	a parent ID of reparent is selected in jobRestoreActionMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionResume	(	MUSTER *	m,
		long	jobId
	)

Resumes a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionResume	(	MUSTER *	m,
		std::vector< long >	id
	)

Resumes multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetAttribute	(	MUSTER *	m,
		long	jobId,
		const char *	attributeName,
		bool	enable,
		const char *	attributeValue
	)

Sets a job attribute

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	attributeName	the key name of the attribute
[in]	enable	the attribute state
[in]	attributeValue	the new value for the attribute

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetAttribute	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	attributeName,
		bool	enable,
		const char *	attributeValue
	)

Sets a job attribute

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	attributeName	the key name of the attribute
[in]	enable	enabled the override check
[in]	attributeValue	the attribute value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetBorrowInstances	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	borrowInstances
	)

Sets a job's instances to borrow

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	borrowInstances	the number of instances to borrow

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetBorrowInstances	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	borrowInstances
	)

Sets the job's number of instances to borrow

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	borrowInstances	the number of instances to borrow

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetCamera	(	MUSTER *	m,
		long	jobId,
		const char *	cameraName
	)

Sets a job camera

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	cameraName	the new camera name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetCamera	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	cameraName
	)

Sets camera on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	cameraName	the new department name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetChunkMaximumRequeueOverride	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	maximumRequeue
	)

Sets a job chunks maximum requeue override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	maximumRequeue	the maximum requeue amount

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetChunkMaximumRequeueOverride	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	maximumRequeue
	)

Sets a job chunks maximum requeue count

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	maximumRequeue	the maximum requeue count

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetChunkTimeoutOverride	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	timeout
	)

Sets a job chunks timeout override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	timeout	the chunk timeout

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetChunkTimeoutOverride	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	timeout
	)

Sets a job chunk timeout override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	timeout	the timeout in minutes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDepartment	(	MUSTER *	m,
		long	jobId,
		const char *	departmentName
	)

Sets a job department

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	departmentName	the new department name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDepartment	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	departmentName
	)

Sets department on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	departmentName	the new department name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDependLinkMode	(	MUSTER *	m,
		long	jobId,
		int	dependLinkMode
	)

Sets a job dependencies evaluation link mode

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	dependLinkMode	one of the values from MJob::kJobsDependLinkMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDependLinkMode	(	MUSTER *	m,
		std::vector< long >	id,
		int	dependLinkMode
	)

Sets the dependencies evaluation link mode on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	dependLinkMode	one of the values from MJob::kJobsDependLinkMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDependMode	(	MUSTER *	m,
		long	jobId,
		int	dependMode
	)

Sets a job dependencies evaluation mode

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	dependMode	one of the values from MJob::kJobsDependMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDependMode	(	MUSTER *	m,
		std::vector< long >	id,
		int	dependMode
	)

Sets the dependencies evaluation mode on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	dependMode	one of the values from MJob::kJobsDependMode

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDepends	(	MUSTER *	m,
		long	jobId,
		const char *	depends
	)

Sets a job dependencies

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	depends	comma separated list of job dependencies

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetDepends	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	depends
	)

Sets dependencies on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	depends	comma separated list of job dependencies

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetEmergencyQueue	(	MUSTER *	m,
		long	jobId,
		bool	state
	)

Sets a job emergency queue status

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	state	the new emergency queue state

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetEmergencyQueue	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enabled
	)

Sets emergency queue status on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enabled	the new emergency queue status

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetExcludedPools	(	MUSTER *	m,
		long	jobId,
		const char *	pools
	)

Sets a job excluded pools

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	pools	the excluded pools name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetExcludedPools	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	pools
	)

Sets excluded pools on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	pools	the excluded pools name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetExitCodesErrorCheckType	(	MUSTER *	m,
		long	jobId,
		MJob::kErrorChecksType	type
	)

Sets a job exit codes error check level type

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	type	a value for the MJob::kErrorChecksType enumeration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetExitCodesErrorCheckType	(	MUSTER *	m,
		std::vector< long >	id,
		MJob::kErrorChecksType	type
	)

Sets a job exit codes error check level type

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	type	a value for the MJob::kErrorChecksType enumeration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetLogsErrorCheckType	(	MUSTER *	m,
		long	jobId,
		MJob::kErrorChecksType	type
	)

Sets a job logs parsing check level type

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	type	a value for the MJob::kErrorChecksType enumeration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetLogsErrorCheckType	(	MUSTER *	m,
		std::vector< long >	id,
		MJob::kErrorChecksType	type
	)

Sets a job logs parsing check level type

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	type	a value for the MJob::kErrorChecksType enumeration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetLogsParsingRules	(	MUSTER *	m,
		long	jobId,
		const std::vector< MClientLib::MTextFileRule > &	rules
	)

Sets a job logs parsing rules

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	rules	a reference to a vector of MClientLib::MTextFileRule rules

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetLogsParsingRules	(	MUSTER *	m,
		std::vector< long >	id,
		const std::vector< MClientLib::MTextFileRule > &	rules
	)

Sets a job logs parsing rules

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	rules	a reference to a vector of MClientLib::MTextFileRule rules

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMaximumNodes	(	MUSTER *	m,
		long	jobId,
		int	maximumNodes
	)

Sets a job maximum rendering nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	maximumNodes	the maximum amount of concurrent render nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMaximumNodes	(	MUSTER *	m,
		std::vector< long >	id,
		int	maximumNodes
	)

Sets maximum rendering nodes on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	maximumNodes	the maximum amount of concurrent render nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumCores	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	minimumCores
	)

Sets a job minimum cores

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumCores	the number of cores threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumCores	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	minimumCores
	)

Sets the minimum cores on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumCores	the number of cores threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumCoresSpeed	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		double	minimumCoreSpeed
	)

Sets a job minimum cores speed

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumCoreSpeed	the cores speed threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumCoresSpeed	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		double	minimumCoreSpeed
	)

Sets the minimum cores speed on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumCoreSpeed	the cores speed threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumDiskSpaceAmount	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		double	minimumDiskSpace
	)

Sets a job minimum space amount

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumDiskSpace	the disk space threshold in MB

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumDiskSpaceAmount	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		double	minimumDiskSpace
	)

Sets the minimum space amount on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumDiskSpace	the disk space threshold in MB

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumLogicalUnits	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	minimumLogicalUnits
	)

Sets a job minimum logical units

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumLogicalUnits	the minimum logical units

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumLogicalUnits	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	minimumLogicalUnits
	)

Sets a job minimum logical units on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumLogicalUnits	the minimum logical units amount

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumPhysicalGPUsUnits	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	minimumPhysicalGPUsUnits
	)

Sets a job minimum physical units

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumPhysicalGPUsUnits	the number of physical gpus units threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumPhysicalGPUsUnits	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	minimumPhysicalGPUsUnits
	)

Sets the minimum physical GPUs units on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumPhysicalUnits	the number of physical units threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumPhysicalUnits	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	minimumPhysicalUnits
	)

Sets a job minimum physical units

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumPhysicalUnits	the number of physical units threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumPhysicalUnits	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	minimumPhysicalUnits
	)

Sets the minimum physical units on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumPhysicalUnits	the number of physical units threshold

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumRamAmount	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		double	minimumRamAmount
	)

Sets a job minimum ram amount

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	minimumRamAmount	the RAM threshold in MB

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetMinimumRamAmount	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		double	minimumRamAmount
	)

Sets the minimum ram amount on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	minimumRamAmount	the RAM threshold in MB

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetNotes	(	MUSTER *	m,
		long	jobId,
		const char *	notes
	)

Sets a job notes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	notes	the new job notes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetNotes	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	notes
	)

Sets notes on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	notes	the new job notes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMailNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mail notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMailNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job mail notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMailNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mail notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMailNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job mail notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMobileNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mobile notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMobileNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job mobile notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMobileNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mobile notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideMobileNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job mobile notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideNotificatorNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job notificator notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideNotificatorNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job notificator notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideNotificatorNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job notificator notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideNotificatorNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job notificator notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMailNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mail start notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMailNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start mail notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMailNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job mail start notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMailNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start mail notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMobileNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job start mobile notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMobileNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start mobile notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMobileNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job start mobile notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartMobileNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start mobile notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartNotificatorNotificationsAtChunkLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job start notificator notifications at chunk level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartNotificatorNotificationsAtChunkLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start notificator notifications at chunks level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartNotificatorNotificationsAtJobLevel	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		int	notificationType
	)

Sets a job start notificator notifications at job level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOverrideStartNotificatorNotificationsAtJobLevel	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		int	notificationType
	)

Sets a job start notificator notifications level override

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	notificationType	the notification type

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOwner	(	MUSTER *	m,
		long	jobId,
		const char *	ownerName
	)

Sets a job owner

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	ownerName	the login name of the new owner

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetOwner	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	ownerName
	)

Sets a job owner on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	ownerName	the login name of the new owner

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetParent	(	MUSTER *	m,
		long	jobId,
		long	parentId
	)

Sets a job parent

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	parentId	the ID of the job parent

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetParent	(	MUSTER *	m,
		std::vector< long >	id,
		long	parentId
	)

Sets the parent of multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	parentId	the ID of the job parent

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPauseOn	(	MUSTER *	m,
		long	jobId,
		long long int	time
	)

Sets a job pausing time

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	time	time to pause as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPauseOn	(	MUSTER *	m,
		std::vector< long >	id,
		long long int	time
	)

Sets the pausing time on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	time	time to pause as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPools	(	MUSTER *	m,
		long	jobId,
		const char *	pools
	)

Sets a job included pools

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	pools	the included pools name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPools	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	pools
	)

Sets included pools on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	pools	the included pools name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPriority	(	MUSTER *	m,
		long	jobId,
		int	priority
	)

Sets a job priority

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	priority	the new job priority value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetPriority	(	MUSTER *	m,
		std::vector< long >	id,
		int	priority
	)

Sets priority on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	priority	the new job priority value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessErrorExitCodes	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		const char *	errorExitCodes
	)

Sets a job error exit codes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	errorExitCodes	a comma separated list of error exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessErrorExitCodes	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		const char *	errorExitCodes
	)

Sets the error exit codes on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	errorExitCodes	a comma separated list of error exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessValidExitCodes	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		const char *	validExitCodes
	)

Sets a job valid exit codes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	validExitCodes	a comma separated list of valid exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessValidExitCodes	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		const char *	validExitCodes
	)

Sets the valid exit codes on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	validExitCodes	a comma separated list of valid exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessWarningExitCodes	(	MUSTER *	m,
		long	jobId,
		bool	enable,
		const char *	warningExitCodes
	)

Sets a job warning exit codes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	enable	enabled the override check
[in]	warningExitCodes	a comma separated list of warning exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProcessWarningExitCodes	(	MUSTER *	m,
		std::vector< long >	id,
		bool	enable,
		const char *	warningExitCodes
	)

Sets the warning exit codes on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	enable	enabled the override check
[in]	warningExitCodes	a comma separated list of warning exit codes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProject	(	MUSTER *	m,
		long	jobId,
		const char *	groupName
	)

Sets a job project

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	groupName	the new project name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetProject	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	groupName
	)

Sets project on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	groupName	the new project name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetResumeOn	(	MUSTER *	m,
		long	jobId,
		long long int	time
	)

Sets a job resuming time

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	time	time to resume as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetResumeOn	(	MUSTER *	m,
		std::vector< long >	id,
		long long int	time
	)

Sets the resuming time on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	time	time to resume as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetSequence	(	MUSTER *	m,
		long	jobId,
		const char *	sequenceName
	)

Sets a job sequence

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	sequenceName	the new sequence name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetSequence	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	sequenceName
	)

Sets sequence on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	sequenceName	the new department name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetShot	(	MUSTER *	m,
		long	jobId,
		const char *	shotName
	)

Sets a job shot

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	shotName	the new shot name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetShot	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	shotName
	)

Sets shot on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	shotName	the new department name

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetStartsOn	(	MUSTER *	m,
		long	jobId,
		long long int	time
	)

Sets a job starting time

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	time	time to start as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetStartsOn	(	MUSTER *	m,
		std::vector< long >	id,
		long long int	time
	)

Sets the starting time on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	time	time to start as a time_c value

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetTemplate	(	MUSTER *	m,
		long	jobId,
		int	templateId,
		const std::string &	version
	)

Sets a job template

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job
[in]	templateId	the ID of the job template
[in]	version	the template version if available

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetTemplate	(	MUSTER *	m,
		std::vector< long >	id,
		int	templateId,
		const std::string &	version
	)

Sets the template on multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs
[in]	templateId	the ID of the job template
[in]	version	the template version

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionUnarchive	(	MUSTER *	m,
		long	jobId
	)

Unarchives a job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionUnarchive	(	MUSTER *	m,
		std::vector< long >	id
	)

Unarchives multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionUnlock	(	MUSTER *	m,
		long	jobId
	)

Unlocks a locked job

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the target job

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionUnlock	(	MUSTER *	m,
		std::vector< long >	id
	)

Unlocks multiple jobs

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobBackupRemove	(	MUSTER *	m,
		long	jobId
	)

Deletes the backup job pecified by the id.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	jobId	the ID of the backup job to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobBackupRemove	(	MUSTER *	m,
		std::vector< long >	ids
	)

Deletes the backup jobs pecified by the ids.

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	ids	a vector of long values holding the jobs IDs

Returns

MUSTERERR error code

MCLIENTLIB_API void MClientLib::LoadTemplates

(

const char *

templatesPath

)

Loads the templates available at the specified path into the current template manager context

Parameters

[in]

templatesPath

Path to the directory holding the templates files

MCLIENTLIB_API int MClientLib::MNetGetCurrentMessage

(

MUSTERCLIENT *

m

)

Get the current message retrieved by a previous call to MNGetNextMessage

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

Returns

MUSTERERR error code

MCLIENTLIB_API int MClientLib::MNetGetCurrentMessage

(

MUSTER *

m

)

Get the current message retrieved by a previous call to MNGetNextMessage

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API int MClientLib::MNetGetCurrentMessageActionId

(

MUSTERCLIENT *

m

)

Get the action ID associated with the current message

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

Returns

int the message

MCLIENTLIB_API int MClientLib::MNetGetCurrentMessageActionId

(

MUSTER *

m

)

Get the action ID associated with the current message

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

the message

MCLIENTLIB_API char* MClientLib::MNetGetCurrentMessageData

(

MUSTERCLIENT *

m

)

Get the current message parameters as a buffer

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

Returns

std::vector<std::string> a vector of strings with the parameters

MCLIENTLIB_API char* MClientLib::MNetGetCurrentMessageData

(

MUSTER *

m

)

Get the current message parameters as a buffer

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

std::vector<std::string> a vector of strings with the parameters

MCLIENTLIB_API std::vector<std::string> MClientLib::MNetGetCurrentMessageParameters

(

MUSTERCLIENT *

m

)

Get the current message parameters as a vector of string

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

Returns

int the action ID

MCLIENTLIB_API std::vector<std::string> MClientLib::MNetGetCurrentMessageParameters

(

MUSTER *

m

)

Get the current message parameters as a vector of string

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

the action ID

MCLIENTLIB_API MUSTERERR MClientLib::MNetGetNextMessage

(

MUSTERCLIENT *

m

)

Get the next message in the socket queue. This is a blocking operation if no mmessage is available

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetGetNextMessage

(

MUSTER *

m

)

Get the next message in the socket queue. This is a blocking operation if no mmessage is available

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetSendMessage	(	MUSTERCLIENT *	m,
		int	message,
		int	actionId,
		const char *	parameters = 0,
		bool	waitForCompletion = true
	)

Sends a network message on an existing node management session

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	message	the message to send
[in]	actionId	an optional ID to identify the message action. If an ID is specified the function will return only after completion
[in]	parameters	additional parameters to concatenate to the message
[in]	waitForCompletion	if an actionId is specified, setting the parameter to false let you wait for a completion later using MNetWaitForMessage()

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetSendMessage	(	MUSTER *	m,
		int	message,
		int	actionId,
		const char *	parameters = 0,
		bool	waitForCompletion = true
	)

Sends a network message on an existing node management session

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	message	the message to send
[in]	actionId	an optional ID to identify the message action. If an ID is specified the function will return only after completion
[in]	parameters	additional parameters to concatenate to the message
[in]	waitForCompletion	if an actionId is specified, setting the parameter to false let you wait for a completion later using MNetWaitForMessage()

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetTask

(

MUSTERCLIENT *

m

)

Forces an event loop on the network connection to retrieve messages or send queued ones

Parameters

m	pointer to an existing MUSTERCLIENT session structure

Returns

[in] MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetTask

(

MUSTER *

m

)

Forces an event loop on the network connection to retrieve messages or send queued ones

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForActionCompletation	(	MUSTERCLIENT *	m,
		int	actionId
	)

Wait for the completion of a specific action

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	actionId	action to wait for

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForActionCompletation	(	MUSTER *	m,
		int	actionId
	)

Wait for the completion of a specific action

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	actionId	action to wait for

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForMessage	(	MUSTERCLIENT *	m,
		int	message,
		int	actionId = 0
	)

Wait for a specific message or an action completion if an actionId is used

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	message	message to wait for
[in]	actionId	optional action ID

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForMessage	(	MUSTER *	m,
		int	message,
		int	actionId = 0
	)

Wait for a specific message or an action completion if an actionId is used

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	message	message to wait for
[in]	actionId	optional action ID

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForMessages	(	MUSTERCLIENT *	m,
		int	messages[],
		int	messagesCount,
		int	actionId = 0
	)

Wait for specific messages or an action completion if an actionId is used

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	messages	array of messages to wait for
[in]	messagesCount	number of messages in the array
[in]	actionId	optional action ID

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::MNetWaitForMessages	(	MUSTER *	m,
		int	messages[],
		int	messagesCount,
		int	actionId = 0
	)

Wait for specific messages or an action completion if an actionId is used

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	messages	array of messages to wait for
[in]	messagesCount	number of messages in the array
[in]	actionId	optional action ID

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionChangeNotes	(	MUSTER *	m,
		long	nodeId,
		const char *	notes
	)

Sets the notes on a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node
[in]	notes	the new content of the notes field

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionChangeNotes	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	notes
	)

Changes the notes to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes
[in]	notes	the new content of the notes field

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndGo	(	MUSTER *	m,
		long	nodeId
	)

Sends a kill and go command to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndGo	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and go command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndPause	(	MUSTER *	m,
		long	nodeId
	)

Sends a kill and pause command to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndPause	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndRedo	(	MUSTER *	m,
		long	nodeId
	)

Sends a kill and redo command to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionKillAndRedo	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a kill and redo command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionPause	(	MUSTER *	m,
		long	nodeId
	)

Sends a pause command to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionPause	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRemove	(	MUSTER *	m,
		long	nodeId
	)

Removes an offline node from the queue

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRemove	(	MUSTER *	m,
		std::vector< long >	id
	)

Removes an offline node from the queue

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionResume	(	MUSTER *	m,
		long	nodeId
	)

Sends a resume command to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionResume	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a resume command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRunPython	(	MUSTER *	m,
		long	nodeId,
		const char *	pythonCode
	)

Runs the supplied python code on a node context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node
[in]	pythonCode	buffer holding the python code

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRunPython	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	pythonCode
	)

Runs the supplied python code on multiple nodes context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	pythonCode	buffer holding the python code

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRunPythonFile	(	MUSTER *	m,
		long	nodeId,
		const char *	pythonFilePath
	)

Runs the supplied python file on a node context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node
[in]	pythonFilePath	path to the python file to source and run

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionRunPythonFile	(	MUSTER *	m,
		std::vector< long >	id,
		const char *	pythonFilePath
	)

Runs the supplied python file on multiple nodes context

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	pythonFilePath	path to the python file to source and run

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionSoftRestart	(	MUSTER *	m,
		long	nodeId
	)

Sends a soft restart to a node

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionSoftRestart	(	MUSTER *	m,
		std::vector< long >	id
	)

Sends a soft restart to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionStartReserv	(	MUSTER *	m,
		long	nodeId,
		long	reservId,
		const std::string &	reservVersion
	)

Starts a reserv on the given nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	reserverId	the template ID of the reserv
[in]	reserverVersion	the specific version of the reserv or blank

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionStartReserv	(	MUSTER *	m,
		std::vector< long >	id,
		long	reservId,
		const std::string &	reservVersion
	)

Starts a reserv on the given nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	reserverId	the template ID of the reserv
[in]	reserverVersion	the specific version of the reserv or blank

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTerminateReserv	(	MUSTER *	m,
		long	nodeId,
		long	reservId,
		const std::string &	reservVersion
	)

Terminates a reserv on the given nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	reserverId	the template ID of the reserv
[in]	reserverVersion	the specific version of the reserv or blank

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTerminateReserv	(	MUSTER *	m,
		std::vector< long >	id,
		long	reservId,
		const std::string &	reservVersion
	)

Terminates a reserv on the given nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of target nodes IDs
[in]	reserverId	the template ID of the reserv
[in]	reserverVersion	the specific version of the reserv or blank

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTimedPause	(	MUSTER *	m,
		long	nodeId,
		unsigned long long	time
	)

Sends a timed pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node
[in]	time	a unsigned long long value of when the node should be paused

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTimedPause	(	MUSTER *	m,
		std::vector< long >	id,
		unsigned long long	time
	)

Sends a timed pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes
[in]	time	a unsigned long long value of when the node should be paused

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTimedResume	(	MUSTER *	m,
		long	nodeId,
		unsigned long long	time
	)

Sends a timed pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	nodeId	the ID of the target node
[in]	time	a unsigned long long value of when the node should be paused

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::NodeActionTimedResume	(	MUSTER *	m,
		std::vector< long >	id,
		unsigned long long	time
	)

Sends a timed pause command to multiple nodes

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	id	a vector of long values holding the IDs of the target nodes
[in]	time	a unsigned long long value of when the node should be paused

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveActionLog	(	MUSTER *	m,
		const char *	filename
	)

Removes a Dispatcher action log

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filename	The filename of the log to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveActivityLog	(	MUSTERCLIENT *	m,
		const char *	filename
	)

Removes an activity log file

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	filename	the filename of the log to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveActivityLog	(	MUSTER *	m,
		const char *	filename
	)

Removes a Dispatcher activity log

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	filename	The filename of the log to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveGroup	(	MUSTER *	m,
		const char *	groupName
	)

Removes a group from the Dispatcher groups database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	groupName	the group name of the group to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveProcessesLog	(	MUSTERCLIENT *	m,
		const char *	filename
	)

Removes a process log file

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	filename	the filename of the log to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::RemoveUser	(	MUSTER *	m,
		const char *	userName
	)

Removes a user from the Dispatcher users database

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	userName	the login name of the user to remove

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::SendAccounts	(	MUSTER *	m,
		std::vector< MUser > &	users,
		std::vector< MGroup > &	groups
	)

Sets the Dispatcher users and groups configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	users	a reference to an MUser vector object to read the users configuration
[in]	groups	a reference to an MGroup vector object to read the groups configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::SendDispatcherConfiguration	(	MUSTER *	m,
		MDispatcherConfiguration &	configurationObject
	)

Sends the Dispatcher configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	configurationObject	a reference to a MDispatcherConfiguration object to read the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::SendDispatcherLDAPConfiguration	(	MUSTER *	m,
		MDispatcherConfigurationLDAP &	configurationObject
	)

Sends the Dispatcher LDAP configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	configurationObject	a reference to a MDispatcherConfigurationLDAP object to read the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::SendNodeConfiguration	(	MUSTERCLIENT *	m,
		MNodeConfiguration &	configurationObject
	)

Reconfigures a node

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	configurationObject	the MNodeConfiguration object used to store the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API void MClientLib::SetClientSessionAsync	(	MUSTERCLIENT *	m,
		bool	state
	)

Set synchronous or asynchronous mode for an existing render client node session

Parameters

[in]	m	pointer to an existing MUSTERCLIENT session structure
[in]	state	sets asynchronous state to true or false

MCLIENTLIB_API MUSTERERR MClientLib::SetPools	(	MUSTER *	m,
		MPools &	pools
	)

Sends the Dispatcher pools configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	pools	a reference to a MPools object to read the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::SetRepositories	(	MUSTER *	m,
		std::vector< MRepository > &	repositories
	)

Sends the Dispatcher repositories list configuration

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	repositories	a reference to an MRepository vector object to read the configuration

Returns

MUSTERERR error code

MCLIENTLIB_API void MClientLib::SetSessionAsync	(	MUSTER *	m,
		bool	state
	)

Set synchronous or asynchronous mode for an existing Dispatcher connection session

Parameters

[in]	m	pointer to an existing MUSTER session structure
[in]	state	sets asynchronous state to true or false

MCLIENTLIB_API void MClientLib::ShutdownClientSession

(

MUSTERCLIENT *

m

)

Deallocates a connection session to a render client node

Parameters

[in]

m

pointer to an existing MUSTERCLIENT session structure

MCLIENTLIB_API void MClientLib::ShutdownLibrary

(

)

Shutdowns the client library. This must be the last function called to release internal data binds and allocated memory

MCLIENTLIB_API void MClientLib::ShutdownSession

(

MUSTER *

m

)

Deallocates a connection session to the Dispatcher

Parameters

[in]

m

pointer to an existing MUSTER session structure

MCLIENTLIB_API MUSTERERR MClientLib::SynchronizeTemplates

(

MUSTER *

m

)

Synchronize the templates with the ones on the Dispatcher. Any software that needs to perform job submissions or parameters lookup should synchronize before call any function

Parameters

[in]

m

pointer to an existing MUSTER session structure

Returns

MUSTERERR error code