The abstract event plugin class, which is subclassed in the event plugin python script file. More...

Public Member Functions
void	AddMetaDataEntry (string key, string value)
	Adds a dictionary entry to the event's metadata. This entry will persist between event triggers. This has no effect if the key already exists. More...

void	ClearProcessEnvironmentVariables ()
	Clears the extra environment variables for the event plugin. More...

void	DeleteMetaDataEntry (string key)
	Deletes an existing dictionary entry from the event's metadata. This has no effect if the key does not exist. More...

string[]	GetAuxiliaryFilenames ()
	Gets the list of auxiliary files that were submitted with the job. More...

bool	GetBooleanConfigEntry (string key)
	Gets a value as a bool from the plugin's configuration for the given key. More...

bool	GetBooleanConfigEntryWithDefault (string key, bool defaultValue)
	Gets a value as a bool from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned. More...

bool	GetBooleanPluginInfoEntry (string key)
	Gets the job's plugin info value as a bool for the given key. More...

bool	GetBooleanPluginInfoEntryWithDefault (string key, bool defaultValue)
	Gets the job's plugin info value as a bool for the given key. If the key doesn't exist, the default value is returned. More...

string	GetConfigEntry (string key)
	Gets a value from the plugin's configuration for the given key. More...

string	GetConfigEntryWithDefault (string key, string defaultValue)
	Gets a value from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned. More...

string	GetDataFilename ()
	Gets the first auxiliary file that was submitted with the job. More...

string	GetEventDirectory ()
	Gets the event's plugin directory in the Repository. More...

float	GetFloatConfigEntry (string key)
	Gets a value as a float from the plugin's configuration for the given key. More...

float	GetFloatConfigEntryWithDefault (string key, float defaultValue)
	Gets a value as a float from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned. More...

float	GetFloatPluginInfoEntry (string key)
	Gets the job's plugin info value as a float for the given key. More...

float	GetFloatPluginInfoEntryWithDefault (string key, float defaultValue)
	Gets the job's plugin info value as a float for the given key. If the key doesn't exist, the default value is returned. More...

int	GetIntegerConfigEntry (string key)
	Gets a value as an integer from the plugin's configuration for the given key. More...

int	GetIntegerConfigEntryWithDefault (string key, int defaultValue)
	Gets a value as an integer from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned. More...

int	GetIntegerPluginInfoEntry (string key)
	Gets the job's plugin info value as an integer for the given key. More...

int	GetIntegerPluginInfoEntryWithDefault (string key, int defaultValue)
	Gets the job's plugin info value as an integer for the given key. If the key doesn't exist, the default value is returned. More...

long	GetLongConfigEntry (string key)
	Gets a value as a long from the plugin's configuration for the given key. More...

long	GetLongConfigEntryWithDefault (string key, long defaultValue)
	Gets a value as a long from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned. More...

long	GetLongPluginInfoEntry (string key)
	Gets the job's plugin info value as a long for the given key. More...

long	GetLongPluginInfoEntryWithDefault (string key, long defaultValue)
	Gets the job's plugin info value as a long for the given key. If the key doesn't exist, the default value is returned. More...

Dictionary< string, string >	GetMetaData ()
	Gets the full metadata dictionary for the event. More...

string	GetMetaDataEntry (string key)
	Gets the value of an existing dictionary entry from the event's metadata. More...

string	GetPluginInfoEntry (string key)
	Gets the job's plugin info value for the given key. More...

string	GetPluginInfoEntryWithDefault (string key, string defaultValue)
	Gets the job's plugin info value for the given key. If the key doesn't exist, the default value is returned. More...

string	GetProcessEnvironmentVariable (string key)
	Gets the extra environment variable for the event plugin with the given key. If the variable is not defined, an empty string is returned. More...

void	LogInfo (string message)
	Logs an INFO message. More...

void	LogMessage (string message)
	Logs a message. More...

void	LogStdout (string message)
	Logs a STDOUT message. More...

void	LogWarning (string message)
	Logs a WARNING message. More...

virtual void	OnHouseCleaning ()
	Calls the on house cleaning callback. More...

virtual void	OnIdleShutdown (string groupName, string[] slaveNames, IdleShutdownOptions idleShutdownOptions)
	Calls the on idle shutdown callback. More...

virtual void	OnJobDeleted (Job job)
	Calls the on job deleted callback. More...

virtual void	OnJobError (Job job, Task task, Report errorReport)
	Calls the on job error callback. More...

virtual void	OnJobFailed (Job job)
	Calls the on job failed callback. More...

virtual void	OnJobFinished (Job job)
	Calls the on job finished callback. More...

virtual bool	OnJobImported (Job job)
	Calls the on job imported callback. More...

virtual void	OnJobPended (Job job)
	Calls the on job pending callback. More...

virtual void	OnJobPurged (Job job)
	Calls the on job purged callback. More...

virtual void	OnJobReleased (Job job)
	Calls the on job released callback. More...

virtual void	OnJobRequeued (Job job)
	Calls the on job requeued callback. More...

virtual void	OnJobResumed (Job job)
	Calls the on job resumed. More...

virtual void	OnJobStarted (Job job)
	Calls the on job started callback. More...

virtual bool	OnJobSubmitted (Job job)
	Calls the on job submitted callback. More...

virtual void	OnJobSuspended (Job job)
	Calls the on job suspended callback. More...

virtual void	OnMachineRestart (string groupName, string[] slaveNames, MachineRestartOptions machineRestartOptions)
	Calls the on machine restart callback. More...

virtual void	OnMachineStartup (string groupName, string[] slaveNames, MachineStartupOptions machineStartupOptions)
	Calls the on machine startup callback. More...

virtual void	OnRepositoryRepair ()
	Calls the on repository repair callback. More...

virtual void	OnSlaveIdle (string slaveName)
	Calls the on Worker idle callback. More...

virtual void	OnSlaveInfoUpdate (string slaveName, SlaveInfo slaveInfo)
	Calls the on Worker info updated callback. More...

virtual void	OnSlaveRendering (string slaveName, Job job)
	calls the on Worker rendering callback. More...

virtual void	OnSlaveStalled (string slaveName)
	Calls the on Worker stalled callback. More...

virtual void	OnSlaveStarted (string slaveName)
	Calls the on Worker started callback. More...

virtual void	OnSlaveStartingJob (string slaveName, Job job)
	Calls the on Worker starting job callback. More...

virtual void	OnSlaveStopped (string slaveName)
	Calls the on Worker stopped callback. More...

virtual void	OnThermalShutdown (string groupName, string[] slaveNames, ThermalShutdownOptions thermalShutdownOptions)
	Calls the on thermal shutdown callback. More...

bool	ProcessEnvironmentVariableExists (string key)
	Checks if the extra environment with the given key exists. More...

void	ResetEventPlugin ()
	Resets the event plugin. More...

int	RunProcess (string executable, string arguments, string startupDirectory, int timeoutMilliseconds)
	Runs a process and waits for it to complete. More...

int	RunProcessAsUser (string executable, string arguments, string startupDirectory, int timeoutMilliseconds, string userName, string domain, string password)
	Runs a process and waits for it to complete. More...

void	SetEventPlugin (DeadlineEventPlugin eventPlugin)
	Sets the event plugin. More...

void	SetProcessEnvironmentVariable (string key, string value)
	Sets extra environment variables for any processes started by this event plugin. The processes must be started using RunProcess(). This will take precedence over a variable in the current environment with the same name. More...

void	UpdateMetaDataEntry (string key, string value)
	Updates an existing dictionary entry to the event's metadata. This entry will persist between event triggers. This has no effect if the key does not exist. More...

Public Attributes
readonly bool	plugin_initialized = true
	This property exists to catch when a python event plugin does not call super().__init__(). As of PythonNET 3.0.0, Python classes that subclass .NET base types (like this one) must explicitly call the super constructor. Not doing so will leave these uninitialized with a default value (`false` in the case of a bool). More...

Properties
bool	UseProcessEnvironmentVariablesOnly `[get, set]`
	If True, only the extra environment variables defined for the event plugin will be used. If False (the default behavior), the extra environment variables will be merged with the current environment. More...

Events
GenericDelegate0	OnHouseCleaningCallback
	If a function is assigned to this callback, it will be called when the House Cleaning operation is performed. More...

GenericDelegate3< string, string[], IdleShutdownOptions >	OnIdleShutdownCallback
	If a function is assigned to this callback, it will be called when Power Management shuts down a Worker machine because it is idle. The string corresponds to the group name and the string array corresponds to the Worker names. More...

GenericDelegate1< Job >	OnJobDeletedCallback
	If a function is assigned to this callback, it will be called when a job is deleted. More...

GenericDelegate3< Job, Task, Report >	OnJobErrorCallback
	If a function is assigned to this callback, it will be called when a job reports an error while rendering. More...

GenericDelegate1< Job >	OnJobFailedCallback
	If a function is assigned to this callback, it will be called when a job fails. More...

GenericDelegate1< Job >	OnJobFailedEvent
	DEPRECATED: Use OnJobFailedCallback. More...

GenericDelegate1< Job >	OnJobFinishedCallback
	If a function is assigned to this callback, it will be called when a job completes. More...

GenericDelegate1< Job >	OnJobFinishedEvent
	DEPRECATED: Use OnJobFinishedCallback. More...

GenericDelegate1< Job >	OnJobImportedCallback
	If a function is assigned to this callback, it will be called when a job is imported. More...

GenericDelegate1< Job >	OnJobPendedCallback
	If a function is assigned to this callback, it will be called when a job enters the pending state. More...

GenericDelegate1< Job >	OnJobPendedEvent
	DEPRECATED: Use OnJobPendedCallback. More...

GenericDelegate1< Job >	OnJobPurgedCallback
	If a function is assigned to this callback, it will be called when a job is purged. More...

GenericDelegate1< Job >	OnJobReleasedCallback
	If a function is assigned to this callback, it will be called when a pending job is released. More...

GenericDelegate1< Job >	OnJobReleasedEvent
	DEPRECATED: Use OnJobReleasedCallback. More...

GenericDelegate1< Job >	OnJobRequeuedCallback
	If a function is assigned to this callback, it will be called when a job is requeued. More...

GenericDelegate1< Job >	OnJobRequeuedEvent
	DEPRECATED: Use OnJobRequeuedCallback. More...

GenericDelegate1< Job >	OnJobResumedCallback
	If a function is assigned to this callback, it will be called when a suspended or failed job is resumed. More...

GenericDelegate1< Job >	OnJobResumedEvent
	DEPRECATED: Use OnJobResumedCallback. More...

GenericDelegate1< Job >	OnJobStartedCallback
	If a function is assigned to this callback, it will be called when a job has started rendering. More...

GenericDelegate1< Job >	OnJobStartedEvent
	DEPRECATED: Use OnJobStartedCallback. More...

GenericDelegate1< Job >	OnJobSubmittedCallback
	If a function is assigned to this callback, it will be called when a job is submitted. More...

GenericDelegate1< Job >	OnJobSubmittedEvent
	DEPRECATED: Use OnJobSubmittedCallback. More...

GenericDelegate1< Job >	OnJobSuspendedCallback
	If a function is assigned to this callback, it will be called when a job is suspended. More...

GenericDelegate1< Job >	OnJobSuspendedEvent
	DEPRECATED: Use OnJobSuspendedCallback. More...

GenericDelegate3< string, string[], MachineRestartOptions >	OnMachineRestartCallback
	If a function is assigned to this callback, it will be called when Power Management restarts a Worker machine. The string corresponds to the group name and the string array corresponds to the Worker names. More...

GenericDelegate3< string, string[], MachineStartupOptions >	OnMachineStartupCallback
	If a function is assigned to this callback, it will be called when Power Management starts up a Worker machine because it is needed for rendering. The string corresponds to the group name and the string array corresponds to the Worker names. More...

GenericDelegate0	OnRepositoryRepairCallback
	If a function is assigned to this callback, it will be called when the Repository Repair operation is performed. More...

GenericDelegate1< string >	OnSlaveIdleCallback
	If a function is assigned to this callback, it will be called when a Worker becomes idle. The string corresponds to the Worker name. More...

GenericDelegate2< string, SlaveInfo >	OnSlaveInfoUpdatedCallback
	If a function is assigned to this callback, it will be called when a Worker updates its information in the database. The string corresponds to the Worker name. The SlaveInfo is the information that is being written to the database. More...

GenericDelegate2< string, Job >	OnSlaveRenderingCallback
	If a function is assigned to this callback, it will be called when a Worker starts rendering a job. The string corresponds to the Worker name. More...

GenericDelegate1< string >	OnSlaveStalledCallback
	If a function is assigned to this callback, it will be called when a Worker is marked as stalled. The string corresponds to the Worker name. More...

GenericDelegate1< string >	OnSlaveStartedCallback
	If a function is assigned to this callback, it will be called when a Worker is started. The string corresponds to the Worker name. More...

GenericDelegate2< string, Job >	OnSlaveStartingJobCallback
	If a function is assigned to this callback, it will be called when a Worker starts loading a job. The string corresponds to the Worker name. More...

GenericDelegate1< string >	OnSlaveStoppedCallback
	If a function is assigned to this callback, it will be called when a sWorkerlave is stopped. The string corresponds to the Worker name. More...

GenericDelegate3< string, string[], ThermalShutdownOptions >	OnThermalShutdownCallback
	If a function is assigned to this callback, it will be called when Power Management shuts down a Worker machine due to temperature. The string corresponds to the group name and the string array corresponds to the Worker names. More...

Detailed Description

The abstract event plugin class, which is subclassed in the event plugin python script file.

Member Function Documentation

◆ AddMetaDataEntry()

void Deadline.Events.DeadlineEventListener.AddMetaDataEntry	(	string	key,
		string	value
	)

Adds a dictionary entry to the event's metadata. This entry will persist between event triggers. This has no effect if the key already exists.

Parameters

key	The key.
value	The value.

◆ ClearProcessEnvironmentVariables()

void Deadline.Events.DeadlineEventListener.ClearProcessEnvironmentVariables ( )

Clears the extra environment variables for the event plugin.

◆ DeleteMetaDataEntry()

void Deadline.Events.DeadlineEventListener.DeleteMetaDataEntry ( string key )

Deletes an existing dictionary entry from the event's metadata. This has no effect if the key does not exist.

Parameters

key The key.

◆ GetAuxiliaryFilenames()

string [] Deadline.Events.DeadlineEventListener.GetAuxiliaryFilenames ( )

Gets the list of auxiliary files that were submitted with the job.

Returns: The list of auxiliary files.

◆ GetBooleanConfigEntry()

bool Deadline.Events.DeadlineEventListener.GetBooleanConfigEntry ( string key )

Gets a value as a bool from the plugin's configuration for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetBooleanConfigEntryWithDefault()

bool Deadline.Events.DeadlineEventListener.GetBooleanConfigEntryWithDefault	(	string	key,
		bool	defaultValue
	)

Gets a value as a bool from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetBooleanPluginInfoEntry()

bool Deadline.Events.DeadlineEventListener.GetBooleanPluginInfoEntry ( string key )

Gets the job's plugin info value as a bool for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetBooleanPluginInfoEntryWithDefault()

bool Deadline.Events.DeadlineEventListener.GetBooleanPluginInfoEntryWithDefault	(	string	key,
		bool	defaultValue
	)

Gets the job's plugin info value as a bool for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetConfigEntry()

string Deadline.Events.DeadlineEventListener.GetConfigEntry ( string key )

Gets a value from the plugin's configuration for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetConfigEntryWithDefault()

string Deadline.Events.DeadlineEventListener.GetConfigEntryWithDefault	(	string	key,
		string	defaultValue
	)

Gets a value from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetDataFilename()

string Deadline.Events.DeadlineEventListener.GetDataFilename ( )

Gets the first auxiliary file that was submitted with the job.

Returns: The name of the auxiliary file. If there are no auxiliary files, an empty string is returned.

◆ GetEventDirectory()

string Deadline.Events.DeadlineEventListener.GetEventDirectory ( )

Gets the event's plugin directory in the Repository.

Returns: The local plugin directory path.

◆ GetFloatConfigEntry()

float Deadline.Events.DeadlineEventListener.GetFloatConfigEntry ( string key )

Gets a value as a float from the plugin's configuration for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetFloatConfigEntryWithDefault()

float Deadline.Events.DeadlineEventListener.GetFloatConfigEntryWithDefault	(	string	key,
		float	defaultValue
	)

Gets a value as a float from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetFloatPluginInfoEntry()

float Deadline.Events.DeadlineEventListener.GetFloatPluginInfoEntry ( string key )

Gets the job's plugin info value as a float for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetFloatPluginInfoEntryWithDefault()

float Deadline.Events.DeadlineEventListener.GetFloatPluginInfoEntryWithDefault	(	string	key,
		float	defaultValue
	)

Gets the job's plugin info value as a float for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetIntegerConfigEntry()

int Deadline.Events.DeadlineEventListener.GetIntegerConfigEntry ( string key )

Gets a value as an integer from the plugin's configuration for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetIntegerConfigEntryWithDefault()

int Deadline.Events.DeadlineEventListener.GetIntegerConfigEntryWithDefault	(	string	key,
		int	defaultValue
	)

Gets a value as an integer from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetIntegerPluginInfoEntry()

int Deadline.Events.DeadlineEventListener.GetIntegerPluginInfoEntry ( string key )

Gets the job's plugin info value as an integer for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetIntegerPluginInfoEntryWithDefault()

int Deadline.Events.DeadlineEventListener.GetIntegerPluginInfoEntryWithDefault	(	string	key,
		int	defaultValue
	)

Gets the job's plugin info value as an integer for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetLongConfigEntry()

long Deadline.Events.DeadlineEventListener.GetLongConfigEntry ( string key )

Gets a value as a long from the plugin's configuration for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetLongConfigEntryWithDefault()

long Deadline.Events.DeadlineEventListener.GetLongConfigEntryWithDefault	(	string	key,
		long	defaultValue
	)

Gets a value as a long from the plugin's configuration for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetLongPluginInfoEntry()

long Deadline.Events.DeadlineEventListener.GetLongPluginInfoEntry ( string key )

Gets the job's plugin info value as a long for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetLongPluginInfoEntryWithDefault()

long Deadline.Events.DeadlineEventListener.GetLongPluginInfoEntryWithDefault	(	string	key,
		long	defaultValue
	)

Gets the job's plugin info value as a long for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetMetaData()

Dictionary<string, string> Deadline.Events.DeadlineEventListener.GetMetaData ( )

Gets the full metadata dictionary for the event.

Returns: The metadata dictionary.

◆ GetMetaDataEntry()

string Deadline.Events.DeadlineEventListener.GetMetaDataEntry ( string key )

Gets the value of an existing dictionary entry from the event's metadata.

Parameters

key The key.

Returns: The value. Returns null if the key does not exist.

◆ GetPluginInfoEntry()

string Deadline.Events.DeadlineEventListener.GetPluginInfoEntry ( string key )

Gets the job's plugin info value for the given key.

Parameters

key	The name of the plugin info entry. An error is thrown if the key is not defined.

Returns: The value.

◆ GetPluginInfoEntryWithDefault()

string Deadline.Events.DeadlineEventListener.GetPluginInfoEntryWithDefault	(	string	key,
		string	defaultValue
	)

Gets the job's plugin info value for the given key. If the key doesn't exist, the default value is returned.

Parameters

key	The name of the plugin info entry.
defaultValue	The default value.

Returns: The value. If the given key does not exist, the default value is returned.

◆ GetProcessEnvironmentVariable()

string Deadline.Events.DeadlineEventListener.GetProcessEnvironmentVariable ( string key )

Gets the extra environment variable for the event plugin with the given key. If the variable is not defined, an empty string is returned.

Parameters

key	The name of the environment variable.

Returns: The value, or an empty string if the variable is not defined.

◆ LogInfo()

void Deadline.Events.DeadlineEventListener.LogInfo ( string message )

Logs an INFO message.

Parameters

message The message.

◆ LogMessage()

void Deadline.Events.DeadlineEventListener.LogMessage ( string message )

Logs a message.

Parameters

message

◆ LogStdout()

void Deadline.Events.DeadlineEventListener.LogStdout ( string message )

Logs a STDOUT message.

Parameters

message The message.

◆ LogWarning()

void Deadline.Events.DeadlineEventListener.LogWarning ( string message )

Logs a WARNING message.

Parameters

message The message.

◆ OnHouseCleaning()

virtual void Deadline.Events.DeadlineEventListener.OnHouseCleaning ( )

virtual

Calls the on house cleaning callback.

◆ OnIdleShutdown()

virtual void Deadline.Events.DeadlineEventListener.OnIdleShutdown	(	string	groupName,
		string[]	slaveNames,
		IdleShutdownOptions	idleShutdownOptions
	)

virtual

Calls the on idle shutdown callback.

Parameters

groupName	The name of the power management group.
slaveNames	The Workers that are being shut down.
idleShutdownOptions	The idle shutdown options for the power management group that is triggering the shutdown.

◆ OnJobDeleted()

virtual void Deadline.Events.DeadlineEventListener.OnJobDeleted ( Job job )

virtual

Calls the on job deleted callback.

Parameters

job

◆ OnJobError()

virtual void Deadline.Events.DeadlineEventListener.OnJobError	(	Job	job,
		Task	task,
		Report	errorReport
	)

virtual

Calls the on job error callback.

Parameters

job
task
errorReport

Returns: Should the job be submitted or not.

◆ OnJobSuspended()

virtual void Deadline.Events.DeadlineEventListener.OnJobSuspended ( Job job )

virtual

Calls the on job suspended callback.

Parameters

job

◆ OnMachineRestart()

virtual void Deadline.Events.DeadlineEventListener.OnMachineRestart	(	string	groupName,
		string[]	slaveNames,
		MachineRestartOptions	machineRestartOptions
	)

virtual

Calls the on machine restart callback.

Parameters

groupName	The name of the power management group.
slaveNames	The Workers that are being restarted.
machineRestartOptions	The machine restart options for the power management group that is triggering the restart.

◆ OnMachineStartup()

virtual void Deadline.Events.DeadlineEventListener.OnMachineStartup	(	string	groupName,
		string[]	slaveNames,
		MachineStartupOptions	machineStartupOptions
	)

virtual

Calls the on machine startup callback.

Parameters

groupName	The name of the power management group.
slaveNames	The Workers that are being started up.
machineStartupOptions	The machine startup options for the power management group that is triggering the startup.

◆ OnRepositoryRepair()

virtual void Deadline.Events.DeadlineEventListener.OnRepositoryRepair ( )

virtual

Calls the on repository repair callback.

◆ OnSlaveIdle()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveIdle ( string slaveName )

virtual

Calls the on Worker idle callback.

Parameters

slaveName

◆ OnSlaveInfoUpdate()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveInfoUpdate	(	string	slaveName,
		SlaveInfo	slaveInfo
	)

virtual

Calls the on Worker info updated callback.

Parameters

slaveName
slaveInfo

◆ OnSlaveRendering()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveRendering	(	string	slaveName,
		Job	job
	)

virtual

calls the on Worker rendering callback.

Parameters

slaveName
job

◆ OnSlaveStalled()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveStalled ( string slaveName )

virtual

Calls the on Worker stalled callback.

Parameters

slaveName

◆ OnSlaveStarted()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveStarted ( string slaveName )

virtual

Calls the on Worker started callback.

Parameters

slaveName

◆ OnSlaveStartingJob()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveStartingJob	(	string	slaveName,
		Job	job
	)

virtual

Calls the on Worker starting job callback.

Parameters

slaveName
job

◆ OnSlaveStopped()

virtual void Deadline.Events.DeadlineEventListener.OnSlaveStopped ( string slaveName )

virtual

Calls the on Worker stopped callback.

Parameters

slaveName

◆ OnThermalShutdown()

virtual void Deadline.Events.DeadlineEventListener.OnThermalShutdown	(	string	groupName,
		string[]	slaveNames,
		ThermalShutdownOptions	thermalShutdownOptions
	)

virtual

Calls the on thermal shutdown callback.

Parameters

groupName	The name of the power management group.
slaveNames	The Workers that are being shut down.
thermalShutdownOptions	The thermal shutdown options for the power management group that is triggering the shutdown.

◆ ProcessEnvironmentVariableExists()

bool Deadline.Events.DeadlineEventListener.ProcessEnvironmentVariableExists ( string key )

Checks if the extra environment with the given key exists.

Parameters

key	The name of the environment variable.

Returns: True if the variable exists, otherwise False.

◆ ResetEventPlugin()

void Deadline.Events.DeadlineEventListener.ResetEventPlugin ( )

Resets the event plugin.

◆ RunProcess()

int Deadline.Events.DeadlineEventListener.RunProcess	(	string	executable,
		string	arguments,
		string	startupDirectory,
		int	timeoutMilliseconds
	)

Runs a process and waits for it to complete.

Parameters

executable	The executable to run. If the executable isn't rooted, the current directory will be checked first, followed by all directories in the PATH environment variable.
arguments	The arguments to pass to the executable.
startupDirectory	The directory to start the executable in. Specify an empty string to use directory the executable is in.
timeoutMilliseconds	The number of milliseconds for the process to exit, otherwise an error is thrown. If this is less than 0, this will block until the process exits.

Returns: The exit code of the process.

◆ RunProcessAsUser()

int Deadline.Events.DeadlineEventListener.RunProcessAsUser	(	string	executable,
		string	arguments,
		string	startupDirectory,
		int	timeoutMilliseconds,
		string	userName,
		string	domain,
		string	password
	)

Runs a process and waits for it to complete.

Parameters

executable	The executable to run. If the executable isn't rooted, the current directory will be checked first, followed by all directories in the PATH environment variable.
arguments	The arguments to pass to the executable.
startupDirectory	The directory to start the executable in. Specify an empty string to use directory the executable is in.
timeoutMilliseconds	The number of milliseconds for the process to exit, otherwise an error is thrown. If this is less than 0, this will block until the process exits.
userName	The name of the user to run the process as. This is required for Windows, Linux, and Mac OS X.
domain	The user's domain name, which is used to run the process as the given user. This is only required on Windows.
password	The user's password, which is used to run the process as the given user. This is only required on Windows.

Returns: The exit code of the process.

◆ SetEventPlugin()

void Deadline.Events.DeadlineEventListener.SetEventPlugin ( DeadlineEventPlugin eventPlugin )

Sets the event plugin.

Parameters

eventPlugin

◆ SetProcessEnvironmentVariable()

void Deadline.Events.DeadlineEventListener.SetProcessEnvironmentVariable	(	string	key,
		string	value
	)

Sets extra environment variables for any processes started by this event plugin. The processes must be started using RunProcess(). This will take precedence over a variable in the current environment with the same name.

Parameters

key	The name of the environment variable.
value	The value.

◆ UpdateMetaDataEntry()

void Deadline.Events.DeadlineEventListener.UpdateMetaDataEntry	(	string	key,
		string	value
	)

Updates an existing dictionary entry to the event's metadata. This entry will persist between event triggers. This has no effect if the key does not exist.

Parameters

key	The key.
value	The value.

Member Data Documentation

◆ plugin_initialized

readonly bool Deadline.Events.DeadlineEventListener.plugin_initialized = true

This property exists to catch when a python event plugin does not call super().__init__(). As of PythonNET 3.0.0, Python classes that subclass .NET base types (like this one) must explicitly call the super constructor. Not doing so will leave these uninitialized with a default value (false in the case of a bool).

Property Documentation

◆ UseProcessEnvironmentVariablesOnly

bool Deadline.Events.DeadlineEventListener.UseProcessEnvironmentVariablesOnly

getset

If True, only the extra environment variables defined for the event plugin will be used. If False (the default behavior), the extra environment variables will be merged with the current environment.

Event Documentation

◆ OnHouseCleaningCallback

GenericDelegate0 Deadline.Events.DeadlineEventListener.OnHouseCleaningCallback

If a function is assigned to this callback, it will be called when the House Cleaning operation is performed.

◆ OnIdleShutdownCallback

GenericDelegate3<string, string[], IdleShutdownOptions> Deadline.Events.DeadlineEventListener.OnIdleShutdownCallback

If a function is assigned to this callback, it will be called when Power Management shuts down a Worker machine because it is idle. The string corresponds to the group name and the string array corresponds to the Worker names.

◆ OnJobDeletedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobDeletedCallback

If a function is assigned to this callback, it will be called when a job is deleted.

◆ OnJobErrorCallback

GenericDelegate3<Job, Task, Report> Deadline.Events.DeadlineEventListener.OnJobErrorCallback

If a function is assigned to this callback, it will be called when a job reports an error while rendering.

◆ OnJobFailedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobFailedCallback

If a function is assigned to this callback, it will be called when a job fails.

◆ OnJobFailedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobFailedEvent

DEPRECATED: Use OnJobFailedCallback.

◆ OnJobFinishedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobFinishedCallback

If a function is assigned to this callback, it will be called when a job completes.

◆ OnJobFinishedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobFinishedEvent

DEPRECATED: Use OnJobFinishedCallback.

◆ OnJobImportedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobImportedCallback

If a function is assigned to this callback, it will be called when a job is imported.

◆ OnJobPendedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobPendedCallback

If a function is assigned to this callback, it will be called when a job enters the pending state.

◆ OnJobPendedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobPendedEvent

DEPRECATED: Use OnJobPendedCallback.

◆ OnJobPurgedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobPurgedCallback

If a function is assigned to this callback, it will be called when a job is purged.

◆ OnJobReleasedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobReleasedCallback

If a function is assigned to this callback, it will be called when a pending job is released.

◆ OnJobReleasedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobReleasedEvent

DEPRECATED: Use OnJobReleasedCallback.

◆ OnJobRequeuedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobRequeuedCallback

If a function is assigned to this callback, it will be called when a job is requeued.

◆ OnJobRequeuedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobRequeuedEvent

DEPRECATED: Use OnJobRequeuedCallback.

◆ OnJobResumedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobResumedCallback

If a function is assigned to this callback, it will be called when a suspended or failed job is resumed.

◆ OnJobResumedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobResumedEvent

DEPRECATED: Use OnJobResumedCallback.

◆ OnJobStartedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobStartedCallback

If a function is assigned to this callback, it will be called when a job has started rendering.

◆ OnJobStartedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobStartedEvent

DEPRECATED: Use OnJobStartedCallback.

◆ OnJobSubmittedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobSubmittedCallback

If a function is assigned to this callback, it will be called when a job is submitted.

◆ OnJobSubmittedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobSubmittedEvent

DEPRECATED: Use OnJobSubmittedCallback.

◆ OnJobSuspendedCallback

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobSuspendedCallback

If a function is assigned to this callback, it will be called when a job is suspended.

◆ OnJobSuspendedEvent

GenericDelegate1<Job> Deadline.Events.DeadlineEventListener.OnJobSuspendedEvent

DEPRECATED: Use OnJobSuspendedCallback.

◆ OnMachineRestartCallback

GenericDelegate3<string, string[], MachineRestartOptions> Deadline.Events.DeadlineEventListener.OnMachineRestartCallback

If a function is assigned to this callback, it will be called when Power Management restarts a Worker machine. The string corresponds to the group name and the string array corresponds to the Worker names.

◆ OnMachineStartupCallback

GenericDelegate3<string, string[], MachineStartupOptions> Deadline.Events.DeadlineEventListener.OnMachineStartupCallback

If a function is assigned to this callback, it will be called when Power Management starts up a Worker machine because it is needed for rendering. The string corresponds to the group name and the string array corresponds to the Worker names.

◆ OnRepositoryRepairCallback

GenericDelegate0 Deadline.Events.DeadlineEventListener.OnRepositoryRepairCallback

If a function is assigned to this callback, it will be called when the Repository Repair operation is performed.

◆ OnSlaveIdleCallback

GenericDelegate1<string> Deadline.Events.DeadlineEventListener.OnSlaveIdleCallback

If a function is assigned to this callback, it will be called when a Worker becomes idle. The string corresponds to the Worker name.

◆ OnSlaveInfoUpdatedCallback

GenericDelegate2<string, SlaveInfo> Deadline.Events.DeadlineEventListener.OnSlaveInfoUpdatedCallback

If a function is assigned to this callback, it will be called when a Worker updates its information in the database. The string corresponds to the Worker name. The SlaveInfo is the information that is being written to the database.

◆ OnSlaveRenderingCallback

GenericDelegate2<string, Job> Deadline.Events.DeadlineEventListener.OnSlaveRenderingCallback

If a function is assigned to this callback, it will be called when a Worker starts rendering a job. The string corresponds to the Worker name.

◆ OnSlaveStalledCallback

GenericDelegate1<string> Deadline.Events.DeadlineEventListener.OnSlaveStalledCallback

If a function is assigned to this callback, it will be called when a Worker is marked as stalled. The string corresponds to the Worker name.

◆ OnSlaveStartedCallback

GenericDelegate1<string> Deadline.Events.DeadlineEventListener.OnSlaveStartedCallback

If a function is assigned to this callback, it will be called when a Worker is started. The string corresponds to the Worker name.

◆ OnSlaveStartingJobCallback

GenericDelegate2<string, Job> Deadline.Events.DeadlineEventListener.OnSlaveStartingJobCallback

If a function is assigned to this callback, it will be called when a Worker starts loading a job. The string corresponds to the Worker name.

◆ OnSlaveStoppedCallback

GenericDelegate1<string> Deadline.Events.DeadlineEventListener.OnSlaveStoppedCallback

If a function is assigned to this callback, it will be called when a sWorkerlave is stopped. The string corresponds to the Worker name.

◆ OnThermalShutdownCallback

GenericDelegate3<string, string[], ThermalShutdownOptions> Deadline.Events.DeadlineEventListener.OnThermalShutdownCallback

If a function is assigned to this callback, it will be called when Power Management shuts down a Worker machine due to temperature. The string corresponds to the group name and the string array corresponds to the Worker names.

Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ AddMetaDataEntry()

◆ ClearProcessEnvironmentVariables()

◆ DeleteMetaDataEntry()

◆ GetAuxiliaryFilenames()

◆ GetBooleanConfigEntry()

◆ GetBooleanConfigEntryWithDefault()

◆ GetBooleanPluginInfoEntry()

◆ GetBooleanPluginInfoEntryWithDefault()

◆ GetConfigEntry()

◆ GetConfigEntryWithDefault()

◆ GetDataFilename()

◆ GetEventDirectory()

◆ GetFloatConfigEntry()

◆ GetFloatConfigEntryWithDefault()

◆ GetFloatPluginInfoEntry()

◆ GetFloatPluginInfoEntryWithDefault()

◆ GetIntegerConfigEntry()

◆ GetIntegerConfigEntryWithDefault()

◆ GetIntegerPluginInfoEntry()

◆ GetIntegerPluginInfoEntryWithDefault()

◆ GetLongConfigEntry()

◆ GetLongConfigEntryWithDefault()

◆ GetLongPluginInfoEntry()

◆ GetLongPluginInfoEntryWithDefault()

◆ GetMetaData()

◆ GetMetaDataEntry()

◆ GetPluginInfoEntry()

◆ GetPluginInfoEntryWithDefault()

◆ GetProcessEnvironmentVariable()

◆ LogInfo()

◆ LogMessage()

◆ LogStdout()

◆ LogWarning()

◆ OnHouseCleaning()

◆ OnIdleShutdown()

◆ OnJobDeleted()

◆ OnJobError()

◆ OnJobFailed()

◆ OnJobFinished()

◆ OnJobImported()

◆ OnJobPended()

◆ OnJobPurged()

◆ OnJobReleased()

◆ OnJobRequeued()

◆ OnJobResumed()

◆ OnJobStarted()

◆ OnJobSubmitted()

◆ OnJobSuspended()

◆ OnMachineRestart()

◆ OnMachineStartup()

◆ OnRepositoryRepair()

◆ OnSlaveIdle()

◆ OnSlaveInfoUpdate()

◆ OnSlaveRendering()

◆ OnSlaveStalled()

◆ OnSlaveStarted()

◆ OnSlaveStartingJob()

◆ OnSlaveStopped()

◆ OnThermalShutdown()

◆ ProcessEnvironmentVariableExists()

◆ ResetEventPlugin()

◆ RunProcess()

◆ RunProcessAsUser()

◆ SetEventPlugin()

◆ SetProcessEnvironmentVariable()

◆ UpdateMetaDataEntry()

Member Data Documentation

◆ plugin_initialized

Property Documentation

◆ UseProcessEnvironmentVariablesOnly

Event Documentation

◆ OnHouseCleaningCallback

◆ OnIdleShutdownCallback

◆ OnJobDeletedCallback