ADDRESS
Provide access to CICSPlex® SM storage areas.
>>-ADDRESS--+--------------------+------------------------------> '-ECB--(--ptr-ref--)-' >--+-------------------------+--THREAD--(--cpsm-token--)--------> '-SENTINEL--(--ptr-ref--)-' >--RESPONSE--(--data-ref--)--REASON--(--data-ref--)------------><
Description
The ADDRESS command provides access to CICSPlex SM storage areas.
- ADDRESS returns the addresses of two control fields that are associated with each API thread:
- the event control block (ECB)
- the sentinel.
- If your program is written in REXX, the ECB and sentinel values are returned as character representations of the hexadecimal addresses. You have to use the REXX STORAGE function to access the storage at those addresses.
Related commands
LISTEN, RECEIVE
Options
- ECB(ptr-ref)
- Names a variable to receive the address of the ECB that will be posted when asynchronous requests associated with this thread are awaiting processing. The ECB field is cleared whenever the counter value in the SENTINEL field reaches 0.
- REASON(data-ref)
- Names a variable to receive the fullword reason value returned by this command.
- RESPONSE(data-ref)
- Names a variable to receive the fullword response value returned by this command.
- SENTINEL(ptr-ref)
- Names a variable to receive the address of a 4-byte counter of completed asynchronous
requests associated with this thread. The sentinel value increases each time an asynchronous request completes. Examples of asynchronous requests include:
- A command is issued with the NOWAIT option
- An event occurs that is named in a LISTEN command.
The sentinel value decreases when a RECEIVE command is issued. If the counter value is 0, it means there are no outstanding asynchronous requests to be received.
Note: Each API processing thread can handle a maximum of 256 asynchronous requests (as indicated by the SENTINEL counter) at one time. - THREAD(cpsm-token)
- Identifies the API thread to be used for this operation. The cpsm-token value that identifies a thread is returned by the CONNECT command.
Conditions
The following is a list of the RESPONSE
values that can be returned by the ADDRESS command. The description of each
RESPONSE includes a list of associated REASON values, if appropriate.
- OK
- The command completed processing successfully.
- ENVIRONERROR
- An environment error occurred for one of the following reasons:
- NOSERVICE
- The application stub program could not load the API service module.
- NOSTORAGE
- The application stub program could not obtain the necessary storage in the address space where the processing thread is running.
- FAILED
- The command failed for one of the following reasons:
- ABENDED
- Command processing abended.
- EXCEPTION
- Command processing encountered an exceptional condition.
- INVALIDPARM
- An invalid parameter was detected. The parameter that is invalid is returned
as the reason value:
- ECB
- SENTINEL
- THREAD.
- NOTAVAILABLE
- A not available condition occurred for one of the following reasons:
- APITASK
- The API control subtask is not active.
- CPSMAPI
- The CMAS to which the processing thread is connected is not available for API processing.
- SERVERGONE
- The CMAS to which the processing thread was connected is no longer active.
- VERSIONINVL
- A version conflict occurred for one of the following reasons:
- NOTSUPPORTED
- The version of the application stub program used for this command is not supported.
- NOTVSNCONN
- The version of the application stub program used for this command is not the same as the version used with the CONNECT command.
