Simias::Service::ServiceCtl Class Reference

Used to control a Simias Service. More...

Inheritance diagram for Simias::Service::ServiceCtl:

[legend]

List of all members.

Public Member Functions
abstract void	Start ()
	Called to start the service.
abstract void	Stop ()
	Called to stop the service.
abstract void	Kill ()
	Called to Kill the service. Stop should be used instead. This will force the service down.
abstract void	Pause ()
	Called to pause the service.
abstract void	Resume ()
	Called to resume a paused service.
abstract void	Custom (int message, string data)
	Called to send a custom control to the service.
virtual void	ToXml (XmlElement element)
	Sets the service parameters in the XML element.
Protected Member Functions
	ServiceCtl (string serviceAssembly, XmlElement serviceElement)
	Initializes the Service Control object.
	ServiceCtl (string name, string assembly)
	Initializes the Service Control object.
Properties
string	Name [get]
	Gets the service name.
string	Assembly [get]
	Gets the assembly that contains this service.
State	State [get]
	Gets the running state of the service.
bool	Enabled [get, set]
	Gets or Sets the enabled state of the service.
abstract bool	HasExited [get]
	Called to check if the service has exited.

---

Detailed Description

Used to control a Simias Service.

---

Constructor & Destructor Documentation

Simias::Service::ServiceCtl::ServiceCtl	(	string	serviceAssembly,
		XmlElement	serviceElement
	)			[inline, protected]

Initializes the Service Control object.

Parameters:

	serviceAssembly	The assembly that the service belongs to.
	serviceElement	XML element that describes the service.

Simias::Service::ServiceCtl::ServiceCtl	(	string	name,
		string	assembly
	)			[inline, protected]

Initializes the Service Control object.

Parameters:

	name	The name of ther service.
	assembly	The assembly where the service exists.

---

Member Function Documentation

abstract void Simias::Service::ServiceCtl::Start

(

)

[pure virtual]

Called to start the service.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

abstract void Simias::Service::ServiceCtl::Stop

(

)

[pure virtual]

Called to stop the service.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

abstract void Simias::Service::ServiceCtl::Kill

(

)

[pure virtual]

Called to Kill the service. Stop should be used instead. This will force the service down.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

abstract void Simias::Service::ServiceCtl::Pause

(

)

[pure virtual]

Called to pause the service.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

abstract void Simias::Service::ServiceCtl::Resume

(

)

[pure virtual]

Called to resume a paused service.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

abstract void Simias::Service::ServiceCtl::Custom	(	int	message,
		string	data
	)			[pure virtual]

Called to send a custom control to the service.

Parameters:

	message	The message for the service.
	data	The data of the message.

Implemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

virtual void Simias::Service::ServiceCtl::ToXml

(

XmlElement

element

)

[inline, virtual]

Sets the service parameters in the XML element.

Parameters:

element

The element to initialize.

Reimplemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

---

Property Documentation

string Simias::Service::ServiceCtl::Name [get]

Gets the service name.

string Simias::Service::ServiceCtl::Assembly [get]

Gets the assembly that contains this service.

State Simias::Service::ServiceCtl::State [get]

Gets the running state of the service.

bool Simias::Service::ServiceCtl::Enabled [get, set]

Gets or Sets the enabled state of the service.

abstract bool Simias::Service::ServiceCtl::HasExited [get]

Called to check if the service has exited.

Reimplemented in Simias::Service::ProcessServiceCtl, and Simias::Service::ThreadServiceCtl.

---

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

• src/core/Service/ServiceCtl.cs