IRISLIB database
WorkMgrIPQ Class Reference

For internal use only. More...

Inheritance diagram for WorkMgrIPQ:
Collaboration diagram for WorkMgrIPQ:

Public Member Functions

_.Library.Status Decode (_.Library.String qspec, _.Library.Boolean AtEnd)
 For internal use only. More...
 
- Public Member Functions inherited from WorkMgr
_.Library.Status Detach (_.Library.String token, _.Library.Integer timeout)
 Detach this oref from the work queue and set token which you can use in another process (or in this process if wanted) More...
 
_.Library.Integer NumberWorkers ()
 Return the number of worker jobs that we will request for this group. More...
 
_.Library.Status Pause (_.Library.Integer timeout, _.Library.Boolean completed)
 Pause any work in this work queue, this stops any workers from picking up additional items from. More...
 
_.Library.Status Queue (_.Library.String work, _.Library.String args)
 Queues a specific unit of work, you pass the entry point to call in 'work' argument. More...
 
_.Library.Status QueueCallback (_.Library.String work, _.Library.String callback, _.Library.String args)
 Similar to <method>Queue</method> except you can also pass in a 'callback' which is a function or class method that. More...
 
_.Library.Status Resume ()
 Resume any work in this work queue which was paused with a call to <method>Pause</method>.
 
- Public Member Functions inherited from AbstractWorkMgr
_.Library.Status OnNew (_.Library.String qstruct, _.Library.Integer numberjobs, category, target)
 Initialize the worker jobs so they are ready to start accepting work items. More...
 
_.Library.Status Cleanup (_.Library.String work, _.Library.String args)
 Normally when a work group is deleted the delete/close is synchronous and so waits for all the worker jobs to finish. More...
 
_.Library.Status Clear (_.Library.Integer timeout)
 Clear any existing work from this work queue, it does this by removing the queue and creating a new one. More...
 
_.Library.Status Setup (_.Library.String work, _.Library.String args)
 If you queue a large number of units of work and there is some common setup needed by any process that will. More...
 
_.Library.Status Sync (_.Library.String qspec, _.Library.String errorlog)
 After work has been queued this will wait for all the workers to complete. More...
 
_.Library.Status TearDown (_.Library.String work, _.Library.String args)
 This is a companion method to <method>Setup</method> to restore a workers process to the previous state if. More...
 
_.Library.Status Wait (_.Library.String qspec, _.Library.Boolean atend, _.Library.Integer timeout)
 After work has been queued you can call this to process some work completion events and then return to the caller where the caller. More...
 
_.Library.Status WaitForComplete (_.Library.String qspec, _.Library.String errorlog)
 
_.Library.Boolean WaitOne (_.Library.Integer timeout, _.Library.Status worksc, _.Library.Binary workargs, _.Library.Binary workresult)
 

Additional Inherited Members

- Static Public Member Functions inherited from WorkMgr
_.SYSTEM.WorkMgr Attach (token, _.Library.Status sc)
 This class provides an interface to the work queue manager code that allows work to be distributed to multiple processes in order to improve performance. More...
 
_.Library.Integer DefaultNumWorkers (category)
 Return the default number of worker jobs we will use if no specific number is specified.
 
_.Library.Status Flush ()
 Called from a worker job to flush any output produced so far to the parent process. More...
 
_.Library.Boolean IsWorkerJob ()
 Returns true/false based on if the current process is a worker job or not.
 
- Static Public Member Functions inherited from AbstractWorkMgr
_.Library.String Help (_.Library.String method)
 Write out a list of the methods of this object to the console. More...
 
_.SYSTEM.AbstractWorkMgr Initialize (_.Library.String qspec, _.Library.Status sc, _.Library.Integer numworkers)
 Deprecated method implemented for compatibility with code used to calling 'Initialize' method but new users should call New. More...
 
- Public Attributes inherited from AbstractWorkMgr
 DeleteTimeout
 When the work queue oref is killed or goes out of scope this is the timeout we pass to the call the destructor. More...
 
 NumActiveWorkers
 For local WQM groups number of active workers attached to this group. More...
 
 NumWorkers
 For local WQM group after the work group is created the number of workers allocated to this group. More...
 

Detailed Description

For internal use only.

Member Function Documentation

◆ Decode()

_.Library.Status Decode ( _.Library.String  qspec,
_.Library.Boolean  AtEnd 
)

For internal use only.

This is called when the data received from the IPQ is "" in order to return

any error information or output anything to the current device and to take care of book keeping. It will set AtEnd if we are at the end of the data and will run any callback methods and will return to the caller.