Verbs and Built-in Functions › &APPC REGISTER

&APPC REGISTER

&APPC REGISTER allows any executing NCL process to attempt to register itself with a server name, and optionally provides its conversation options for client/server processing.

This verb has the following format:

&APPC REGISTER
      SERVER=servername
    [ SCOPE={ REGION | USER | SYSTEM } ]
    [ CONNECT={ ACCEPT | NOTIFY | REJECT } ]
    [ RETRY={ YES | NO } ]
    [ CONVLIM={ 100 | nnn } ]

Operands:

SERVER=servername

(Mandatory) Specifies the logical name to register for the NCL process to be recognized as a server. It may be up to 32 characters long and unique within the scope as determined by the SCOPE operand, or the registration is rejected. If the registration is accepted, the other operands determine the server condition for accepting client connections.

SCOPE={ REGION | USER |SYSTEM }

Provides the scope for the registration of servername (which must be unique within the scope indicated). Valid scopes are:

REGION

Indicates that servername is to be unique within the current session, as defined by a particular connection to your product region.

USER

Indicates that servername is to be unique across all sessions associated with the particular user ID

SYSTEM

Indicates that servername is to be unique within this product region.

CONNECT={ ACCEPT | NOTIFY | REJECT }

Sets the client connection mode for the server process issuing the registration request.

If CONNECT=ACCEPT is specified, or defaulted, any client conversations directed to this server are automatically accepted. They are connected to the process as a standard conversation and immediately satisfy an appropriate receive request.

If CONNECT=NOTIFY is specified, any queued or new client connection requests are notified to the server's &INTREAD queue in the same manner as a transfer request. In this case the server can choose to accept or reject the connection by use of the &APPC TRANSFER options. Until the conversation is accepted by the &APPC TRANSFER_ACCEPT, it cannot be operated by the process.

Note: This mode of connection is the only one that allows the server to obtain any PIP data carried with the new conversation.

If CONNECT=REJECT is specified, any queued or new conversations are rejected with a condition of retry, or no retry, as determined by the RETRY operand. This is normally done only when the server is closing down to indicate end of processing.

RETRY={ YES | NO }

Sets the retry status for rejected connection requests. Rejection is due to an explicit CONNECTION=REJECT state, or due to the process conversation limit being reached.

If RETRY=YES is specified, or defaulted, connections are failed with a return code conveyed to the initiator of:

TRANS_PGM_NOT_AVAIL_RETRY

For RETRY=NO, the conversation fails with:

TRANS_PGM_NOT_AVAIL_NO_RETRY

CONVLIM={ 100 | nnn }

Sets the conversation limit for the process. If this limit is reached at any stage during processing, subsequent connection requests are automatically placed in the pending queue.

Example: & APPC REGISTER

&APPC REGISTER SERVER=PRINTSERVER

Return Codes:

The return codes are as follows:

0

Register accepted

16

Duplicate server name error

Notes:

An NCL process is registered as a server in the following ways:

• By starting the process using the START command and specifying a server name
• By starting the process using the &APPC START verb, issued from another process and specifying a server name
• By specifying a server name in the TCT entry that will service a transaction
• Directly, by issuing the &APPC REGISTER verb

More information:

&APPC DEREGISTER

&APPC SET_SERVER_MODE