 |
- ,ADJUNCT=NO
- ,ADJUNCT=YES
- Use this input parameter to specify whether adjunct data areas
are associated with each list entry in the coupling facility list
structure. Each adjunct data area is 64 bytes.
- NO
- Indicates that there are no adjunct data areas specified for the
list structure.
- YES
- Indicates that each list entry in the list structure has an associated
adjunct data area of 64 bytes.
- ,ELEMCHAR=0
- ,ELEMCHAR=elemchar
- Use this input parameter to specify the value of an element characteristic
used to determine the element size. The element size is calculated
with the formula
 256×(2ELEMCHAR)  ,
where ELEMCHAR is used as the power of 2. For example, if ELEMCHAR=0,
then the size of each element is 256 bytes. The valid values for
ELEMCHAR range from zero to a maximum determined by the coupling facility
model limitation on element size.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
1-byte field that contains the value of the element characteristic,
used to determine the list structure element size. Note: The element
size, in combination with the maximum number of elements (MAXELEMNUM
parameter), determines the size of the data entry — the data
written to and read from the list structure. With a coupling facility
of CFLEVEL=0, a data entry can be up to 16 times the data element
size, as indicated by the element characteristic. With a coupling
facility of CFLEVEL=1 or higher, a data entry can be up to 255 times
the data element size.
Use either ELEMCHAR or ELEMINCRNUM
to define the element size. You can specify either an element characteristic
or an element increment number for element size determination.
- ,ELEMENTRATIO=1
- ,ELEMENTRATIO=elementratio.
- Use this input parameter to specify a value to express the data
element portion of the entry-to-element ratio of the coupling facility
list structure. If ELEMENTRATIO is zero, the list structure is allocated
without data elements. If ELEMENTRATIO is zero, then ADJUNCT must
equal YES.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the 2-byte field that contains
a value to express the element portion of the entry-to-element ratio
of the coupling facility list structure.
- ,ELEMINCRNUM=elemincrnum
- Use this input parameter to specify the element increment number.
The element size is calculated with the formula 256×ELEMINCRNUM .
For example, if ELEMINCRNUM=1, then the size of each element is 256
bytes.
The valid values for ELEMINCRNUM range from 1 to a maximum
determined by the coupling facility model limitation on element size.
The value of ELEMINCRNUM must be a power of 2.
To Code: Specify
the RS-type name or address (using a register from 2 to 12) of the
1-byte field that contains the value of the element increment number,
used to determine the list structure element size. Note: The element
size, in combination with the maximum number of elements (MAXELEMNUM
parameter), determines the size of the data entry — the data
written to and read from the list structure. With a coupling facility
of CFLEVEL=0, a data entry can be up to 16 times the data element
size, as indicated by the element increment number. With a coupling
facility of CFLEVEL=1 or higher, a data entry can be up to 255 times
the data element size.
Use either ELEMCHAR or ELEMINCRNUM
to define the element size. You can specify either an element characteristic
or an element increment number for element size determination.
- ,EMCSTGPCT=0
- ,EMCSTGPCT=emcstgpct
- Use this input parameter to specify the percentage of available
list structure storage that is to be set aside for event monitor controls
(EMCs). The structure must be a keyed list structure (REFOPTION=KEY)
and its allocation must be requested in a coupling facility with CFLEVEL=3
or higher.
Specify the percentage value in hundredths of a percent.
For example, to request a value of 20%, code EMCSTGPCT=2000.
The
value of EMCSTGPCT must be in the range of from 0 to 10000.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the halfword field that contains a value to express the
percentage of available structure storage that is to be set aside
for event monitor controls (EMCs).
- ,ENTRYIDTYPE=SYSTEM
- ,ENTRYIDTYPE=USER
- Use this input parameter to specify whether the system or the
user will assign the list entry IDs for list entries created in this
structure. A list entry can be located by its assigned entry ID. A
connect request will be rejected if the connector's requested ENTRYIDTYPE
attribute does not match the attribute in effect for the currently
allocated instance of the structure. A rebuild connect request will
be rejected if the connector's requested ENTRYIDTYPE attribute does
not match the attribute in effect for the original structure.
- ENTRYIDTYPE=SYSTEM
- The system will assign the list entry IDs for list entries created
in this structure. An entry ID will be generated by the system for
each list entry created, and it will be unique among the list entries
previously and currently allocated in the list structure. A system
generated entry ID is never reused and is unique for the life of
the structure.
- ENTRYIDTYPE=USER
- The user will assign the entry ID for each list entry created
in this structure. An entry ID must be provided by the user for each
list entry created, and it must be unique among the list entries currently
allocated in the list structure. A user-provided entry ID may be reused
over time provided it is unique while assigned to a list entry.
A
CFLEVEL of 8 or higher must also be specified when ENTRYIDTYPE=USER
is specified. Note that an ENTRYIDTYPE=USER request will be rejected
if a coupling facility of CFLEVEL=8 or higher is not available in
which to allocate the structure.
- ,ENTRYRATIO=1
- ,ENTRYRATIO=entryratio
- Use this input parameter to specify a value to express the list
entry portion of the entry-to-element ratio of the coupling facility
list structure.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the 2-byte field that contains
a value to express the list entry portion of the entry-to-element
ratio of the coupling facility list structure.
- ,KEYTYPE=ENTRY
- ,KEYTYPE=SECONDARY
- Use this input parameter to specify whether only entry keys, or
both entry keys and secondary keys may be used when processing or
locating list entries, or when comparing the entry keys of list entries.
- KEYTYPE=ENTRY
- Only entry keys may be used when processing or locating list entries,
or when comparing the entry keys of list entries.
Each list entry
is assigned a 16-byte entry key when it is created. The user may provide
the entry key, specify that the list key value be assigned, or allow
the entry key value to be assigned a default value. The entry key
may be reassigned when the entry is moved. Event monitoring is provided
for keyed sublists.
See the IXLLSTC, IXLLSTE, and IXLLSTM
macros for additional information.
- KEYTYPE=SECONDARY
- Both entry keys and secondary keys may be used when processing
or locating list entries, or when comparing the entry keys of list
entries.
Entry keys are stored in the list entry, whereas secondary
keys are stored in the first 32 bytes of the 64-byte list entry adjunct
area, thus restricting the available user space in the adjunct area
to the second 32 bytes. Note also that the list structure must be
allocated to use list entries with adjunct data. Thus, in addition
to KEYTYPE=SECONDARY, ADJUNCT=YES must also be specified on the IXLCONN
invocation when allocating the structure and when establishing a connection
with the structure.
Each list entry is assigned a 16-byte
entry key and a 32-byte secondary key when it is created. The user
may provide the secondary key or allow the secondary key value to
be assigned a default value. While the entry key can be reassigned
by any of the move requests, the secondary key can be reassigned only
by an IXLLSTM REQUEST=MOVE_ENTRYLIST invocation. Event monitoring
is provided for entry keyed and secondary keyed sublists.
See
the IXLLSTC, IXLLSTC, and IXLLSTM macros for additional information.
ADJUNCT=YES
and a CFLEVEL of 9 or greater must also be specified when KEYTYPE=SECONDARY
is specified.
KEYTYPE=SECONDARY is meaningful only when the
structure is allocated in a coupling facility of CFLEVEL=9 or higher.
- ,LISTCNTLTYPE=ENTRY
- ,LISTCNTLTYPE=ELEMENT
- Use this input parameter to specify whether the system maintains
and tracks list limits based on number of entries or number of elements.
- ENTRY
- Specifies that the list limits are specified and tracked as limits
on the number of entries which may reside on the list.
- ELEMENT
- Specifies that the list limits are specified and tracked as limits
on the total number of data elements which may be associated with
entries on the list.
- ,LISTHEADERS=listheaders
- Use this input parameter to specify the number of lists (list
headers) for the coupling facility list structure. The number must
be greater than zero.
To Code: Specify the RS-type name
or address (using a register from 2 to 12) of the fullword input field
that contains the number of list headers to be allocated.
- ,LISTTRANEXIT=listtranexit
- Use this input parameter to identify the list transition exit
for the requestor.
The list transition exit is used to inform
users when one or more lists or their event queue they are monitoring
changes from the empty state to the non-empty state.
To
Code: Specify the RS-type name or address (using a register from
2 to 12) of the list transition exit for the requestor.
- ,LOCKENTRIES=0
- ,LOCKENTRIES=lockentries
- Use this input parameter to specify the number of lock entries
for the coupling facility list structure. If the value for the number
of lock entries is not a power of 2, it is rounded upward to the nearest
power of 2. If the value is not specified, or if the requestor specifies
zero, then the system does not support serialization for the allocated
list structure.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the fullword field that contains
the number of lock entries for the coupling facility list structure.
- ,MAXCONN=32
- ,MAXCONN=maxconn
-
Use this input parameter to specify the maximum number of
users that can connect and use the list structure. The actual number
of connections that the structure supports is returned in the Connect
Answer Area field CONACFACILITYUSERLIMIT .
When
the requested MAXCONN attribute value for maxconn is
in the range 0 to 32, the value is 32.
To allocate a list
structure that can support more than 32 connectors, use the MAXCONN
keyword as follows: - Ensure that the MAXCONN keyword is used by all connectors to the
structure.
- Ensure that the structure is allocated in a coupling facility
with CFLEVEL=17 or higher.
Specifying the MAXCONN keyword with any value indicates
that the connection can support a user-id limit change that results
from a system-managed process (for example, rebuild). XCF communicates
the user-id limit change through the structure state change event.
Specifying the MAXCONN keyword with a value greater than 32 indicates
that the connector can understand events for subject connections
with connection identifiers up to the value specified (for example, EEPLEXISTINGCONNECTION or EEPLNEWCONNECTION ).
XCF
rejects a MAXCONN connect request for the following reasons: - If the requested MAXCONN attribute value of the connector is lower
than the highest in-use connection id of an existing connector to
the specified structure.
- If the available connection identifier of the connector is greater
than the smallest NUMUSERS or MAXCONN value that existing connections
have specified
XCF rejects a rebuild MAXCONN connect request
if the requested MAXCONN attribute value of the connector is lower
than the number of in-use connections to the old structure instance.
When
you migrate applications to use greater than 32 connectors support
in a rolling fashion, the application or installation can take the
following steps to avoid failed connection attempts: - Ensure that applications have internal structures coded to accept
events for connection identifiers up to the planned value that is
to be used on the MAXCONN keyword.
- Ensure that all instances of the application are updated to use
the MAXCONN keyword. When all instances of the application have been
upgraded to a level that specifies MAXCONN, the structure is eligible
to accommodate more than 32 instances of the application.
- Ensure that the structure is reallocated in order to take advantage
of greater than 32 connectors in a CFLEVEL 17 coupling facility. You
can accomplish this through the rebuild process.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of the 1-byte field that contains the maximum
number of users of the coupling facility lock structure.
- ,MAXELEMNUM=16
- ,MAXELEMNUM=maxelemnum
- Use this input parameter to specify a value to determine the maximum
number of elements for each list entry in the coupling facility list
structure.
- With a coupling facility of CFLEVEL=0 or higher, you can specify
from 1 to 16 for MAXELEMNUM.
- With a coupling facility of CFLEVEL=1 or higher, you can specify
from 1 to 255 for MAXELEMNUM.
To Code: Specify the RS-type name or address (using
a register from 2 to 12) of the 1-byte field that contains a value
to determine the maximum number of elements for each list entry in
the coupling facility list structure.
- ,NOTIFYEXIT=notifyexit
- Use this input parameter to identify the notify exit for the requestor.
The notify exit is used to inform a list services (IXLLIST, IXLLSTC,
IXLLSTE, IXLLSTM) user that contention exists for a lock held by
the user.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the notify exit for the requestor.
- ,REFOPTION=NOKEYNAME
- ,REFOPTION=KEY
- ,REFOPTION=NAME
- Use this input parameter to specify how to reference list entries
in the coupling facility list structure. The requestor can specify
one of the following:
- NOKEYNAME
- Indicates that the list entry can be located by the list entry
identifier (LEID). The system assigns an LEID for each list entry
that is in use in the coupling facility list structure. Neither keys
nor names are used to reference list entries.
- KEY
- Indicates that the list entry can be located by a key value. When
creating the entry, the requestor can assign a key value to one or
more list entries on the macro.
- NAME
- Indicates that the list entry can be located by a unique name.
When creating the entry, the requestor can assign a unique name to
each list entry on the list services (IXLLIST, IXLLSTC, IXLLSTE, IXLLSTM)
macro.
- ,VECTORLEN=0
- ,VECTORLEN=vectorlen.
- Use this input parameter to specify the number of vector entries
in the vector that is to be used to monitor state transitions for
list headers or the event queue. A list header or an event queue undergoes
a state transition when it changes from an empty to nonempty state,
or from a nonempty to an empty state.
The value of VECTORLEN must
be a multiple of 32 or the system will round the value up to a multiple
of 32.
To Code: Specify the RS-type name or address
(using a register from 2 to 12) of the fullword field that contains
the number of vector entries in the vector that is to be used to monitor
state transitions for list headers or the event queue.
|
z/OS MVS Programming: Sysplex Services Reference
Copyright IBM Corporation 1990, 2014