home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / t / tpapi.zip / NWQUEUE.DOC < prev    next >
Text File  |  1992-01-28  |  6KB  |  119 lines
  1.                                 QUEUE SERVICES
  2.                                 ==============
  3.  
  4. AboutServicingQueueJobAndFile (QueueID : OT_BinderyID; JobNumber : WORD;
  5.                                VAR FileName : FileOfByte) : WORD;
  6.  
  7.   Used to abort the servicing of a job, closes the asscoiated file, and removes
  8.   the job entry from the queue.
  9. -------------------------------------------------------------------------------
  10. AttachQueueServerToQueue (QueueID : OT_BinderyID) : WORD;
  11.  
  12.   Attaches a station to a queue as a queue (job) server.
  13. -------------------------------------------------------------------------------
  14. ChangeQueueJobEntry (QueueID : OT_BinderyID; Job : JobStruct) : WORD;
  15.  
  16.   Changes information in a job's entry.
  17. -------------------------------------------------------------------------------
  18. ChangeQueueJobPosition (QueueID : OT_BinderyID; JobNumber : WORD;
  19.                         NewPosition : BYTE) : WORD;
  20.  
  21.   Changes a job's position in a queue.
  22. -------------------------------------------------------------------------------
  23. ChangeToClientRights (QueueID : OT_BinderyID; JobNumber : WORD) : WORD;
  24.  
  25.   Allows a queue (job) server to assume the login identity of the client that
  26.   placed the job in the queue.
  27. -------------------------------------------------------------------------------
  28. CloseFileAndAbortQueueJob (QueueID : OT_BinderyID; JobNumber : WORD;
  29.                            VAR FileName : FileOfByte) : WORD;
  30.  
  31.   Removes a job from a queue and closes the associated file.
  32. -------------------------------------------------------------------------------
  33. CloseFileAndStartQueueJob (QueueID : OT_BinderyID; JobNumber : WORD;
  34.                            VAR FileName : FileOfByte) : WORD;
  35.  
  36.   Closes an associated file and releases the job for servicing.
  37. -------------------------------------------------------------------------------
  38. CreateQueue (QueueName : ObjectNameType; QueueType : OT_BinderyType;
  39.              DirectoryHandle : BYTE; PathName : QueuePathNameType;
  40.              VAR QueueID : OT_BinderyID) : WORD;
  41.  
  42.   Creates a new queue on a file server.
  43. -------------------------------------------------------------------------------
  44. CreateQueueJobAndFile (QueueID : OT_BinderyID; VAR Job : JobStruct;
  45.                        VAR FileName : FileOfByte) : WORD;
  46.  
  47.   Places a new job in a queue.
  48. -------------------------------------------------------------------------------
  49. DestroyQueue (QueueID : OT_BinderyID) : WORD;
  50.  
  51.   Removes a queue from the bindery and file system of a file server.
  52. -------------------------------------------------------------------------------
  53. DetachQueueServerFromQueue (QueueID : OT_BinderyID) : WORD;
  54.  
  55.   Removes the requesting station from the queue's list of active queue (job)
  56.   servers.
  57. -------------------------------------------------------------------------------
  58. FinishServicingQueueJobAndFile (QueueID : OT_BinderyID; JobNumber : WORD;
  59.                                 Charge : LONGINT;
  60.                                 VAR FileName : FileOfByte) : WORD;
  61.  
  62.   Allows a queue (job) server to signal QMS when it has completed a job.
  63. -------------------------------------------------------------------------------
  64. GetQueueJobList (QueueID : OT_BinderyID; VAR JobCount : WORD;
  65.                  VAR JobNumberList : Word250ArrayType;
  66.                  MaxJobNumbers : WORD) : WORD;
  67.  
  68.   Provides a list of all jobs contained in a queue.
  69. -------------------------------------------------------------------------------
  70. GetQueueJobFileSize (QueueID : OT_BinderyID; JobNumber : WORD;
  71.                      VAR SizeOfFile : LONGINT) : WORD;
  72.  
  73.   Finds the size of the associated file for a job queue.
  74. -------------------------------------------------------------------------------
  75. ReadQueueCurrentStatus (QueueID : OT_BinderyID; VAR QueueStatus : WORD;
  76.                         VAR NumberOfJobs, NumberOfServers : WORD;
  77.                         VAR ServerIDList : Longint25ArrayType;
  78.                         VAR ServerStationList : Word25ArrayType;
  79.                         MaxNumberOfServers : WORD) : WORD;
  80.  
  81.   Reads the current status of a queue.
  82. -------------------------------------------------------------------------------
  83. ReadQueueJobEntry (QueueID : OT_BinderyID; JobNumber : WORD;
  84.                    VAR Job : JobStruct) : WORD;
  85.  
  86.   Retrieves information about a job in a queue.
  87. -------------------------------------------------------------------------------
  88. ReadQueueServerCurrentStatus (QueueID : OT_BinderyID; ServerID : OT_BinderyID;
  89.                               ServerStation : WORD;
  90.                               VAR ServerStatusRecord : Byte64ArrayType) : WORD;
  91.  
  92.   Reads the current status record of an attached queue (job) server.
  93. -------------------------------------------------------------------------------
  94. RemoveJobFromQueue (QueueID : OT_BinderyID; JobNumber : WORD) : WORD;
  95.  
  96.   Removes a job from a queue.
  97. -------------------------------------------------------------------------------
  98. RestoreQueueServerRights : WORD;
  99.  
  100.   Restores a server's own login identity after it has assumed the client's
  101.   rights.
  102. -------------------------------------------------------------------------------
  103. ServiceQueueJobAndOpenFile (QueueID : OT_BinderyID; TargetJobType : WORD;
  104.                             VAR Job : JobStruct;
  105.                             VAR FileName : FileOfByte) : WORD;
  106.  
  107.   Allows a queue server to request a new job for servicing.
  108. -------------------------------------------------------------------------------
  109. SetQueueCurrentStatus (QueueID : OT_BinderyID; QueueStatus : WORD) : WORD;
  110.  
  111.   Controls the addition of jobs and job servers toa queue by setting or
  112.   clearing bits int the queueStatus byte.
  113. -------------------------------------------------------------------------------
  114. SetQueueServerCurrentStatus (QueueID : OT_BinderyID;
  115.                              ServerStatusRecord : Byte64ArrayType) : WORD;
  116.  
  117.   Updates QMS's copy of a queue (job) server's status record.
  118. ------------------------------------------------------------------------------
  119.