public interface RexxExitHandler extends RexxHandler
rexxpg.pdf
documentation.
All final static fields that use ooRexx names also use the ooRexx constant values from
the ooRexx include file rexxapidefs.h
, from which the descriptions and values
got copied from.
------------------------ Apache Version 2.0 license ------------------------- Copyright (C) 2012-2022 Rony G. Flatscher Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -----------------------------------------------------------------------------
Modifier and Type | Field and Description |
---|---|
static java.lang.String[] |
RX_EXIT_NAMES
Names of Rexx system exit function numbers between number 0 and 15.
|
static int |
RXCMD
Process host commands.
|
static int |
RXCMDHST
Calls a named subcommand
handler.
|
static int |
RXENDLST
End of exit list.
|
static int |
RXEXF
scripting function call
|
static int |
RXEXFCAL
Processes calls to external
functions.
|
static int |
RXEXIT_HANDLED
Exit handled exit event
|
static int |
RXEXIT_NOT_HANDLED
Exit passes on exit event
|
static int |
RXEXIT_RAISE_ERROR
Exit handler error occurred
|
static int |
RXFNC
Process external functions.
|
static int |
RXFNCCAL
Processes calls to external
functions.
|
static int |
RXHLT
Halt processing.
|
static int |
RXHLTCLR
Clear HALT indicator
|
static int |
RXHLTTST
Test HALT indicator
|
static int |
RXINI
Initialization processing.
|
static int |
RXINIEXT
Initialization exit.
|
static int |
RXMSQ
Manipulate queue.
|
static int |
RXMSQNAM
Set active queue name
|
static int |
RXMSQPLL
Pull a line from queue
|
static int |
RXMSQPSH
Place a line on queue
|
static int |
RXMSQSIZ
Return num of lines on queue
|
static int |
RXNOOFEXITS
1 + largest exit number.
|
static int |
RXNOVAL
NOVALUE exit
|
static int |
RXNOVALCALL
Processes a Rexx NOVALUE
condition.
|
static int |
RXOFNC
Process external functions
using object values.
|
static int |
RXOFNCCAL
Processes calls to external
functions.
|
static int |
RXSIO
Session I/O.
|
static int |
RXSIODTR
DEBUG read from char stream
|
static int |
RXSIOSAY
SAY a line to STDOUT
|
static int |
RXSIOTLL
Return linelength (n/a OS/2)
|
static int |
RXSIOTRC
Trace output
|
static int |
RXSIOTRD
Read from char stream
|
static int |
RXTER
Termination processing.
|
static int |
RXTEREXT
Termination exit.
|
static int |
RXTRC
Test ext trace indicator.
|
static int |
RXTRCTST
Tests the external trace
indicator.
|
static int |
RXVALUE
VALUE function exit
|
static int |
RXVALUECALL
Processes an extended call
to the VALUE() built-in
function.
|
static java.lang.String |
version
Version string indicating version of this class (majorVersion*100+minorVersion
concatenated with a dot and the sorted date of last change.
|
Modifier and Type | Method and Description |
---|---|
int |
handleExit(java.lang.Object slot,
int exitNumber,
int subFunction,
java.lang.Object[] parmBlock)
Exit handler signature (called via native code) according to the ooRexx API
documentation in
rexxpg.pdf . |
checkCondition, clearCondition, dropContextVariable, getAllContextVariables, getCallerContext, getConditionInfo, getContextVariable, getGlobalEnvironment, getInterpreterVersion, getLanguageLevel, getLocalEnvironment, getNil, haltThread, newArray, newDirectory, newStem, newStringTable, raiseCondition, raiseException, raiseException0, raiseException1, raiseException2, setContextVariable, setContextVariableToNil, setThreadTrace
static final java.lang.String version
static final int RXEXIT_HANDLED
static final int RXEXIT_NOT_HANDLED
static final int RXEXIT_RAISE_ERROR
static final int RXENDLST
static final int RXFNC
static final int RXFNCCAL
static final int RXCMD
static final int RXCMDHST
static final int RXMSQ
static final int RXMSQPLL
static final int RXMSQPSH
static final int RXMSQSIZ
static final int RXMSQNAM
static final int RXSIO
static final int RXSIOSAY
static final int RXSIOTRC
static final int RXSIOTRD
static final int RXSIODTR
static final int RXSIOTLL
static final int RXHLT
static final int RXHLTCLR
static final int RXHLTTST
static final int RXTRC
static final int RXTRCTST
static final int RXINI
static final int RXINIEXT
static final int RXTER
static final int RXTEREXT
static final int RXEXF
static final int RXEXFCAL
static final int RXNOVAL
static final int RXNOVALCALL
static final int RXVALUE
static final int RXVALUECALL
static final int RXOFNC
static final int RXOFNCCAL
static final int RXNOOFEXITS
static final java.lang.String[] RX_EXIT_NAMES
int handleExit(java.lang.Object slot, int exitNumber, int subFunction, java.lang.Object[] parmBlock)
rexxpg.pdf
.
The following documents briefly the parmBlock
-array that gets
supplied to the Java exit handler, depending on the exit number and subfunction.
Please refer also to the ooRexx documentation "rexxpg.pdf", section
entitled "Context Exit Definitions" on which this implementation is
based upon.
Exit name/number | subfunction name/number | Description | |||||
---|---|---|---|---|---|---|---|
RXFNC/2
| RXFNCCAL/1
| Processes calls to external functions.parmBlock :
| |||||
RXCMD/3
| RXCMDHST/1
| Calls a named subcommand handler.parmBlock :
| |||||
RXMSQ/4
| RXMSQPLL/1
| Pulls a line from the external data queue.parmBlock :
| |||||
RXMSQPSH/2
| Places a line in the external data queue.parmBlock :
| ||||||
RXMSQSIZ/3
| Returns the number of lines in the external data queue.parmBlock :
| ||||||
RXMSQNAM/20
| Sets the name of the active external data queue.parmBlock :
| ||||||
RXSIO/5
| RXSIOSAY/1
| Writes a line to the standard output stream.parmBlock :
| |||||
RXSIOTRC/2
| Writes trace and error message output to the standard error stream.
parmBlock :
| ||||||
RXSIOTRD/3
| Reads from standard input stream.parmBlock :
| ||||||
RXSIODTR/4
| Interactive debug input.parmBlock :
| ||||||
RXHLT/7
| RXHLTCLR/1
| Clears the HALT condition.parmBlock :
| |||||
RXHLTTST/2
| Tests the halt indicator.parmBlock :
| ||||||
RXTRC/8
| RXTRCTST/1
| Tests the external trace indicator.parmBlock :
| |||||
RXINI/9
| RXINIEXT/1
| Initializing processing. | |||||
RXTER/10
| RXTEREXT/1
| Termination processing. | |||||
RXEXF/12
| RXEXFCAL/1
| Processes calls to external functions (ooRexx version), at end of search for an external routine.parmBlock :
| |||||
RXNOVAL/13
| RXNOVALCALL/1
| Processes a Rexx NOVALUE condition.parmBlock :
| |||||
RXVALUE/14
| RXVALUECALL/1
| Processes an extended call to the VALUE() built-in function ("BIF")
parmBlock :
| |||||
RXOFNC/15
| RXOFNCCAL/1
| Processes calls to external functions (ooRexx version), at beginning of the search for an external routine.parmBlock :
|
slot
- this is an opaque Object
argument which must be supplied
unchanged to the direct Rexx API methods in RexxHandler
exitNumber
- the Rexx exit numbersubFunction
- the Rexx exit subfunction numberparmBlock
- an Object[]
which is structured according to the ooRexx
exit documentation in rexxpg.pdf
; each structure is itself
contained in an Object[]