Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWMAEDEF macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,APPLENV=applenv
- When FUNC=ADD is specified, a required input parameter, which
contains the name of the static or dynamic application environment.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 32-character field.
- CONNTKN=conntkn
- A required input parameter, which contains the connect token
returned by the IWM4CON macro.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 32 bit
field.
- ,DISTRIBUTE_WORK=FIRST_AVAILABLE
- ,DISTRIBUTE_WORK=ROUND_ROBIN
- When FUNC=ADD is specified, an optional parameter that controls
how Workload Management resumes bound server spaces that are waiting
for work The default is DISTRIBUTE_WORK=FIRST_AVAILABLE.
- ,DISTRIBUTE_WORK=FIRST_AVAILABLE
- Workload Management wakes up the server space that has been
suspended first (default).
- ,DISTRIBUTE_WORK=ROUND_ROBIN
- Workload Management wakes up the server space that has the smallest
number of affinities. If there are several server spaces with the
same number of affinities, workload management will start the server
space with the smallest number of active server tasks.
- ,FUNC=ADD
- ,FUNC=DELETE
- ,FUNC=MODIFY
- A required parameter that indicates how the caller uses the
service
- ,FUNC=ADD
- indicates that the caller wants to add a dynamic application
environment to WLM.
- ,FUNC=DELETE
- indicates that the caller wants to delete its interest in the
dynamic application environment.
- ,FUNC=MODIFY
- indicates that the caller wants to redefine the method how server
spaces should be resumed for static and dynamic application environments.
- ,JCLPARMS=jclparms
- ,JCLPARMS=0
- When FUNC=ADD is specified, an optional input parameter, which
contains the parameters which are passed to the start procedure of
the server manager address spaces by WLM. The default is 0.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 115-character field.
- ,JCLPROC=jclproc
- When FUNC=ADD is specified, a required input parameter, which
contains the name of the start procedure which is used by WLM to start
server manager address spaces for the application environment.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
- ,MF=S
- ,MF=(L,list addr)
- ,MF=(L,list addr,attr)
- ,MF=(L,list addr,0D)
- ,MF=(E,list addr)
- ,MF=(E,list addr,COMPLETE)
- An optional input parameter that specifies the macro form.
Use
MF=S to specify the standard form of the macro, which builds an inline
parameter list and generates the macro invocation to transfer control
to the service. MF=S is the default.
Use MF=L to specify the
list form of the macro. Use the list form together with the execute
form of the macro for applications that require reentrant code. The
list form defines an area of storage that the execute form uses to
store the parameters. Only the PLISTVER parameter may be coded with
the list form of the macro.
Use MF=E to specify the execute
form of the macro. Use the execute form together with the list form
of the macro for applications that require reentrant code. The execute
form of the macro stores the parameters into the storage area defined
by the list form, and generates the macro invocation to transfer control
to the service.
- ,list addr
- The name of a storage area to contain the parameters. For MF=S
and MF=E, this can be an RS-type address or an address in register
(1)-(12).
- ,attr
- An optional 1- to 60-character input string that you use to
force boundary alignment of the parameter list. Use a value of 0F
to force the parameter list to a word boundary, or 0D to force the
parameter list to a doubleword boundary. If you do not code attr,
the system provides a value of 0D.
- ,COMPLETE
- Specifies that the system is to check for required parameters
and supply defaults for omitted optional parameters.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- ,PLISTVER=1
- An optional input parameter that specifies the version of the
macro. PLISTVER determines which parameter list the system generates.
PLISTVER is an optional input parameter on all forms of the macro,
including the list form. When using PLISTVER, specify it on all macro
forms used for a request and with the same value on all of the macro
forms. The values are:
- IMPLIED_VERSION, which is the lowest
version that allows all parameters specified on the request to be
processed. If you omit the PLISTVER parameter, IMPLIED_VERSION
is the default.
- MAX, if you want the parameter list to be
the largest size currently possible. This size might grow from release
to release and affect the amount of storage that your program needs.
If
you can tolerate the size change, IBM® recommends
that you always specify PLISTVER=MAX on the list form of the macro.
Specifying MAX ensures that the list-form parameter list is always
long enough to hold all the parameters you might specify on the execute
form, when both are assembled with the same level of the system. In
this way, MAX ensures that the parameter list does not overwrite nearby
storage.
- 0, which supports all parameters except
those specifically referenced in higher versions.
1, which supports the following parameters
and those from version 0:
DISTRIBUTE_WORK
STATIC
To code: Specify one of
the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0, or 1
- ,RETCODE=retcode
- An optional output parameter into which the return code is to
be copied from GPR 15.
To code: Specify the
RS-type address of a fullword field, or register (2)-(12).
- ,RSNCODE=rsncode
- An optional output parameter into which the reason code is to
be copied from GPR 0.
To code: Specify the
RS-type address of a fullword field, or register (2)-(12).
- ,SELECT_POLICY=select_policy
- ,SELECT_POLICY=0
- When FUNC=ADD is specified, an optional input parameter, which
tells WLM how to select work if work requests are directly routed
to the server address space. Only 0,1 and 2 are valid select policies.
0 is the default which is also selected if an invalid policy is specified.
The
select policy options 0,1 and 2 have the following meaning:
- 0 Default, the oldest request on either the service class or
server address space queue is selected first.
- 1 The request on the server address space queue (if present)
is selected first independently of the times the requests have been
inserted.
- 2 The request on the service class queue is always selected first.
The default is 0.
To code: Specify
the RS-type address, or address in register (2)-(12), of an one-byte
field.
- ,SINGLE_SERVER=NO
- ,SINGLE_SERVER=YES
- When FUNC=ADD is specified, an optional parameter indicating
whether one or multiple server spaces should be started for the application
environment The default is SINGLE_SERVER=NO.
- ,SINGLE_SERVER=NO
- Multiple server spaces should be started for the application
environment (default).
- ,SINGLE_SERVER=YES
- Only one server space should be started for the application
environment.
- ,STATIC=NO
- ,STATIC=YES
- When FUNC=MODIFY is specified, an optional parameter that controls
whether a static or dynamic application environment should be updated.
The default is STATIC=NO.
- ,STATIC=NO
- indicates that the caller wants to modify a dynamic application
environment (default).
- ,STATIC=YES
- indicates that the caller wants to modify a static application
environment.
|