Description

The IXCJOIN macro places a cross-system coupling facility (XCF) member in the active state, associating it with an XCF group. In the active state, the member can use the monitoring and signalling services of XCF. Additionally, IXCJOIN:

Returns a member token. (Each member, regardless of its previous state, receives a new member token.)
Notifies the active group members that have a group user-routine that the joining member is in an active state.

The member might previously have been in the failed, quiesced, not-defined, or created state.

The required parameters ANSAREA and ANSLEN specify the area where XCF returns member information, including a member token.

With the optional parameters USTATE and USLEN, you can place a value in the user state field. The data in the user state field is provided to the group user-routines.

Optional parameters on IXCJOIN allow you to:

Associate the joining member with a task, job step task, or address space (MEMASSOC).
Establish permanent status recording (LASTING=YES).
Specify the address of the message user-routine (MSGEXIT).
Specify the address of the group user-routine (GRPEXIT).
Specify the address of the status user-routine (STATEXIT).
Specify whether cleanup will be performed when a system leaves the sysplex (SYSCLEANUPMEM).

Additional optional parameters on version 1 of IXCJOIN allow you to:

Specify whether the member can participate in a message response collection protocol (CANREPLY).
Specify the address of the message notify user routine (NOTIFYEXIT).
Specify whether the member supports sending or receiving messages greater than 61K bytes in length (up to 128M bytes) (GT61KMSG).

Status monitoring requires a status field (STATFLD) and an interval value (INTERVAL) that sets the status-checking interval. The interval determines how long the status field can remain unchanged before XCF schedules the status user-routine.

For information about the user-routines, see the topic on XCF in z/OS MVS Programming: Sysplex Services Guide.