WorkUnit

From Web Computing Documentation
(Difference between revisions)
Jump to: navigation, search
(Implemented interface functions)
(Implemented interface functions)
 
Line 61: Line 61:
 
<div class="class_function_definition">
 
<div class="class_function_definition">
 
'''unSerialize''' (s : haxe.Unserializer) from [[Persistent]]
 
'''unSerialize''' (s : haxe.Unserializer) from [[Persistent]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''isCompleted''' () : Bool from [[AsyncResult]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''isError''' () from [[AsyncResult]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''getError''' () : String from [[AsyncResult]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''getProgress''' () : Float from [[AsyncResult]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''getResult''' () : T from [[AsyncResult]]
  +
</div>
  +
  +
<div class="class_function_definition">
  +
'''getElapsedTime''' () : Date from [[AsyncResult]]
 
</div>
 
</div>

Latest revision as of 10:03, 12 August 2011

interface WorkUnit implements Operable, implements LogSource, implements Persistent, implements AsyncResult<WorkContext>

  • web2grid
    • web2grid.core
      • web2grid.core.iface
        • web2grid.core.iface.WorkUnit


[edit] Interface overview

Implementing the WorkUnit interface enables the class to be handled by the WorkUnitPool.

[edit] Public functions

start ()

Starts the WorkUnit if it's in the Passive state.

terminate ()

Terminates the WorkUnit. If a worker has been started it will be terminated immediately as well. The worker returns to the Passive state.

enable ()

Returns the WorkUnit from the Disabled state to the Passive state. The WorkUnit can be started again with the start function.

disable ()

Places the WorkUnit into the Disabled state. It cannot be started until using the enable function first.

getState () : WorkUnitState

Returns the actual state of the WorkUnit.

[edit] Implemented interface functions

operate () from Operable

isChanged () : Bool from Persistent

hxSerialize (s : haxe.Serializer) from Persistent

unSerialize (s : haxe.Unserializer) from Persistent

isCompleted () : Bool from AsyncResult

isError () from AsyncResult

getError () : String from AsyncResult

getProgress () : Float from AsyncResult

getResult () : T from AsyncResult

getElapsedTime () : Date from AsyncResult

Personal tools
Modules