WorkSource

From Web Computing Documentation
(Difference between revisions)
Jump to: navigation, search
(Public functions)
(Public functions)
 
Line 32: Line 32:
   
 
Terminates all [[WorkUnit|WorkUnits]] in the [[WorkSource]]. If a ''worker'' has been started it will also be immediately terminated.
 
Terminates all [[WorkUnit|WorkUnits]] in the [[WorkSource]]. If a ''worker'' has been started it will also be immediately terminated.
 
<div class="class_function_definition">
 
'''operate''' ()
 
</div>
 
 
Required by the [[Operable]] interface. Administrative tasks are executed at this time.
 
   
 
<div class="class_function_definition">
 
<div class="class_function_definition">
Line 56: Line 50:
   
 
Terminates a single [[WorkUnit]]. If you use the [[BasicWorkSource]] the [[WorkUnit]] started latest will be terminated.
 
Terminates a single [[WorkUnit]]. If you use the [[BasicWorkSource]] the [[WorkUnit]] started latest will be terminated.
  +
  +
==Implemented interface functions==
  +
  +
<div class="class_function_definition">
  +
'''operate''' () from [[Operable]]
  +
</div>
  +
  +
Administrative tasks are run at this time.

Latest revision as of 10:04, 12 August 2011

interface WorkSource implements Operable, implements LogSource, implements Persistent

  • web2grid
    • web2grid.core
      • web2grid.core.iface
        • web2grid.core.iface.WorkSource


[edit] Interface overview

Implementing the WorkSource interface enables the class to be handled by the WorkSourcePool.

[edit] Public functions

getWorkUnits () : Array<WorkUnit>

Returns an array of the WorkUnits contained by the WorkSource.

start ()

Enables the WorkSource.

terminate ()

Terminates all WorkUnits in the WorkSource. If a worker has been started it will also be immediately terminated.

getNumActive () : Int

Returns the number of active WorkUnits in the WorkSource.

startOne ()

Starts an enabled WorkUnit.

terminateOne ()

Terminates a single WorkUnit. If you use the BasicWorkSource the WorkUnit started latest will be terminated.

[edit] Implemented interface functions

operate () from Operable

Administrative tasks are run at this time.

Personal tools
Modules