MClientLib Namespace Reference

Classes
struct	MUSTERAUTH
class	MChunk
class	MDispatcherConfigurationGeneral
class	MDispatcherConfigurationDatabase
class	MDispatcherConfigurationBehaviours
class	MDispatcherConfigurationLogs
class	MDispatcherConfigurationNotificator
class	MDispatcherConfigurationMailer
class	MDispatcherConfigurationNetwork
class	MDispatcherConfigurationWebserver
class	MDispatcherConfigurationFaults
class	MDispatcherConfigurationActions
class	MDispatcherConfiguration
class	MDispatcherConfigurationLDAP
class	MDispatcherStatistics
class	MDrive
class	MDriveMap
class	MUSTERERR
class	MGroup
class	MHistoryChunk
class	MJobFramesCheck
class	MJobPathTranslator
class	MJob
class	MLog
class	MMailList
class	MNode
class	MNodeConfigurationBehaviours
class	MNodeConfigurationLogs
class	MNodeConfigurationNetwork
class	MNodeConfigurationMappingsAndPaths
class	MNodeConfigurationAvailability
class	MNodeConfigurationShutdown
class	MNodeConfigurationWakeup
class	MNodeConfiguration
class	MPoolItem
class	MPool
class	MPools
class	MPriorityOverride
struct	MProcessSnapshot
class	MEnvironment
struct	itemAttribute
class	MPropertiesMap
class	MRepository
class	MSamplesBoundaries
class	MServerStatus
struct	MUSTER
struct	MUSTERCLIENT
class	MStatisticsSample
class	MStringRef
class	MTemplateVariable
class	MTimeRule
class	MUser

Typedefs
typedef struct MClientLib::MUSTERAUTH	MUSTERAUTH
typedef std::vector < MProcessSnapshot * >	processesSnapshot
typedef struct MClientLib::itemAttribute	itemAttribute
typedef std::map< std::string, itemAttribute >	itemAttributesMap
typedef struct MClientLib::MUSTER	MUSTER
typedef struct MClientLib::MUSTERCLIENT	MUSTERCLIENT

Enumerations
enum	kPlatforms { kPlatformWindows = 0x01, kPlatformLinux = 0x02, kPlatformOSX = 0x04 }
enum	kNetworkCommands {   kD2HStartProcess = 1, kD2HKillProcess, kD2HKillProcessAndRestart, kD2HKillProcessAndPause,   kD2HPauseNode, kD2HResumeNode, kD2HForceUpdate, kD2HSetProcessPriority,   kD2HAckAndGoIdle, kD2HPulseHeartbeat, kD2HSoftRestartNode, kD2HEnableNodeLog,   kD2HDisableNodeLog, kD2HSysEvent, kH2DReportProcResult_WarningOnLog = 200, kH2DReportProcResult_Success,   kH2DReportProcResult_ErrorOnLog, kH2DReportProcResult_WarningOnExitcode, kH2DReportProcResult_ErrorOnExitcode, kH2DReportProcResult_ProcessSpawnFailure,   kH2DReportProcResult_FailureOnPrechunkAction, kH2DReportProcResult_FailureOnPostchunkAction, kH2DStatus, kH2DIdle,   kH2DPaused, kH2DProcessStatus, kH2DPulseHeartbeat, kH2DClientID,   kH2DLockedByLoggedUser, kH2DLockedByProcess, kH2DLockedByTimerule, kH2DLogChunk,   kD2NNotifyJob = 600, kD2NNotifyJobWithWarnings, kD2NNotifyJobWithWarningsInProgress, kD2NNotifyAlert,   kD2NNotifyInfo, kD2NNotifyService, kD2NNotifyError, kD2NNotifyLogin,   kC2DRequestStatisticsBoundaries = 800, kC2DStartStatisticsRequest, kC2DRequestNextStatisticsEntry, kC2DStartHistoryRequest,   kC2DRequestNextHistoryEntry, kC2DStartChunksHistoryRequest, kC2DRequestNextChunksHistoryEntry, kC2DHistoryClearBounds,   kC2DStatisticsClearBounds, kC2DDragJobToNewParent, kC2DLogin, kC2DSetNetMask,   kC2DSendRegistration, kC2DQueryEngineStatus, kC2DSwapEngineStatus, kC2DStartLogsRequest,   kC2DRequestNextLogsEntry, kC2DClearInternalLog, kC2DStartPathsRequest, kC2DRequestNextPathsEntry,   kC2DStartUsersRequest, kC2DRequestNextUsersEntry, kC2DStartPoolsRequest, kC2DRequestNextPoolsEntry,   kC2DStartJobsRequest, kC2DRequestNextJobsEntry, kC2DStartNodesRequest, kC2DRequestNextNodesEntry,   kC2DStartChunksRequest, kC2DRequestNextChunksEntry, kC2DModifyJob, kC2DRenameJob,   kC2DChangeJobPriority, kC2DChangeJobDepartment, kC2DChangeJobProject, kC2DChangeJobTemplate,   kC2DSubmitJob, kC2DDeleteJob, kC2DChangeJobPool, kC2DChangeJobExcludedPool,   kC2DChangeJobOwner, kC2DPauseJob, kC2DResumeJob, kC2DReinitJob,   kC2DChangeJobDependancies, kC2DChangeJobDependanciesMode, kC2DChangeJobStartOn, kC2DChangeJobResumeOn,   kC2DChangeJobPauseOn, kC2DUnlockJob, kC2DLockJob, kC2DArchiveJob,   kC2DUnarchiveJob, kC2DImportQueue, kC2DExportQueue, kC2DPauseNode,   kC2DResumeNode, kC2DKillNode, kC2DKillAndPauseNode, kC2DKillNodeAndRedoJob,   kC2DChangeNodeProcessPriority, kC2DPurgeTemplatesExclusion, kC2DPurgeJobsExclusion, kC2DSoftRestartNode,   kC2DSoftRestartDispatcher, kC2DKillAndPauseNodesWorkingOnJob, kC2DKillAndRedoNodesWorkingOnJob, kC2DKillAndGoOnNodesWorkingOnJob,   kC2DPrepareBuffersForBigOP, kC2DRestoreBuffersAfterBigOP, kC2DChangePassword, kC2DForceStatisticsUpdate,   kC2DResetStatisticsCounters, kC2DChangeNodeMemo, kC2DRemoveNodeRegistration, kC2DStartNetworkScan,   kC2DRegisterNode, kC2DReparentJob, kC2DSendSystemEventToNode, kC2DSetChunkOnHold,   kC2DSetChunkAsCompleted, kC2DRequestPreferences, kC2DSetPreferences, kC2DEnableNodeLog,   kC2DDisableNodeLog, kC2DRequestActivityLogsList, kC2DRequestActivityLog, kC2DRemoveActivityLog,   kC2DRequestActionsLogsList, kC2DRequestActionsLog, kC2DRemoveActionsLog, kC2DStartMailsRequest,   kC2DUpdateNodeWakeupStatus, kC2DAddFolder, kC2DChangeJobMemo, kC2DChangeJobMaximumInstances,   kC2DForceNodeRefresh, kC2DRequestMailsEntry, kC2DSetMinimumLogicalUnits, kC2DSetMinimumCores,   kC2DSetMinimumPhysicalUnits, kC2DSetMinimumCoresSpeed, kC2DSetMinimumRamAmount, kC2DSetMinimumDiskSpaceAmount,   kC2DSetProcessValidExitCodes, kC2DSetProcessWarningExitCodes, kC2DSetProcessErrorExitCodes, kC2DSetProcessValidLogTexts,   kC2DSetProcessWarninigLogTexts, kC2DSetProcessErrorLogTexts, kC2DStartUsersGroupsRequest, kC2DRequestNextUsersGroupsEntry,   kC2DUpdateLDAPUsers, kC2DRequestLDAPSettings, kC2DConfigureLDAP, kD2CLDAPUsersUpdateError,   kC2DStartJobsUpdateRequest, kC2DRequestNextJobsUpdateEntry, kC2DAddUser, kC2DGetUser,   kC2DConfigureUser, kC2DRemoveUser, kC2DAddGroup, kC2DGetGroup,   kC2DConfigureGroup, kC2DRemoveGroup, kC2DGetJob, kC2DGetNode,   kC2DGetChunk, kC2DSetEnvironment, kC2DChangeExitCodesCheck, kC2DChangeLogsCheck,   kC2DChangeMissingFramesCheck, kC2DChangeFramesPrefixPath, kD2CStatisticsBoundaries = 1000, kD2CStatisticsEntry,   kD2CStatisticsStreamingStarting, kD2CStatisticsStreamingCompleted, kD2CHistoryEntry, kD2CHistoryStreamingStarting,   kD2CHistoryStreamingCompleted, kD2CChunksHistoryEntry, kD2CChunksHistoryStreamingStarting, kD2CChunksHistoryStreamingCompleted,   kD2CStatisticsBoundsCleared, kD2CHistoryBoundsCleared, kD2CPasswordChangeSuccess, kD2CConfigChangeSuccess,   kD2CImportQueueResponse, kD2CExportQueueResponse, kD2CExportQueueError, kD2CImportQueueError,   kD2CExportImportBuffersReady, kD2CStatisticsLiveSnapshot, kD2CMailsStreamingStarting, kD2CMailsEntry,   kD2CMailsStreamingCompleted, kD2CJobsStreamingEntry, kD2CJobsStreamingCompleted, kD2CJobsStreamingStarting,   kD2CJobLiveUpdate, kD2CJobLiveAdd, kD2CJobLiveRemove, kD2CForceJobsUpdate,   kD2CNodesStreamingEntry, kD2CNodesStreamingCompleted, kD2CNodesStreamingStarting, kD2CNodeLiveUpdate,   kD2CNodeLiveAdd, kD2CNodeLiveRemove, kD2CChunksStreamingEntry, kD2CChunksStreamingCompleted,   kD2CChunksStreamingStarting, kD2CChunkLiveUpdate, kD2CChunksInvalidated, kD2CPreferencesContent,   kD2CPoolsStreamingStarting, kD2CPoolsStreamingEntry, kD2CPoolsStreamingCompleted, kD2CPoolsContentChanged,   kD2CUsersStreamingStarting, kD2CUsersStreamingEntry, kD2CUsersStreamingCompleted, kD2CPathsStreamingStarting,   kD2CPathsStreamingEntry, kD2CPathsStreamingCompleted, kD2CPathsContentChanged, kD2CLogsStreamingStarting,   kD2CLogsStreamingEntry, kD2CLogsStreamingCompleted, kD2CInternalLogCleared, kD2CLiveLogAdd,   kD2CLoginResponse, kD2CUnauthorizedOperationAttempt, kD2CInvalidOperationAttempt, kD2COperationSuccessfully,   kD2CRegistrationSuccessfully, kD2CRegistrationInvalid, kD2CRegistrationTemporary, kD2CRegistrationExpired,   kD2CEngineStatus, kD2CLiveLogChunk, kD2CInvalidLogEntryRequested, kD2CUsersGroupsStreamingStarting,   kD2CUsersGroupsStreamingEntry, kD2CUsersGroupsStreamingCompleted, kD2CUsersGroupsStreamingRequest, kD2CLDAPUsersUpdateComplete,   kD2CLDAPUsersUpdateInProgress, kD2CLDAPSettings, kD2CLDAPConfigureComplete, kD2CJobsUpdateStreamingEntry,   kD2CJobsUpdateStreamingCompleted, kD2CJobsUpdateStreamingStarting, kD2CGetJobResponse, kD2CGetNodeResponse,   kD2CGetChunkResponse, kC2HConfigure = 1200, kC2HRequestStatus, kC2HPauseNode,   kC2HResumeNode, kC2HKillAndPauseNode, kC2HKillAndGoOnNode, kC2HKillAndRedoNode,   kC2HChangeNodePriority, kC2HRequestInstances, kC2HRequestLogs, kC2HRequestLogEntry,   kC2HRemoveLog, kC2HRequestActivityLogs, kC2HRequestActivityLogEntry, kC2HRemoveActivityLog,   kC2HAuthenticate, kH2CStatusContent = 1400, kH2CConfigurationContent, kH2CRequestInstancesResponse,   kH2CInvalidLogRequest, kH2CUnauthorizedOperationAttempt, kE2DRequestTemplates = 1600, kE2DRequestNextTemplatesStreamingEntry,   kE2DRequestTemplatesHashesMap, kE2DRequestTemplate, kD2ETemplatesStreamingStarting = 1800, kD2ETemplatesStreamingCompleted,   kD2ETemplatesStreamingEntry, kD2ETemplateContent, kD2ETemplatesHashesMap, kD2ETemplatesReconfigurationCompleted,   kD2ETemplatesContentChanged, kCustomMessage = 10000 }
enum	kLoginResponse {   kLoginAdmin = 0x00, kLoginUser, kLoginGuest, kLoginDenied,   kLoginDeniedLDAPDown }
enum	kNetworkMasks { kNetworkMaskJobs = 0x01, kNetworkMaskHosts = 0x02, kNetworkMaskLogs = 0x04, kNetworkMaskArchiviedJobs = 0x08 }

Functions
MCLIENTLIB_API MUSTERERR	InitializeLibrary (const char *module)
MCLIENTLIB_API void	ShutdownLibrary ()
MCLIENTLIB_API std::string	GetLibraryPath ()
MCLIENTLIB_API int	GetPlatform ()
MCLIENTLIB_API void	LoadTemplates (const char *templatesPath)
MCLIENTLIB_API MUSTERCLIENT *	InitializeClientSession (void)
MCLIENTLIB_API void	ShutdownClientSession (MUSTERCLIENT *m)
MCLIENTLIB_API void	SetClientSessionAsync (MUSTERCLIENT *m, bool state)
MCLIENTLIB_API MUSTERERR	Connect (MUSTERCLIENT *m, const char *clientAddress, int clientPort, long maxSocketReadBytes=65000000, long maxSocketWriteBytes=65000000)
MCLIENTLIB_API MUSTERERR	Disconnect (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	MNetTask (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	MNetSendMessage (MUSTERCLIENT *m, int message, int actionId, const char *parameters=0, bool waitForCompletion=true)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessage (MUSTERCLIENT *m, int message, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessages (MUSTERCLIENT *m, int messages[], int messagesCount, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForActionCompletation (MUSTERCLIENT *m, int actionId)
MCLIENTLIB_API MUSTERERR	MNetGetNextMessage (MUSTERCLIENT *m)
MCLIENTLIB_API int	MNetGetCurrentMessage (MUSTERCLIENT *m)
MCLIENTLIB_API int	MNetGetCurrentMessageActionId (MUSTERCLIENT *m)
MCLIENTLIB_API std::vector < std::string >	MNetGetCurrentMessageParameters (MUSTERCLIENT *m)
MCLIENTLIB_API char *	MNetGetCurrentMessageData (MUSTERCLIENT *m)
MCLIENTLIB_API MUSTERERR	Authenticate (MUSTERCLIENT *m, const char *password)
MCLIENTLIB_API MUSTERERR	GetNodeConfiguration (MUSTERCLIENT *m, MNodeConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	SendNodeConfiguration (MUSTERCLIENT *m, MNodeConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	GetActivityLogs (MUSTERCLIENT *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetActivityLogContent (MUSTERCLIENT *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	RemoveActivityLog (MUSTERCLIENT *m, const char *filename)
MCLIENTLIB_API MUSTERERR	GetProcessesLogs (MUSTERCLIENT *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetProcessesLogContent (MUSTERCLIENT *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	RemoveProcessesLog (MUSTERCLIENT *m, const char *filename)
MCLIENTLIB_API MUSTER *	InitializeSession (void)
MCLIENTLIB_API void	ShutdownSession (MUSTER *m)
MCLIENTLIB_API void	SetSessionAsync (MUSTER *m, bool state)
MCLIENTLIB_API MUSTERERR	Connect (MUSTER *m, const char *dispatcherAddress, int dispatcherPort, long maxSocketReadBytes=65000000, long maxSocketWriteBytes=65000000)
MCLIENTLIB_API MUSTERERR	Disconnect (MUSTER *m)
MCLIENTLIB_API MUSTERERR	MNetTask (MUSTER *m)
MCLIENTLIB_API MUSTERERR	MNetSendMessage (MUSTER *m, int message, int actionId, const char *parameters=0, bool waitForCompletion=true)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessage (MUSTER *m, int message, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForMessages (MUSTER *m, int messages[], int messagesCount, int actionId=0)
MCLIENTLIB_API MUSTERERR	MNetWaitForActionCompletation (MUSTER *m, int actionId)
MCLIENTLIB_API MUSTERERR	MNetGetNextMessage (MUSTER *m)
MCLIENTLIB_API int	MNetGetCurrentMessage (MUSTER *m)
MCLIENTLIB_API int	MNetGetCurrentMessageActionId (MUSTER *m)
MCLIENTLIB_API std::vector < std::string >	MNetGetCurrentMessageParameters (MUSTER *m)
MCLIENTLIB_API char *	MNetGetCurrentMessageData (MUSTER *m)
MCLIENTLIB_API MServerStatus	GetServerStatus (MUSTER *m)
MCLIENTLIB_API MUSTERAUTH	GetAuthenticationStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	GetJobs (MUSTER *m, int filterMask, std::vector< MJob > &jobs, bool queryArchivied)
MCLIENTLIB_API MUSTERERR	GetNodes (MUSTER *m, int filterMask, std::vector< MNode > &nodes)
MCLIENTLIB_API MUSTERERR	GetLogs (MUSTER *m, int filterMask, std::vector< MLog > &logs)
MCLIENTLIB_API MUSTERERR	GetChunks (MUSTER *m, long jobId, int filterMask, std::vector< MChunk > &chunks)
MCLIENTLIB_API MUSTERERR	GetJob (MUSTER *m, MJob &job, long jobId)
MCLIENTLIB_API MUSTERERR	GetNode (MUSTER *m, MNode &node, long nodeId)
MCLIENTLIB_API MUSTERERR	GetChunk (MUSTER *m, MChunk &chunk, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	Authenticate (MUSTER *m, const char *username, const char *password, bool skipDirectoryServer=false)
MCLIENTLIB_API MUSTERERR	AcquireServerStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	SynchronizeTemplates (MUSTER *m)
MCLIENTLIB_API MUSTERERR	GetDispatcherConfiguration (MUSTER *m, MDispatcherConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	SendDispatcherConfiguration (MUSTER *m, MDispatcherConfiguration &configurationObject)
MCLIENTLIB_API MUSTERERR	GetDispatcherLDAPConfiguration (MUSTER *m, MDispatcherConfigurationLDAP &configurationObject)
MCLIENTLIB_API MUSTERERR	SendDispatcherLDAPConfiguration (MUSTER *m, MDispatcherConfigurationLDAP &configurationObject)
MCLIENTLIB_API MUSTERERR	GetPools (MUSTER *m, MPools &pools)
MCLIENTLIB_API MUSTERERR	SetPools (MUSTER *m, MPools &pools)
MCLIENTLIB_API MUSTERERR	GetAccounts (MUSTER *m, std::vector< MUser > &users, std::vector< MGroup > &groups)
MCLIENTLIB_API MUSTERERR	SendAccounts (MUSTER *m, std::vector< MUser > &users, std::vector< MGroup > &groups)
MCLIENTLIB_API MUSTERERR	AddUser (MUSTER *m, MUser &user)
MCLIENTLIB_API MUSTERERR	GetUser (MUSTER *m, const char *userName, MUser &user)
MCLIENTLIB_API MUSTERERR	ConfigureUser (MUSTER *m, MUser &user)
MCLIENTLIB_API MUSTERERR	RemoveUser (MUSTER *m, const char *userName)
MCLIENTLIB_API MUSTERERR	AddGroup (MUSTER *m, MGroup &group)
MCLIENTLIB_API MUSTERERR	GetGroup (MUSTER *m, const char *groupName, MGroup &group)
MCLIENTLIB_API MUSTERERR	ConfigureGroup (MUSTER *m, MGroup &group)
MCLIENTLIB_API MUSTERERR	RemoveGroup (MUSTER *m, const char *groupName)
MCLIENTLIB_API MUSTERERR	GetMails (MUSTER *m, std::vector< MMailList > &mails)
MCLIENTLIB_API MUSTERERR	SetMails (MUSTER *m, std::vector< MMailList > &mails)
MCLIENTLIB_API MUSTERERR	GetRepositories (MUSTER *m, std::vector< MRepository > &repositories)
MCLIENTLIB_API MUSTERERR	SetRepositories (MUSTER *m, std::vector< MRepository > &repositories)
MCLIENTLIB_API MUSTERERR	GetActivityLogs (MUSTER *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetActivityLogContent (MUSTER *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	RemoveActivityLog (MUSTER *m, const char *filename)
MCLIENTLIB_API MUSTERERR	GetActionLogs (MUSTER *m, std::vector< std::string > &logs)
MCLIENTLIB_API MUSTERERR	GetActionLogContent (MUSTER *m, const char *filename, MStringRef &out)
MCLIENTLIB_API MUSTERERR	RemoveActionLog (MUSTER *m, const char *filename)
MCLIENTLIB_API MUSTERERR	GetHistoryBounds (MUSTER *m, MSamplesBoundaries &boundaries)
MCLIENTLIB_API MUSTERERR	GetStatisticsHistory (MUSTER *m, long startingTime, long endingTime, std::vector< MStatisticsSample > &samples)
MCLIENTLIB_API MUSTERERR	ClearStatisticsHistory (MUSTER *m, long startingTime, long endingTime)
MCLIENTLIB_API MUSTERERR	GetJobsHistory (MUSTER *m, long startingTime, long endingTime, const char *filterField, const char *filter, std::vector< MHistoryChunk > &samples)
MCLIENTLIB_API MUSTERERR	ClearJobsHistory (MUSTER *m, long startingTime, long endingTime)
MCLIENTLIB_API MUSTERERR	GetJobHistory (MUSTER *m, long jobId, std::vector< MHistoryChunk > &samples)
MCLIENTLIB_API MUSTERERR	GetStatistics (MUSTER *m, MDispatcherStatistics &statistics)
MCLIENTLIB_API MUSTERERR	ActionForceLDAPUpdate (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionImportQueue (MUSTER *m, MStringRef &in)
MCLIENTLIB_API MUSTERERR	ActionExportQueue (MUSTER *m, MStringRef &out)
MCLIENTLIB_API MUSTERERR	ActionSoftRestart (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionResetCounters (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionChangeStatus (MUSTER *m)
MCLIENTLIB_API MUSTERERR	ActionChangePassword (MUSTER *m, const char *oldPassword, const char *newPassword)
MCLIENTLIB_API MUSTERERR	ActionSendJob (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	ActionEditJob (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	ActionCreateFolder (MUSTER *m, MJob &job)
MCLIENTLIB_API MUSTERERR	NodeActionSoftRestart (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionPause (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionResume (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndGo (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndRedo (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndPause (MUSTER *m, long nodeId)
MCLIENTLIB_API MUSTERERR	NodeActionChangeNotes (MUSTER *m, long nodeId, const char *notes)
MCLIENTLIB_API MUSTERERR	NodeActionSoftRestart (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionResume (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndGo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndRedo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionKillAndPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	NodeActionChangeNotes (MUSTER *m, std::vector< long > id, const char *notes)
MCLIENTLIB_API MUSTERERR	JobActionKillAndPause (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionKillAndRedo (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionKillAndGoOn (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionUnlock (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionLock (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionArchive (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionUnarchive (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionPause (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionResume (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionReinit (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionRename (MUSTER *m, long jobId, const char *name)
MCLIENTLIB_API MUSTERERR	JobActionSetProject (MUSTER *m, long jobId, const char *groupName)
MCLIENTLIB_API MUSTERERR	JobActionSetDepartment (MUSTER *m, long jobId, const char *departmentName)
MCLIENTLIB_API MUSTERERR	JobActionSetOwner (MUSTER *m, long jobId, const char *ownerName)
MCLIENTLIB_API MUSTERERR	JobActionSetPriority (MUSTER *m, long jobId, int priority)
MCLIENTLIB_API MUSTERERR	JobActionSetPools (MUSTER *m, long jobId, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetExcludedPools (MUSTER *m, long jobId, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetMaximumNodes (MUSTER *m, long jobId, int maximumNodes)
MCLIENTLIB_API MUSTERERR	JobActionSetParent (MUSTER *m, long jobId, long parentId)
MCLIENTLIB_API MUSTERERR	JobActionSetTemplate (MUSTER *m, long jobId, int templateId)
MCLIENTLIB_API MUSTERERR	JobActionSetDepends (MUSTER *m, long jobId, const char *depends)
MCLIENTLIB_API MUSTERERR	JobActionSetDependMode (MUSTER *m, long jobId, int dependMode)
MCLIENTLIB_API MUSTERERR	JobActionSetStartsOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetResumeOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetPauseOn (MUSTER *m, long jobId, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetNotes (MUSTER *m, long jobId, const char *notes)
MCLIENTLIB_API MUSTERERR	JobActionDelete (MUSTER *m, long jobId)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumLogicalUnits (MUSTER *m, long jobId, bool enable, int minimumLogicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCores (MUSTER *m, long jobId, bool enable, int minimumCores)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalUnits (MUSTER *m, long jobId, bool enable, int minimumPhysicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCoresSpeed (MUSTER *m, long jobId, bool enable, double minimumCoreSpeed)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumRamAmount (MUSTER *m, long jobId, bool enable, double minimumRamAmount)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumDiskSpaceAmount (MUSTER *m, long jobId, bool enable, double minimumDiskSpace)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidExitCodes (MUSTER *m, long jobId, bool enable, const char *validExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningExitCodes (MUSTER *m, long jobId, bool enable, const char *warningExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorExitCodes (MUSTER *m, long jobId, bool enable, const char *errorExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidLogTexts (MUSTER *m, long jobId, bool enable, const char *validLogTexts)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningLogTexts (MUSTER *m, long jobId, bool enable, const char *warningLogTexts)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorLogTexts (MUSTER *m, long jobId, bool enable, const char *errorLogTexts)
MCLIENTLIB_API MUSTERERR	JobActionKillAndPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionKillAndRedo (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionKillAndGoOn (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionUnlock (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionLock (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionArchive (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionUnarchive (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionPause (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionResume (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionReinit (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionSetProject (MUSTER *m, std::vector< long > id, const char *groupName)
MCLIENTLIB_API MUSTERERR	JobActionSetDepartment (MUSTER *m, std::vector< long > id, const char *departmentName)
MCLIENTLIB_API MUSTERERR	JobActionSetOwner (MUSTER *m, std::vector< long > id, const char *ownerName)
MCLIENTLIB_API MUSTERERR	JobActionSetPriority (MUSTER *m, std::vector< long > id, int priority)
MCLIENTLIB_API MUSTERERR	JobActionSetPools (MUSTER *m, std::vector< long > id, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetExcludedPools (MUSTER *m, std::vector< long > id, const char *pools)
MCLIENTLIB_API MUSTERERR	JobActionSetMaximumNodes (MUSTER *m, std::vector< long > id, int maximumNodes)
MCLIENTLIB_API MUSTERERR	JobActionSetParent (MUSTER *m, std::vector< long > id, long parentId)
MCLIENTLIB_API MUSTERERR	JobActionSetTemplate (MUSTER *m, std::vector< long > id, int templateId)
MCLIENTLIB_API MUSTERERR	JobActionSetDepends (MUSTER *m, std::vector< long > id, const char *depends)
MCLIENTLIB_API MUSTERERR	JobActionSetDependMode (MUSTER *m, std::vector< long > id, int dependMode)
MCLIENTLIB_API MUSTERERR	JobActionSetStartsOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetResumeOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetPauseOn (MUSTER *m, std::vector< long > id, long long int time)
MCLIENTLIB_API MUSTERERR	JobActionSetNotes (MUSTER *m, std::vector< long > id, const char *notes)
MCLIENTLIB_API MUSTERERR	JobActionDelete (MUSTER *m, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumLogicalUnits (MUSTER *m, std::vector< long > id, bool enable, int minimumLogicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCores (MUSTER *m, std::vector< long > id, bool enable, int minimumCores)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumPhysicalUnits (MUSTER *m, std::vector< long > id, bool enable, int minimumPhysicalUnits)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumCoresSpeed (MUSTER *m, std::vector< long > id, bool enable, double minimumCoreSpeed)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumRamAmount (MUSTER *m, std::vector< long > id, bool enable, double minimumRamAmount)
MCLIENTLIB_API MUSTERERR	JobActionSetMinimumDiskSpaceAmount (MUSTER *m, std::vector< long > id, bool enable, double minimumDiskSpace)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *validExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *warningExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorExitCodes (MUSTER *m, std::vector< long > id, bool enable, const char *errorExitCodes)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessValidLogTexts (MUSTER *m, std::vector< long > id, bool enable, const char *validLogTexts)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessWarningLogTexts (MUSTER *m, std::vector< long > id, bool enable, const char *warningLogTexts)
MCLIENTLIB_API MUSTERERR	JobActionSetProcessErrorLogTexts (MUSTER *m, std::vector< long > id, bool enable, const char *errorLogTexts)
MCLIENTLIB_API MUSTERERR	ChunkActionSetOnHold (MUSTER *m, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	ChunkActionSetCompleted (MUSTER *m, long jobId, long chunkId)
MCLIENTLIB_API MUSTERERR	ChunkActionSetOnHold (MUSTER *m, long jobId, std::vector< long > id)
MCLIENTLIB_API MUSTERERR	ChunkActionSetCompleted (MUSTER *m, long jobId, std::vector< long > id)
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)

Typedef Documentation

typedef struct MClientLib::itemAttribute MClientLib::itemAttribute

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

Holds data related to an item inside the MPropertiesMap

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

typedef struct MClientLib::MUSTER MClientLib::MUSTER

Client lib MUSTER session structure

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

typedef struct MClientLib::MUSTERAUTH MClientLib::MUSTERAUTH

typedef struct MClientLib::MUSTERCLIENT MClientLib::MUSTERCLIENT

Client lib MUSTERCLIENT session structure

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

typedef std::vector<MProcessSnapshot*> MClientLib::processesSnapshot

Enumeration Type Documentation

enum MClientLib::kLoginResponse

Login response status

Enumerates the Dispatcher login response status

Enumerator
kLoginAdmin	Login accepted, user is an Administrator
kLoginUser	Login accepted, user is a regular user
kLoginGuest	Login accepted, user is a guest
kLoginDenied	Login denied
kLoginDeniedLDAPDown	Login denied because the LDAP server is down

enum MClientLib::kNetworkCommands

Network commands

Enumerates the low level Muster network commands

Enumerator
kD2HStartProcess	Starts a task on the node
kD2HKillProcess	Kills the current running process
kD2HKillProcessAndRestart	Kills the current running process and restarts the same job
kD2HKillProcessAndPause	Kills the current running process and pause the node
kD2HPauseNode	Pause an idle node or schedule a paused status as soon as the job ends
kD2HResumeNode	Resumes a paused node
kD2HForceUpdate	Forces a node status update
kD2HSetProcessPriority	Sets the current job process priority
kD2HAckAndGoIdle	Acks the current job completion status and send the nodes to an idle status
kD2HPulseHeartbeat	Sends an heartbeat to the node
kD2HSoftRestartNode	Soft restart the node
kD2HEnableNodeLog	Enables the real time log
kD2HDisableNodeLog	Disables the real time log
kD2HSysEvent	Send a system event to the node
kH2DReportProcResult_WarningOnLog	Render completed, warning reported on log
kH2DReportProcResult_Success	Render completed, no errors or warnings
kH2DReportProcResult_ErrorOnLog	Render completed, error reported on log
kH2DReportProcResult_WarningOnExitcode	Render completed, warning reported on exit code
kH2DReportProcResult_ErrorOnExitcode	Render completed, error reported on exit code
kH2DReportProcResult_ProcessSpawnFailure	Render failed, cannot spawn process
kH2DReportProcResult_FailureOnPrechunkAction	Render failed, failure on prechunk action
kH2DReportProcResult_FailureOnPostchunkAction	Render failed, failure on postchunk action
kH2DStatus	Node status
kH2DIdle	Node is idle
kH2DPaused	Node is paused
kH2DProcessStatus	Node process status
kH2DPulseHeartbeat	Sends an heart beat
kH2DClientID	Reports client ID
kH2DLockedByLoggedUser	Client locked by logged user
kH2DLockedByProcess	Client locked by processes check
kH2DLockedByTimerule	Client locked by time rule
kH2DLogChunk	Client real time log chunk
kD2NNotifyJob	Notify about a job completion
kD2NNotifyJobWithWarnings	Notify about a job completion with warnings
kD2NNotifyJobWithWarningsInProgress	Notify about a job warning during processing
kD2NNotifyAlert	Notify about an alert
kD2NNotifyInfo	Notify about an info
kD2NNotifyService	Notify about service event
kD2NNotifyError	Notify about an error
kD2NNotifyLogin	Login informations
kC2DRequestStatisticsBoundaries	Gets boundaries of statistics data
kC2DStartStatisticsRequest	Starts a new statistics collection request
kC2DRequestNextStatisticsEntry	Requests a new statistics entry
kC2DStartHistoryRequest	Starts an history collection request
kC2DRequestNextHistoryEntry	Requests a new history entry
kC2DStartChunksHistoryRequest	Starts a chunks history collection request
kC2DRequestNextChunksHistoryEntry	Requests a new chunks history entry
kC2DHistoryClearBounds	Clears the history
kC2DStatisticsClearBounds	Clears the statistics
kC2DDragJobToNewParent	Reparents a job with a drag operation
kC2DLogin	Login
kC2DSetNetMask	Sends the active network messages mask
kC2DSendRegistration	Sends a new licensing registration
kC2DQueryEngineStatus	Queries the engine status
kC2DSwapEngineStatus	Swaps the current engine status
kC2DStartLogsRequest	Starts a new log collection request
kC2DRequestNextLogsEntry	Requests the next log collection entry
kC2DClearInternalLog	Clears the internal Dispatcher log
kC2DStartPathsRequest	Starts the repositories paths query
kC2DRequestNextPathsEntry	Requests the next repositories paths entry
kC2DStartUsersRequest	Starts the users query
kC2DRequestNextUsersEntry	Requests the next user entry
kC2DStartPoolsRequest	Starts the pools query
kC2DRequestNextPoolsEntry	Requests the next pool entry
kC2DStartJobsRequest	Starts the jobs query
kC2DRequestNextJobsEntry	Requests the next job entry
kC2DStartNodesRequest	Starts the node query
kC2DRequestNextNodesEntry	Requests the next node entry
kC2DStartChunksRequest	Starts a chunk query
kC2DRequestNextChunksEntry	Requests the next chunk entry
kC2DModifyJob	Modify an existing job
kC2DRenameJob	Rename a job
kC2DChangeJobPriority	Change a job priority
kC2DChangeJobDepartment	Change a job department
kC2DChangeJobProject	Change a job project
kC2DChangeJobTemplate	Change a job template
kC2DSubmitJob	Submit a new job
kC2DDeleteJob	Deletes an existing job
kC2DChangeJobPool	Change a job included pools
kC2DChangeJobExcludedPool	Change a job excluded pools
kC2DChangeJobOwner	Change a job owner
kC2DPauseJob	Pauses a job
kC2DResumeJob	Resumes a job
kC2DReinitJob	Reinit a job
kC2DChangeJobDependancies	Changes a job dependencies
kC2DChangeJobDependanciesMode	Changes a job dependencies evaluation mode
kC2DChangeJobStartOn	Changes a job starton time
kC2DChangeJobResumeOn	Changes a job resumeon time
kC2DChangeJobPauseOn	Changes a job pauseon time
kC2DUnlockJob	Unlocks a locked job
kC2DLockJob	Locks a job
kC2DArchiveJob	Archivies a job
kC2DUnarchiveJob	Unarchivies a job
kC2DImportQueue	Import a new SQL queue
kC2DExportQueue	Exports the SQL queue
kC2DPauseNode	Pauses a node or schedule a pause command at the next idle status
kC2DResumeNode	Resumes a node
kC2DKillNode	Kills a rendering node
kC2DKillAndPauseNode	Kills and pause a rendering node
kC2DKillNodeAndRedoJob	Kills a node and restarts the job
kC2DChangeNodeProcessPriority	Change a node process priority
kC2DPurgeTemplatesExclusion	Purges a node templates exclusion list
kC2DPurgeJobsExclusion	Purges a node jobs exclusion list
kC2DSoftRestartNode	Issues a soft restart on a node
kC2DSoftRestartDispatcher	Issues a soft restart on the Dispatcher
kC2DKillAndPauseNodesWorkingOnJob	Send a kill and pause to the nodes working on a job
kC2DKillAndRedoNodesWorkingOnJob	Send a kill and redo to the nodes working on a job
kC2DKillAndGoOnNodesWorkingOnJob	Sends a kill and go on to the nodes working on a job
kC2DPrepareBuffersForBigOP	Prepares the network buffers for a big buffer operation
kC2DRestoreBuffersAfterBigOP	Restores the network buffers after a big buffer operation
kC2DChangePassword	Changes the logged user password
kC2DForceStatisticsUpdate	Forces an update of the statistics
kC2DResetStatisticsCounters	Resets the statistics counter
kC2DChangeNodeMemo	Changes a node memo
kC2DRemoveNodeRegistration	Remove an offline node registration
kC2DStartNetworkScan	Starts a node network scan on the Dispatcher
kC2DRegisterNode	Manually register a new node
kC2DReparentJob	Reparent a job
kC2DSendSystemEventToNode	Sends a system event to a node
kC2DSetChunkOnHold	Sets a chunk to on hold status
kC2DSetChunkAsCompleted	Forces a chunk to competed status
kC2DRequestPreferences	Requests the Dispatcher preferences
kC2DSetPreferences	Set the Dispatcher preferences
kC2DEnableNodeLog	Enables a node realtime log
kC2DDisableNodeLog	Disables a node realtime log
kC2DRequestActivityLogsList	Requests the list of the activity logs
kC2DRequestActivityLog	Request an activity log file
kC2DRemoveActivityLog	Remove an activity log file
kC2DRequestActionsLogsList	Requests the list of the actions logs
kC2DRequestActionsLog	Request an action log file
kC2DRemoveActionsLog	Remove an action log file
kC2DStartMailsRequest	Starts collection of mailing lists
kC2DUpdateNodeWakeupStatus	Updates a node wakeup status
kC2DAddFolder	Add a new folder
kC2DChangeJobMemo	Changes the memo of a job
kC2DChangeJobMaximumInstances	Change a job maximum instances
kC2DForceNodeRefresh	Forces a node status refresh
kC2DRequestMailsEntry	Request a new mailing list collection entry
kC2DSetMinimumLogicalUnits	Sets a job minimum logical units
kC2DSetMinimumCores	Sets a job minimum cores
kC2DSetMinimumPhysicalUnits	Sets a job minimum physical units
kC2DSetMinimumCoresSpeed	Sets a job minimum cores speed
kC2DSetMinimumRamAmount	Sets a job minimum RAM amount
kC2DSetMinimumDiskSpaceAmount	Sets a job minimum free space amount
kC2DSetProcessValidExitCodes	Sets a job valid exit codes
kC2DSetProcessWarningExitCodes	Set a job warning exit codes
kC2DSetProcessErrorExitCodes	Set a job error exit codes
kC2DSetProcessValidLogTexts	Sets a job valid log texts
kC2DSetProcessWarninigLogTexts	Sets a job warning log texts
kC2DSetProcessErrorLogTexts	Sets a job error log texts
kC2DStartUsersGroupsRequest	Starts a new user groups collection
kC2DRequestNextUsersGroupsEntry	Request the next user groups entry
kC2DUpdateLDAPUsers	Forces LDAP user update
kC2DRequestLDAPSettings	Requests the LDAP settings
kC2DConfigureLDAP	Configure the LDAP settings
kD2CLDAPUsersUpdateError	Reports an LDAP user update error
kC2DStartJobsUpdateRequest	Starts a job update request
kC2DRequestNextJobsUpdateEntry	Get a new entry for a job update request
kC2DAddUser	Add a new user
kC2DGetUser	Get an existing user
kC2DConfigureUser	Configure an existing user
kC2DRemoveUser	Removes an existing user
kC2DAddGroup	Add a new group
kC2DGetGroup	Get an existing group
kC2DConfigureGroup	Configure en existing group
kC2DRemoveGroup	Removes an existing group
kC2DGetJob	Get an existing job
kC2DGetNode	Get an existing node
kC2DGetChunk	Get an existing chunk
kC2DSetEnvironment	Set a job environment
kC2DChangeExitCodesCheck	Set a job exit code check
kC2DChangeLogsCheck
kC2DChangeMissingFramesCheck	<Set a job logs check
kC2DChangeFramesPrefixPath	<Set a job missing frames check
kD2CStatisticsBoundaries	<Set a job frames prefix path Sends back the statistics boundaries
kD2CStatisticsEntry	Sends back a statistic entry
kD2CStatisticsStreamingStarting	Sends back a statistics collection start event
kD2CStatisticsStreamingCompleted	Sends back a statistics collection end event
kD2CHistoryEntry	Sends back an history entry
kD2CHistoryStreamingStarting	Sends back an history collection start event
kD2CHistoryStreamingCompleted	Sends back an history collection end event
kD2CChunksHistoryEntry	Sends back a chunk history entry
kD2CChunksHistoryStreamingStarting	Sends back a chunk history collection start event
kD2CChunksHistoryStreamingCompleted	Sends back a chunk history collection end event
kD2CStatisticsBoundsCleared	Sends back an ACK for a statistics clear event
kD2CHistoryBoundsCleared	Sends back an ACK for a history clear event
kD2CPasswordChangeSuccess	Sends back an ACK for a password change event
kD2CConfigChangeSuccess	Sends back an ACK for a config change event
kD2CImportQueueResponse	Sends back a queue import reponse
kD2CExportQueueResponse	Sends back a queue export response
kD2CExportQueueError	Sends back a queue export error response
kD2CImportQueueError	Sends back a queue import error response
kD2CExportImportBuffersReady	Notify about export buffers ready for a big operation
kD2CStatisticsLiveSnapshot	Sends a statistics live snapshot
kD2CMailsStreamingStarting	Sends back a mailing list collection start event
kD2CMailsEntry	Sends back a mailing list collect entry
kD2CMailsStreamingCompleted	Sends back a mailing list collection end event
kD2CJobsStreamingEntry	Sends back a jobs streaming entry
kD2CJobsStreamingCompleted	Sends back a jobs streaming end event
kD2CJobsStreamingStarting	Sends back a jobs streaming start event
kD2CJobLiveUpdate	Sends a job live update
kD2CJobLiveAdd	Sends a job live add event
kD2CJobLiveRemove	Sends a job live remove event
kD2CForceJobsUpdate	Forces a queue complete update
kD2CNodesStreamingEntry	Sends back a node streaming entry
kD2CNodesStreamingCompleted	Sends back a node streaming end event
kD2CNodesStreamingStarting	Sends back a node streaming start event
kD2CNodeLiveUpdate	Sends a node live update
kD2CNodeLiveAdd	Sends a node live add event
kD2CNodeLiveRemove	Sends a node live remove event
kD2CChunksStreamingEntry	Sends back a chunk streaming entry
kD2CChunksStreamingCompleted	Sends back a chunk streaming end event
kD2CChunksStreamingStarting	Sends back a chunk streaming start event
kD2CChunkLiveUpdate	Sends a chunk live update
kD2CChunksInvalidated	Sends a chunks complete invalidation event
kD2CPreferencesContent	Sends back the Dispatcher preferences
kD2CPoolsStreamingStarting	Sends back a pools streaming start event
kD2CPoolsStreamingEntry	Sends back a pools streaming entry
kD2CPoolsStreamingCompleted	Sends back a pools streaming end event
kD2CPoolsContentChanged	Notifies about a change into the pool structure
kD2CUsersStreamingStarting	Sends back a user streaming start event
kD2CUsersStreamingEntry	Sends back a user streaming entry
kD2CUsersStreamingCompleted	Sends back a user streaming end event
kD2CPathsStreamingStarting	Sends back a repository streaming start event
kD2CPathsStreamingEntry	Sends back a repository streaming entry
kD2CPathsStreamingCompleted	Sends back a repository streaming end event
kD2CPathsContentChanged	Notifies about a change into the repositories
kD2CLogsStreamingStarting	Sends back a log streaming start event
kD2CLogsStreamingEntry	Sends back a log entry
kD2CLogsStreamingCompleted	Sends back a log streaming end event
kD2CInternalLogCleared	Notifies about a full clear of the internal log
kD2CLiveLogAdd	Sends a log add live event
kD2CLoginResponse	Respond to a login request
kD2CUnauthorizedOperationAttempt	Notifies about an unauthorized operation attempt
kD2CInvalidOperationAttempt	Notifies about an invalid operation attempt
kD2COperationSuccessfully	Notifies about a successfully operation
kD2CRegistrationSuccessfully	Notifies about a successfully license registration
kD2CRegistrationInvalid	Notifies about an invalid registration
kD2CRegistrationTemporary	Notifies about a temporary successfully license registration
kD2CRegistrationExpired	Notifies about an invalid expired registration
kD2CEngineStatus	Sends back the Dispatcher engine status
kD2CLiveLogChunk	Sends a chunk log live event
kD2CInvalidLogEntryRequested	Notifies about an invalid log request
kD2CUsersGroupsStreamingStarting	Sends back a group streaming start event
kD2CUsersGroupsStreamingEntry	Sends back a group streaming entry
kD2CUsersGroupsStreamingCompleted	Sends back a group streaming end event
kD2CUsersGroupsStreamingRequest	Request the user groups streaming
kD2CLDAPUsersUpdateComplete	Notify about a successfully LDAP update
kD2CLDAPUsersUpdateInProgress	Notify about an in progress LDAP update
kD2CLDAPSettings	Sends back the LDAP settings
kD2CLDAPConfigureComplete	Notify about a successfully LDAP configuration
kD2CJobsUpdateStreamingEntry	Sends back a job update streaming entry
kD2CJobsUpdateStreamingCompleted	Sends back a job update streaming end event
kD2CJobsUpdateStreamingStarting	Sends back a job update streaming start event
kD2CGetJobResponse	Sends back a single job entry
kD2CGetNodeResponse	Sends back a single node entry
kD2CGetChunkResponse	Sends back a single chunk entry
kC2HConfigure	Configure an host
kC2HRequestStatus	Request the host status
kC2HPauseNode	Pauses a node
kC2HResumeNode	Resumes a node
kC2HKillAndPauseNode	Kills and pause on a node
kC2HKillAndGoOnNode	Kills and go on a node
kC2HKillAndRedoNode	Kills and redo on a node
kC2HChangeNodePriority	Changes the node priority
kC2HRequestInstances	Requests the instances collection from a node
kC2HRequestLogs	Requests the processes logs list from a node
kC2HRequestLogEntry	Requests a specific processes logs file from a node
kC2HRemoveLog	Removes a processes log from a node
kC2HRequestActivityLogs	Requests the activity logs list from a node
kC2HRequestActivityLogEntry	Requests a specific activity logs file from a node
kC2HRemoveActivityLog	Removes an activity log from a node
kC2HAuthenticate	Authenticate on a node
kH2CStatusContent	Sends back a status content
kH2CConfigurationContent	Sends back the noe configuration
kH2CRequestInstancesResponse	Sends back the instances collection
kH2CInvalidLogRequest	Reports an invalid node request
kH2CUnauthorizedOperationAttempt	Reports an unauthorized operation
kE2DRequestTemplates	Requests a templates streaming operation
kE2DRequestNextTemplatesStreamingEntry	Requests the next template during a templates streaming operation
kE2DRequestTemplatesHashesMap	Requests the templates hashes map
kE2DRequestTemplate	Requests a specific template file
kD2ETemplatesStreamingStarting	Notifies about a templates streaming start event
kD2ETemplatesStreamingCompleted	Notifies about a templates streaming end event
kD2ETemplatesStreamingEntry	Sends back a template streaming entry
kD2ETemplateContent	Sends back a template content
kD2ETemplatesHashesMap	Sends back the templates hashes map
kD2ETemplatesReconfigurationCompleted	Notifies about a templates reconfiguration event
kD2ETemplatesContentChanged	Notifies about a templates content change
kCustomMessage	A custom message usable by the APIs

enum MClientLib::kNetworkMasks

Network data flow mask

Enumerates the Network data flow mask to filter updates

Enumerator
kNetworkMaskJobs	Jobs add and update data
kNetworkMaskHosts	Nodes add and update data
kNetworkMaskLogs	Logs add and update data
kNetworkMaskArchiviedJobs	Archived jobs add and update data

enum MClientLib::kPlatforms

Platforms enumeration

Enumerates the Muster supported platforms

Enumerator
kPlatformWindows	The Windows platform
kPlatformLinux	The Linux platform
kPlatformOSX	The Apple Mac OS X platform

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

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

m	pointer to an existing MUSTER session structure
oldPassword	the old user account password
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

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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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 &	out
	)

Exports a Dispatcher SQL queue dump

Parameters

m	pointer to an existing MUSTER session structure
out	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

m	pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

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

Imports a Dispatcher SQL queue dump

Parameters

m	pointer to an existing MUSTER session structure
in	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

m	pointer to an existing MUSTER session structure

Returns

MUSTERERR error code

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

Sends a new job to the Dispatcher queue

Parameters

m	pointer to an existing MUSTER session structure
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

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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
username	the login name for the authentication
password	password of the user used in the login name

Returns

MUSTERERR error code

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

Forces the status of a chunk to completed

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the job holding the chunk
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the job holding the chunk
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the job holding the chunk
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the job holding the chunk
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

m	pointer to an existing MUSTER session structure
startingTime	the starting time, as a time_c object to remove the samples
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

m	pointer to an existing MUSTER session structure
startingTime	the starting time, as a time_c object to remove the samples
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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
	)

Connect to a node to establish a management session

Parameters

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

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

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

MCLIENTLIB_API MUSTERERR MClientLib::Disconnect

(

MUSTERCLIENT *

m

)

Disconnect an existing client management session

Parameters

m	pointer to an existing MUSTERCLIENT session structure

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::Disconnect

(

MUSTER *

m

)

Disconnect an existing Dispatcher management session

Parameters

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

m	pointer to an existing MUSTER session structure
users	a reference to an MUser vector object to store the users configuration
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

m	pointer to an existing MUSTER session structure
filename	The filename of the log to retrieve
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
filename	the filename of the log to retrieve
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

m	pointer to an existing MUSTER session structure
filename	The filename of the log to retrieve
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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure

Returns

MUSTERAUTH a structure holding the current Dispatcher authentication status

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

Gets a node from the Dispatcher

Parameters

m	pointer to an existing MUSTER session structure
chunk	reference to an MChunk object
jobId	ID of the job to query
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

m	pointer to an existing MUSTER session structure
jobId	ID of the job to query
filterMask	specify a bit mask for the query operation made with the constants from MChunk::kChunksStatus
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

path	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

m	pointer to an existing MUSTER session structure
groupName	the group name of the group to retrieve
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
job	reference to an MJob object
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

m	pointer to an existing MUSTER session structure
jobId	the job ID to query
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	queryArchivied
	)

Gets the jobs list from the Dispatcher

Parameters

m	pointer to an existing MUSTER session structure
filterMask	specify a bit mask for the query operation made with the constants from MJob::kJobsStatus
jobs	reference to an MJob vector
queryArchivied	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

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

Returns

MUSTERERR error code

MCLIENTLIB_API std::string MClientLib::GetLibraryPath

(

)

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

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

Gets the logs list from the Dispatcher

Parameters

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

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::GetMails	(	MUSTER *	m,
		std::vector< MMailList > &	mails
	)

Gets the Dispatcher mailing list configuration

Parameters

m	pointer to an existing MUSTER session structure
mails	a reference to a MMailList vector object to store the configuration

Returns

MUSTERERR error code

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

Gets a node from the Dispatcher

Parameters

m	pointer to an existing MUSTER session structure
node	reference to an MNode object
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

m	pointer to an existing MUSTERCLIENT session structure
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

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

Returns

MUSTERERR error code

MCLIENTLIB_API int MClientLib::GetPlatform

(

)

Gets the active platform returning one of the values in the kPlatforms enumerator

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

Gets the Dispatcher pools configuration

Parameters

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
filename	the filename of the log to retrieve
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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
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

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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
startingTime	the starting time, as a time_c object to collect the samples
endingTime	the ending time, as a time_c object to collect the samples
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

m	pointer to an existing MUSTER session structure
userName	the login name of the user to retrieve
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

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

m	pointer to an existing MUSTER session structure
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

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

Returns

MUSTERERR error code

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

Deletes an existing job

Parameters

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

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

Returns

MUSTERERR error code

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

Renames a job

Parameters

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

Returns

MUSTERERR error code

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

Resumes a job

Parameters

m	pointer to an existing MUSTER session structure
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

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

Returns

MUSTERERR error code

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

Sets a job department

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

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

Sets a job dependencies evaluation mode

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

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

Sets a job excluded pools

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

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

Sets a job maximum rendering nodes

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
minimumLogicalUnits	the number of logical units threshold

Returns

MUSTERERR error code

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

Sets the minimum logical units on multiple jobs

Parameters

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
minimumLogicalUnits	the number of logical 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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

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

Sets a job owner

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

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

Returns

MUSTERERR error code

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

Sets a job error log texts

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
errorLogTexts	a comma separated list of warning log texts

Returns

MUSTERERR error code

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

Sets the error log texts on multiple jobs

Parameters

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
errorLogTexts	a comma separated list of warning log texts

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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

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

Returns

MUSTERERR error code

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

Sets a job valid log texts

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
validLogTexts	a comma separated list of valid log texts

Returns

MUSTERERR error code

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

Sets the valid log texts on multiple jobs

Parameters

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
validLogTexts	a comma separated list of valid log texts

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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
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

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

Returns

MUSTERERR error code

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

Sets a job warning log texts

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
enable	enabled the override check
warningLogTexts	a comma separated list of warning log texts

Returns

MUSTERERR error code

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

Sets the warning log texts on multiple jobs

Parameters

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
enable	enabled the override check
warningLogTexts	a comma separated list of warning log texts

Returns

MUSTERERR error code

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

Sets a job project

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the jobs IDs
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

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

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

Sets a job starting time

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
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

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

Returns

MUSTERERR error code

MCLIENTLIB_API MUSTERERR MClientLib::JobActionSetTemplate	(	MUSTER *	m,
		long	jobId,
		int	templateId
	)

Sets a job template

Parameters

m	pointer to an existing MUSTER session structure
jobId	the ID of the target job
templateId	the ID of the job template

Returns

MUSTERERR error code

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

Sets the template on multiple jobs

Parameters

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

Returns

MUSTERERR error code

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

Unarchives a job

Parameters

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
id	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

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

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

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

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

m	pointer to an existing MUSTER session structure

Returns

int the message

MCLIENTLIB_API char* MClientLib::MNetGetCurrentMessageData

(

MUSTERCLIENT *

m

)

Get the current message parameters as a buffer

Parameters

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

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

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

m	pointer to an existing MUSTER session structure

Returns

int 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

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

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

m	pointer to an existing MUSTERCLIENT session structure
message	the message to send
actionId	an optional ID to identify the message action. If an ID is specified the function will return only after completion
parameters	additional parameters to concatenate to the message
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

m	pointer to an existing MUSTER session structure
message	the message to send
actionId	an optional ID to identify the message action. If an ID is specified the function will return only after completion
parameters	additional parameters to concatenate to the message
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

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

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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
message	message to wait for
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

m	pointer to an existing MUSTER session structure
message	message to wait for
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

m	pointer to an existing MUSTERCLIENT session structure
messages	array of messages to wait for
messagesCount	number of messages in the array
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

m	pointer to an existing MUSTER session structure
messages	array of messages to wait for
messagesCount	number of messages in the array
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

m	pointer to an existing MUSTER session structure
nodeId	the ID of the target node
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

m	pointer to an existing MUSTER session structure
id	a vector of long values holding the IDs of the target nodes
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

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

Returns

MUSTERERR error code

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

Sends a soft restart to a node

Parameters

m	pointer to an existing MUSTER session structure
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

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

Returns

MUSTERERR error code

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

Removes a Dispatcher action log

Parameters

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
users	a reference to an MUser vector object to read the users configuration
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTERCLIENT session structure
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

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

MCLIENTLIB_API MUSTERERR MClientLib::SetMails	(	MUSTER *	m,
		std::vector< MMailList > &	mails
	)

Sends the Dispatcher mailing list configuration

Parameters

m	pointer to an existing MUSTER session structure
mails	a reference to a MMailList vector object to read the configuration

Returns

MUSTERERR error code

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

Sends the Dispatcher pools configuration

Parameters

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

m	pointer to an existing MUSTER session structure
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

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

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

m	pointer to an existing MUSTER session structure

Returns

MUSTERERR error code