Inheritance diagram for Ntp.Analyzer.Process.Description.NotifyJob:

Collaboration diagram for Ntp.Analyzer.Process.Description.NotifyJob:

[legend]

Public Member Functions
	NotifyJob (NotifyConfiguration config, LogBase log, int pid, string configFile)

void	Dispose ()

Public Member Functions inherited from Ntp.Common.Process.JobDescription
override string	ToString ()
	Returns a string that represents the current JobDescription. More...

Public Attributes
override string	JobType => "Notification mail"

override int	Priority => 99

override ThreadType	ThreadType => ThreadType.MultiThreaded

Public Attributes inherited from Ntp.Common.Process.JobDescription
string	Name => Configuration.ConfigName
	Gets the name. More...

Protected Member Functions
override void	InternalExecute ()
	Implementing method for descendants. More...

Protected Member Functions inherited from Ntp.Common.Process.JobDescription
	JobDescription (IJobConfiguration config, LogBase log)
	Initializes a new instance of the JobDescription class. More...

Package Functions
void	SetJobList (IEnumerable< Job > items)
	Sets the job list to be monitored. More...

Package Functions inherited from Ntp.Common.Process.JobDescription
void	Execute ()
	Perform execution of this instance. More...

Private Member Functions
	~NotifyJob ()

string	BuildContent ()
	Builds the message content. More...

void	Dispose (bool disposing)

Private Attributes
readonly SmtpClient	client

readonly NotifyConfiguration	config

readonly string	configFile

readonly List< Job >	jobs

readonly int	pid

Additional Inherited Members
Properties inherited from Ntp.Common.Process.JobDescription
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

Definition at line 35 of file NotifyJob.cs.

Constructor & Destructor Documentation

Ntp.Analyzer.Process.Description.NotifyJob.NotifyJob	(	NotifyConfiguration	config,
		LogBase	log,
		int	pid,
		string	configFile
	)

inline

Definition at line 37 of file NotifyJob.cs.

References Ntp.Analyzer.Config.Node.NotifyConfiguration.EnableSsl, Ntp.Analyzer.Config.Node.NotifyConfiguration.SmptServer, Ntp.Analyzer.Config.Node.NotifyConfiguration.SmtpPass, Ntp.Analyzer.Config.Node.NotifyConfiguration.SmtpPort, and Ntp.Analyzer.Config.Node.NotifyConfiguration.SmtpUser.

             : base(config, log)
         {
             this.config = config;
             this.pid = pid;
             this.configFile = configFile;
             jobs = new List<Job>();
 
             client = new SmtpClient(config.SmptServer, config.SmtpPort);
 
             if (config.SmtpUser != null)
             {
                 client.Credentials = new NetworkCredential(config.SmtpUser, config.SmtpPass ?? string.Empty);
             }
 
             client.EnableSsl = config.EnableSsl;
         }

Ntp.Analyzer.Process.Description.NotifyJob.~NotifyJob ( )

inlineprivate

Definition at line 119 of file NotifyJob.cs.

         {
             Dispose(false);
         }

Member Function Documentation

string Ntp.Analyzer.Process.Description.NotifyJob.BuildContent ( )

inlineprivate

Builds the message content.

Returns: The content.

Definition at line 97 of file NotifyJob.cs.

References Ntp.Analyzer.Monitor.Server.Billboard.Jobs().

         {
             var builder = new StringBuilder();
             builder.AppendLine("List of running items in NTP Analyzer");
             builder.Append(Billboard.Jobs(jobs));
             builder.Append("Using configuration: ");
             builder.AppendLine(configFile);
             builder.Append("Running with PID: ");
             builder.AppendLine(pid.ToString(CultureInfo.InvariantCulture));
             return builder.ToString();
         }

Here is the call graph for this function:

void Ntp.Analyzer.Process.Description.NotifyJob.Dispose ( bool disposing )

inlineprivate

Definition at line 111 of file NotifyJob.cs.

         {
             if (disposing)
             {
                 client.Dispose();
             }
         }

void Ntp.Analyzer.Process.Description.NotifyJob.Dispose ( )

inline

Definition at line 124 of file NotifyJob.cs.

         {
             Dispose(true);
             GC.SuppressFinalize(this);
         }

override void Ntp.Analyzer.Process.Description.NotifyJob.InternalExecute ( )

inlineprotectedvirtual

Implementing method for descendants.

Implements Ntp.Common.Process.JobDescription.

Definition at line 72 of file NotifyJob.cs.

         {
             var message = new MailMessage(
                 config.Sender,
                 config.Mail,
                 config.Subject,
                 BuildContent()
                 );
 
             client.Send(message);
         }

void Ntp.Analyzer.Process.Description.NotifyJob.SetJobList ( IEnumerable< Job > items )

inlinepackage

Sets the job list to be monitored.

Parameters

items Scheduled items.

Definition at line 88 of file NotifyJob.cs.

         {
             jobs.AddRange(items);
         }

Member Data Documentation

readonly SmtpClient Ntp.Analyzer.Process.Description.NotifyJob.client

private

Definition at line 60 of file NotifyJob.cs.

readonly NotifyConfiguration Ntp.Analyzer.Process.Description.NotifyJob.config

private

Definition at line 61 of file NotifyJob.cs.

readonly string Ntp.Analyzer.Process.Description.NotifyJob.configFile

private

Definition at line 62 of file NotifyJob.cs.

readonly List<Job> Ntp.Analyzer.Process.Description.NotifyJob.jobs

private

Definition at line 63 of file NotifyJob.cs.

override string Ntp.Analyzer.Process.Description.NotifyJob.JobType => "Notification mail"

Definition at line 68 of file NotifyJob.cs.

readonly int Ntp.Analyzer.Process.Description.NotifyJob.pid

private

Definition at line 64 of file NotifyJob.cs.

override int Ntp.Analyzer.Process.Description.NotifyJob.Priority => 99

Definition at line 70 of file NotifyJob.cs.

override ThreadType Ntp.Analyzer.Process.Description.NotifyJob.ThreadType => ThreadType.MultiThreaded

Definition at line 66 of file NotifyJob.cs.

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

Ntp.Analyzer.Process/Description/NotifyJob.cs

Public Member Functions

Public Attributes

Protected Member Functions

Package Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation