Ntp.Common.Process.JobDescription Class Reference

Base class for jobs following the GoF Command Pattern. More...

Inheritance diagram for Ntp.Common.Process.JobDescription:

Public Member Functions
override string	ToString ()
	Returns a string that represents the current JobDescription. More...

Public Attributes
string	Name => Configuration.ConfigName
	Gets the name. More...

Protected Member Functions
	JobDescription (IJobConfiguration config, LogBase log)
	Initializes a new instance of the JobDescription class. More...
abstract void	InternalExecute ()
	Implementing method for descendants. More...

Package Functions
void	Execute ()
	Perform execution of this instance. More...

Properties
IJobConfiguration	Configuration [get]
	Gets the configuration for the job. More...
abstract string	JobType [get]
	Gets the type of the job as text. More...
LogBase	Log [get]
	Gets the log to use when registering events. More...
abstract int	Priority [get]
	Gets the priority to use when scheduling jobs. More...
abstract ThreadType	ThreadType [get]
	Gets a value indicating whether this JobDescription should run as a single thread. More...

Detailed Description

Base class for jobs following the GoF Command Pattern.

Definition at line 29 of file JobDescription.cs.

Constructor & Destructor Documentation

Ntp.Common.Process.JobDescription.JobDescription ( IJobConfiguration  config, LogBase  log  )

inlineprotected

Initializes a new instance of the JobDescription class.

Parameters

config	Configuration for the job.
log	Log to use when registering events.

Definition at line 36 of file JobDescription.cs.

        {
            Configuration = config;
            Log = log;
        }

Member Function Documentation

void Ntp.Common.Process.JobDescription.Execute ( )

inlinepackage

Perform execution of this instance.

Definition at line 95 of file JobDescription.cs.

        {
            InternalExecute();
        }

abstract void Ntp.Common.Process.JobDescription.InternalExecute ( )

protectedpure virtual

Implementing method for descendants.

Implemented in Ntp.Analyzer.Process.Description.NotifyJob, Ntp.Analyzer.Process.Description.PeerStatJob, Ntp.Analyzer.Process.Description.PeerPageJob, Ntp.Analyzer.Process.Description.DriftStatJob, Ntp.Analyzer.Process.Description.HostStatJob, Ntp.Analyzer.Process.Description.HostPageJob, Ntp.Analyzer.Process.Description.HostGraphPageJob, Ntp.Analyzer.Process.Description.HostIoStatJob, Ntp.Analyzer.Process.Description.AboutPageJob, Ntp.Analyzer.Process.Description.HostGraphJob, Ntp.Analyzer.Process.Description.PeerGraphJob, Ntp.Analyzer.Process.Description.PeerGraphPageJob, Ntp.Analyzer.Process.Description.PeerSummaryJob, Ntp.Analyzer.Process.Description.TrafficGraphJob, and Ntp.Analyzer.Process.Description.BulkStatJob.

override string Ntp.Common.Process.JobDescription.ToString ( )

inline

Returns a string that represents the current JobDescription.

Returns

A string that represents the current JobDescription.

Definition at line 82 of file JobDescription.cs.

        {
            return Name;
        }

Member Data Documentation

string Ntp.Common.Process.JobDescription.Name => Configuration.ConfigName

Gets the name.

The name.

Definition at line 46 of file JobDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.ExecuteJob(), Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), Ntp.Analyzer.Monitor.Server.Billboard.Proc(), Ntp.Analyzer.Monitor.Server.Billboard.Running(), Ntp.Analyzer.Monitor.Server.Billboard.Schedule(), and Ntp.Common.Log.LogExtensions.SchedulerJobAdded().

Property Documentation

IJobConfiguration Ntp.Common.Process.JobDescription.Configuration

get

Gets the configuration for the job.

The configuration.

Definition at line 70 of file JobDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.Add().

abstract string Ntp.Common.Process.JobDescription.JobType

get

Gets the type of the job as text.

The type of the job.

Definition at line 58 of file JobDescription.cs.

Referenced by Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), and Ntp.Common.Log.LogExtensions.SchedulerJobAdded().

LogBase Ntp.Common.Process.JobDescription.Log

getprotected

Gets the log to use when registering events.

The log.

Definition at line 76 of file JobDescription.cs.

abstract int Ntp.Common.Process.JobDescription.Priority

get

Gets the priority to use when scheduling jobs.

The priority.

Definition at line 64 of file JobDescription.cs.

Referenced by Ntp.Analyzer.Monitor.Server.Billboard.Jobs(), Ntp.Analyzer.Monitor.Server.Billboard.Proc(), Ntp.Analyzer.Monitor.Server.Billboard.Running(), and Ntp.Analyzer.Monitor.Server.Billboard.Schedule().

abstract ThreadType Ntp.Common.Process.JobDescription.ThreadType

get

Gets a value indicating whether this JobDescription should run as a single thread.

true if single thread; otherwise, false.

Definition at line 52 of file JobDescription.cs.

Referenced by Ntp.Common.Process.Scheduler.RunOneCycle().

---

The documentation for this class was generated from the following file:

• Ntp.Common/Process/JobDescription.cs