Inherited by Service
List of all members.
|Controllable Handle definition. |
|Controllable View definition. |
|Controllable Holder definition. |
Public Member Functions
|virtual void||configure (XmlElement::View vXml)=0|
|Configure the controllable service. |
|virtual bool||isRunning () const =0|
|Determine whether or not the controllable service is running. |
|virtual void||start ()=0|
|Start the controllable service. |
|virtual void||shutdown ()=0|
|Stop the controllable service. |
|virtual void||stop ()=0|
|Hard-stop the controllable service. |
|virtual void configure||(||XmlElement::View||vXml||)||
Configure the controllable service.
This method can only be called before the controllable service is started.
|vXml||an XmlElement carrying configuration information specific to the Controllable object|
|virtual bool isRunning||(||)|| const
Determine whether or not the controllable service is running.
This method returns false before a service is started, while the service is starting, while a service is shutting down and after the service has stopped. It only returns true after completing its start processing and before beginning its shutdown processing.
|virtual void start||(||)||
Start the controllable service.
This method should only be called once per the life cycle of the Controllable service. This method has no affect if the service is already running.
virtual void IllegalStateException thrown if a service does not support being re-started, and the service was already started and subsequently stopped and then an attempt is made to start the service again; also thrown if the Controllable service has not been configured
|virtual void shutdown||(||)||
Stop the controllable service.
This is a controlled shut-down, and is preferred to the stop() method.
This method should only be called once per the life cycle of the controllable service. Calling this method for a service that has already stopped has no effect.
|virtual void stop||(||)||
Hard-stop the controllable service.
Use shutdown() for normal service termination. Calling this method for a service that has already stopped has no effect.