Table 110 summarizes the temporary storage domain’s specific
gates. It shows the level-1 trace point IDs of the modules providing the functions
for the gates, the functions provided by the gates, and whether or not the
functions are available through the exit programming interface (XPI).
Table 110. Temporary storage domain’s specific gates
Gate |
Trace |
Function |
XPI |
TSQR |
TS 0201
TS 0202
|
WRITE
REWRITE
READ_INTO
READ_SET
READ_NEXT_INTO
READ_NEXT_SET
DELETE
|
NO
NO
NO
NO
NO
NO
NO
|
TSPT |
TS 0301
TS 0302
|
PUT
PUT_REPLACE
GET
GET_SET
GET_RELEASE
GET_RELEASE_SET
RELEASE
|
NO
NO
NO
NO
NO
NO
NO
|
TSSH |
TS 0A01
TS 0A02
|
INITIALIZE
INQUIRE_POOL_TOKEN
WRITE
REWRITE
READ_INTO
READ_SET
READ_NEXT_INTO
READ_NEXT_SET
DELETE
INQUIRE_SYSID_TABLE_TOKEN
START_BROWSE
GET_NEXT
END_BROWSE
INQUIRE_QUEUE
|
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
|
TSSR |
TS 0601
TS 0602
|
SET_START_TYPE
SET_BUFFERS
SET_STRINGS
|
NO
NO
NO
|
TSBR |
TS 0701
TS 0702
|
INQUIRE_QUEUE
START_BROWSE
GET_NEXT
END_BROWSE
CHECK_PREFIX
|
NO
NO
NO
NO
NO
|
If the queue does not exist, this function creates a queue with the single
item provided, and the queue's "read cursor" is set to zero.
If the queue already exists, the item provided is appended to the queue,
and the read cursor left unchanged.
Input parameters
- QUEUE_NAME
- is the name of the queue being created or appended to.
- ITEM_DATA
- is the address and length of the item being written.
- [BMS]
- indicates whether or not BMS owns this queue. It can have either of
these values:
YES|NO
- SUSPEND
- indicates whether or not the request will be suspended if there is insufficient
auxiliary storage to satisfy the request. This option is ignored if the queue
is in main storage.
- STORAGE_TYPE
- indicates whether the queue is to be created in main or auxiliary storage.
Note that this option is ignored if the queue already exists.
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
Output parameters
- [TOTAL_ITEMS]
- is the total number of items in the queue on completion of the operation.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_FULL
INSUFFICIENT_STORAGE
INVALID_LENGTH
IO_ERROR
INVALID_QUEUE_TYPE
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
QUEUE_REMOTE
|
This function updates the specified item in an existing queue. The read
cursor is unchanged.
Input parameters
- QUEUE_NAME
- is the name of the queue being updated.
- ITEM_NUMBER
- is the number of the item to be updated.
- ITEM_DATA
- is the address and length of the item being written.
- SUSPEND
- indicates whether the request will be suspended if there is insufficient
auxiliary storage to satisfy the request. This option is ignored if the queue
is in main storage.
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
Output parameters
- [TOTAL_ITEMS]
- is the total number of items in the queue.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INSUFFICIENT_STORAGE
INVALID_LENGTH
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
QUEUE_REMOTE
|
This function reads the specified queue item into a buffer provided by
the caller. The read cursor for the queue is set to the item number provided.
The caller provides the address (item_buffer_p) and buffer length (item_buffer_m).
The actual length of the record is returned in item_buffer_n. If item_buffer_n
is greater than item_buffer_m, the data is truncated (but an OK response is
returned).
Input parameters
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_NUMBER
- is the number of the item to be read.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
Output parameters
- [TOTAL_ITEMS]
- returns the total number of items in the queue.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function reads the specified queue item into a storage area obtained
by TS. The read cursor for the queue is set to the input item number.
Input parameters
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_NUMBER
- is the number of the item to be read.
- [TCTTE_ADDRESS]
- is the address of the TCTTE - required if SET_STORAGE_CLASS(TERMINAL)
is specified.
- [SET_STORAGE_CLASS]
- specifies the class of storage into which the item will be read. This
may be either TASK (the default) or TERMINAL. If TERMINAL is specified, the
item is read into a TIOA. It can have either of these values:
TASK|TERMINAL
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
Output parameters
- ITEM_DATA
- returns the address and length of the item data.
- [TOTAL_ITEMS]
- returns the total number of items in the queue.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function increments the read cursor by one and reads that item number
into the buffer provided by the caller. The caller provides the address (item_buffer_p)
and buffer length (item_buffer_m). The actual length of the record is returned
in item_buffer_n. If item_buffer_n is greater than item_buffer_m, the data
will have been truncated.
Input parameters
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
- ITEM NUMBER
- returns the number of the item just read.
Output parameters
- [TOTAL_ITEMS]
- returns the total number of items in the queue.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function increments the queue's read cursor by one and reads that
item number into a storage area obtained by TS.
Input parameters
- QUEUE_NAME
- is the name of the queue being read.
- [TCTTE_ADDRESS]
- is the address of the TCTTE - required if SET_STORAGE_CLASS(TERMINAL)
is specified.
- [SET_STORAGE_CLASS]
- specifies the type of storage into which the item will be read. This
may be either TASK (the default) or TERMINAL. If TERMINAL is specified, the
item is read into a TIOA. It can have either of these values:
TASK|TERMINAL
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
Output parameters
- ITEM_DATA
- returns the address and length of the item data.
- [ITEM_NUMBER]
- returns the number of the item just read.
- [TOTAL_ITEMS]
- returns the total number of items in the queue.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function deletes the specified queue.
Input parameters
- QUEUE_NAME
- is the name of the queue to be deleted. the request.
- [CALLER]
- indicates whether this request originated from an EXEC or macro call.
The default is MACRO. It can have either of these values:
EXEC|MACRO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
|
This function allocates set storage of the requested length.
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
|
If the queue does not already exist, this function creates a queue with
the single item provided.
If the queue already exists, and is recoverable, a duplicate_name exception
is returned. Otherwise, the item is appended to the queue.
Input parameters
- QUEUE_NAME
- is the name of the queue being created or appended to.
- ITEM_DATA
- is the address and length of the item being written.
- [IC_DATA]
- is the address and length of an optional ICE.
- [BMS]
- this option indicates whether or not BMS owns this queue. If the queue
already exists and is a BMS queue then BMS(YES) must be specified on the request.
Otherwise an INVALID response is returned. It can have either of these values:
YES|NO
- [IC]
- this option indicates whether or not Interval Control owns this queue.
If the queue already exists and is an IC queue then IC(YES) must be specified
on the request. Otherwise an INVALID response is returned. It can have either
of these values:
YES|NO
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- SUSPEND
- indicates whether the request is to be suspended if there is insufficient
auxiliary storage to satisfy the request.
Output parameters
- RECOVERABLE
- returns whether the queue is recoverable or not.
- QUEUE_CREATION_TIME
- returns the store clock time at which the queue was created.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INSUFFICIENT_STORAGE
QUEUE_FULL
DUPLICATE_NAME
INVALID_LENGTH
IO_ERROR
INVALID_QUEUE_TYPE
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
QUEUE_REMOTE
|
If the queue does not exist, this function creates the queue with the item
provided. If the queue does exist, the first item in the queue is replaced
by the item provided.
Input parameters
- QUEUE_NAME
- is the name of the queue being created or written to.
- ITEM_DATA
- is the address and length of the data item being written.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_LENGTH
IO_ERROR
INVALID_QUEUE_TYPE
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
QUEUE_REMOTE
|
This function retrieves the first item in a "put" queue.
Input parameters
- QUEUE_NAME
- is the name of the queue being accessed.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
Output parameters
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
INVALID_QUEUE_NAME
|
This function retrieves the first item in a "put" queue into a set storage
area.
Input parameters
- QUEUE_NAME
- is the name of the queue being accessed.
Output parameters
- ITEM_DATA
- returns the address and length of the item in set storage.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
INVALID_QUEUE_NAME
|
This function retrieves and deletes the first item in a "put" queue. If
the queue has one item, the queue is deleted.
Input parameters
- QUEUE_NAME
- is the name of the queue being accessed.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
Output parameters
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
|
This function retrieves the first item in a "put" queue into set storage
and then deletes it. If the queue has one item, the queue is deleted.
Input parameters
- QUEUE_NAME
- is the name of the queue being accessed.
Output parameters
- ITEM_DATA
- returns the address and length of the item in set storage.
- [FMH]
- indicates whether the data contains an FMH. It can have either of these
values:
YES|NO
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
|
This function deletes a "put" queue.
Input parameters
- QUEUE_NAME
- is the name of the queue being deleted. the request.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
INVALID_QUEUE_TYPE
QUEUE_NOT_FOUND
LOCKED
INVALID_QUEUE_NAME
QUEUE_DELETED
|
Initialize the Shared TS interface.
Input parameters
Return token for the pool corresponding to the sysid provided.
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SYSID_NOT_FOUND |
If the queue does not exist, this function creates a queue with the single
item provided, and the queue's "read cursor" is set to zero.
If the queue already exists, the item provided is appended to the queue,
and the read cursor left unchanged.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being created or appended to.
- ITEM_DATA
- is the address and length of the item being written.
- SUSPEND
- indicates whether or not the request will be suspended if there is insufficient
storage to satisfy the request.
- FMH
- indicates whether the data contains an FMH.
- [TRANSID]
- is the id of the transaction which issued this request.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- TOTAL_ITEMS
- is the total number of items in the queue on completion of the operation.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_FULL
INSUFFICIENT_STORAGE
INVALID_LENGTH
INVALID_QUEUE_NAME
MAXIMUM_QUEUES_REACHED
|
This function updates the specified item in an existing queue. The read
cursor is unchanged.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being updated.
- ITEM_NUMBER
- is the number of the item to be updated.
- ITEM_DATA
- is the address and length of the item being written.
- SUSPEND
- indicates whether the request will be suspended if there is insufficient
storage to satisfy the request.
- FMH
- indicates whether the data contains an FMH.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- TOTAL_ITEMS
- is the total number of items in the queue.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
INSUFFICIENT_STORAGE
INVALID_LENGTH
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function reads the specified queue item into a buffer provided by
the caller. The read cursor for the queue is set to the item number provided.
The caller provides the address (item_buffer_p) and buffer length (item_buffer_m).
The actual length of the record is returned in item_buffer_n. If item_buffer_n
is greater than item_buffer_m, the data is truncated (but an OK response is
returned).
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_NUMBER
- is the number of the item to be read.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- TOTAL_ITEMS
- returns the total number of items in the queue.
- FMH
- indicates whether the data contains an FMH.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function reads the specified queue item into a storage area obtained
by TS. The read cursor for the queue is set to the input item number.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_NUMBER
- is the number of the item to be read.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- ITEM_DATA
- returns the address and length of the item data.
- TOTAL_ITEMS
- returns the total number of items in the queue.
- FMH
- indicates whether the data contains an FMH.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
IO_ERROR
SERVER_ERROR
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function increments the read cursor by one and reads that item number
into the buffer provided by the caller. The caller provides the address (item_buffer_p)
and buffer length (item_buffer_m). The actual length of the record is returned
in item_buffer_n. If item_buffer_n is greater than item_buffer_m, the data
will have been truncated.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being read.
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m)
of the data area into which the data will be read. The actual data length
is returned in item_buffer_n.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
- ITEM NUMBER
- returns the number of the item just read.
Output parameters
- TOTAL_ITEMS
- returns the total number of items in the queue.
- FMH
- indicates whether the data contains an FMH.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function increments the queue's read cursor by one and reads that
item number into a storage area obtained by TS.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue being read.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- ITEM_DATA
- returns the address and length of the item data.
- ITEM_NUMBER
- returns the number of the item just read.
- TOTAL_ITEMS
- returns the total number of items in the queue.
- FMH
- indicates whether the data contains an FMH.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_NOT_FOUND
ITEM_NOT_FOUND
INVALID_QUEUE_NAME
|
This function deletes the specified queue.
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue to be deleted. the request.
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_NOT_FOUND
INVALID_QUEUE_NAME
|
Input parameters
- [POOL_TOKEN]
- is a token for the shared TS pool.
- QUEUE_NAME
- is the name of the queue to be deleted. the request.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
SERVER_ERROR
IO_ERROR
QUEUE_NOT_FOUND
INVALID_QUEUE_NAME
|
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_NOT_FOUND
BROWSE_END
SERVER_ERROR
IO_ERROR
|
Returns information about the next queue in the browse.
Input parameters
None
Output parameters
- QUEUE_NAME
- is the name of the queue.
- [LAST_REFERENCED_TIME]
- is the time at which the queue was last referenced.
- [TOTAL_ITEMS]
- is the total number of items in the queue.
- [TOTAL_LENGTH]
- is the sum of the lengths of all the items in the queue.
- [MAXIMUM_ITEM_LENGTH]
- is the length of the longest item in the queue.
- [MINIMUM_ITEM_LENGTH]
- is the length of the shortest item in the queue.
- [TRANSID]
- is the id of the transaction whcih created the queue.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BROWSE_END
SERVER_ERROR
IO_ERROR
|
Ends the browse.
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BROWSE_END
SERVER_ERROR
IO_ERROR
|
Input parameters
- [POOL_TOKEN]
- is the token for the pool being inquired upon.
- QUEUE_NAME
- is the name of the queue being inquired upon.
- [KEY_COMPARISON]
- specifies the constraints on the inquire. The default is KEY_COMPARISON(EQ).
It can have any one of these values:
EQ|GT|GTEQ
- [TRANSACTION_NUMBER]
- is the 4-byte transaction number (in packed-decimal format).
Output parameters
- [OUTPUT_QUEUE_NAME]
- is the name of the queue whose information is returned. Note that this
may differ from queue_name unless key_comparison(eq) is specified.
- [LAST_REFERENCED_TIME]
- is the time at which the queue was last referenced.
- [TOTAL_ITEMS]
- is the total number of items in the queue.
- [TOTAL_LENGTH]
- is the sum of the lengths of all the items in the queue.
- [MAXIMUM_ITEM_LENGTH]
- is the length of the longest item in the queue.
- [MINIMUM_ITEM_LENGTH]
- is the length of the shortest item in the queue.
- [TRANSID]
- is the id of the transaction which created the queue.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_NOT_FOUND
SERVER_ERROR
IO_ERROR
|
Input parameters
- START
- indicates the type of startup requested.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
Sets the number of TS buffers to be used.
Input parameters
- BUFFERS
- the number of buffers required.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
This function sets the number of strings to be used.
Input parameters
- STRINGS
- the number of strings to be used.
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
Input parameters
- QUEUE_NAME
- is the name of the queue being inquired upon.
Output parameters
- [CREATION_TIME]
- is the time at which the queue was created.
- [LAST_REFERENCED_TIME]
- is the time at which the queue was last referenced.
- [TRANSID]
- is the id of the transaction which created the queue.
- [TOTAL_ITEMS]
- is the total number of items in the queue.
- [TOTAL_LENGTH]
- is the sum of the lengths of all the items in the queue.
- [MAXIMUM_ITEM_LENGTH]
- is the length of the longest item in the queue.
- [MINIMUM_ITEM_LENGTH]
- is the length of the shortest item in the queue.
- [STORAGE_TYPE]
- indicates whether the queue is held in main or auxiliary storage. It
can have either of these values:
MAIN|AUXILIARY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_NOT_FOUND |
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
QUEUE_NOT_FOUND |
Returns information about the next queue in the browse.
Input parameters
None
Output parameters
- QUEUE_NAME
- is the name of the queue.
- [CREATION_TIME]
- is the time at which the queue was created.
- [LAST_REFERENCED_TIME]
- is the time at which the queue was last referenced.
- [TRANSID]
- is the id of the transaction which created the queue.
- [TOTAL_ITEMS]
- is the total number of items in the queue.
- [TOTAL_LENGTH]
- is the sum of the lengths of all the items in the queue.
- [MAXIMUM_ITEM_LENGTH]
- is the length of the longest item in the queue.
- [MINIMUM_ITEM_LENGTH]
- is the length of the shortest item in the queue.
- [STORAGE_TYPE]
- indicates whether the queue is held in main or auxiliary storage. It
can have either of these values:
MAIN|AUXILIARY
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BROWSE_END |
Ends the browse.
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
BROWSE_END |
Checks whether there are any queues with the prefix provided.
Input parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE |
Possible REASON values |
EXCEPTION |
DUPLICATE
NOT_FOUND
|
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
This call is made from TS to IC to initiate inquire_queue requests from
IC to TS.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[[ Contents Previous Page | Next Page Index ]]