Digital

NAME

ENQUEUE RECORD −  statement in a task definition that writes a workspace to a local record queue
 

SYNOPSIS

 [<label-name>:]  ENQUEUE RECORD
                  ON <record-queue-name>
                  [ { ID | IDENTIFIER } <identifier-field> ]
                  USING <workspace-name> ;

PARAMETERS

       •label-name
 
An internal unqualified identifier associated with the statement, for use in flow control operations.

       •record-queue-name
 
An operating name identifying the record queue on which the record is enqueued.

       •identifier-field
 
An array workspace field of 16 octets (ARRAY SIZE 16 OF OCTET). An identifier uniquely identifies each item in a record queue. ACMSxp software enqueues the record queue item, generates a unique identifier, and places the unique identifier value in the identifier field in id-workspace field format. Use the contents of the identifier field for retrieval by ID in a later dequeue or read queue operation.

       •workspace-name
 
An identifier specifying the name of a workspace associated with a data type definition. Declare the workspace name in the task definition that contains the ENQUEUE RECORD statement. The name of the record in the task definition must  match the name associated with the workspace name in USING.
 

DESCRIPTION

 
The ACMSxp software inserts into the record queue named in ON the contents of the workspace named in USING and optionally stores a unique identifier for the record. The record is always inserted at the tail of the queue, independent of the queue cursor. Items in the record queue are ordered by the time of insertion.
 
The ON, ID, and USING parameters can appear in any order.
 
The unique identifier generated in ENQUEUE RECORD can be specified in RECORD BY IDENTIFIER to retrieve the record in a dequeue or read operation.
 
If ENQUEUE is used in a noncomposable task, it must be inside a transaction block.
 
The normal execution for ENQUEUE is:

     1.Enqueue the data to the record queue. 

     2.When you specify an identifier field, ACMSxp software returns the identifier of the record in the identifier field. 

     3.Complete with default flow control. 

Deviations from the normal execution flow occur when one of the conditions under the Exceptions section occurs.  The ENQUEUE RECORD completes with the exception class associated with the condition, and if an identifier field is specified, the value of the identifier field is undefined. 
 

EXCEPTIONS

 
The ENQUEUE RECORD statement can generate the exception classes described in the following sections. The sections describe the conditions leading to the exception class and can suggest actions to take.
 

AP-EXECUTION-FAULT

 
The AP-EXECUTION-FAULT exception class indicates one of the following error conditions:

oThe subscript used to refer to an element in a fixed-length array is invalid (referring to A(n) where n is less than one or greater than the maximum size of array). 

oThe subscript used to refer to an element in a variable-length array is invalid (referring to A(n) where n is less than one or greater than the value of the DEPENDING ON field). 

oThe value of the DEPENDING ON field used when referring to an element of a variable-length array is invalid (the value of the DEPENDING ON field is less than the minimum size of the array or the value of the DEPENDING ON field is greater than the maximum size of the array). 

oThe size of the workspace specified by the workspace name does not match the size of the target data type definition associated with the record queue. For a workspace that contains a variable-length array, the size of the workspace or record is determined by the DEPENDING ON field for the array. 

oThe value of the DEPENDING ON field was invalid when referring to a workspace name or workspace field containing a variable-length array. 

ENV-EXECUTION-FAULT

 
The ENV-EXECUTION-FAULT exception class indicates that the record queue server in the TP system in which the task is executing encountered a problem writing (enqueuing) a record in the record queue specified by the value of the record queue name in ON.
 

ENV-INVOCATION-FAULT

 
The ENV-INVOCATION-FAULT exception class indicates that the record queue specified by the value of the record queue name in ON is not defined in the TPsystem in which the task is executing.
 

RELATED INFORMATION

Syntax: dequeue_record(1), queue_specification(1), read_queue(1), task_definition(1), workspace(1)

acmsxp_introduction(1)