com.scalagent.task.util.NotifyTask Class Reference

Inherits com.scalagent.task.Task.

Inheritance diagram for com.scalagent.task.util.NotifyTask:

[legend]Collaboration diagram for com.scalagent.task.util.NotifyTask:

[legend]List of all members.

Public Member Functions
	NotifyTask (short to, AgentId parent, AgentId target, Notification notification) throws Exception
String	toString ()
Protected Member Functions
void	start () throws Exception
void	taskStop () throws Exception
Protected Attributes
AgentId	target
Notification	notification

---

Detailed Description

Task whose goal is to send a notification.

Definition at line 31 of file NotifyTask.java.

---

Constructor & Destructor Documentation

com.scalagent.task.util.NotifyTask.NotifyTask	(	short	to,
		AgentId	parent,
		AgentId	target,
		Notification	notification
	)			throws Exception

Creates an agent to be deployed remotely.

Parameters:

	to	agent server id where agent is to be deployed
	parent	agent to report status to
	target	agent to send notification to
	notification	notification to send to target

Definition at line 45 of file NotifyTask.java.

References com.scalagent.task.util.NotifyTask.notification, and com.scalagent.task.util.NotifyTask.target.

---

Member Function Documentation

String com.scalagent.task.util.NotifyTask.toString

(

)

Provides a string image for this object.

Returns:

a string image for this object

Reimplemented from com.scalagent.task.Task.

Definition at line 57 of file NotifyTask.java.

References com.scalagent.task.util.NotifyTask.notification, and com.scalagent.task.util.NotifyTask.target.

void com.scalagent.task.util.NotifyTask.start

(

)

throws Exception [protected, virtual]

Starts program execution, overloads start from base class.

Implements com.scalagent.task.Task.

Definition at line 66 of file NotifyTask.java.

References com.scalagent.task.util.NotifyTask.notification, com.scalagent.task.Task.setStatus(), and com.scalagent.task.util.NotifyTask.target.

Here is the call graph for this function:

void com.scalagent.task.util.NotifyTask.taskStop

(

)

throws Exception [protected, virtual]

Stops task execution. This function must ensure that setStatus(Status.DONE/FAIL/STOP) is eventually called.

Implements com.scalagent.task.Task.

Definition at line 77 of file NotifyTask.java.

---

Member Data Documentation

AgentId com.scalagent.task.util.NotifyTask.target [protected]

agent to send notification to

Definition at line 33 of file NotifyTask.java.

Referenced by com.scalagent.task.util.NotifyTask.NotifyTask(), com.scalagent.task.util.NotifyTask.start(), and com.scalagent.task.util.NotifyTask.toString().

Notification com.scalagent.task.util.NotifyTask.notification [protected]

notification to send to target

Definition at line 35 of file NotifyTask.java.

Referenced by com.scalagent.task.util.NotifyTask.NotifyTask(), com.scalagent.task.util.NotifyTask.start(), and com.scalagent.task.util.NotifyTask.toString().

---

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

• com/scalagent/task/util/NotifyTask.java

---