The Link3270 bridge message header prefixes all input and output messages. Some fields are meaningful only on input, and some are meaningful only on output. Some input fields are modified. Table 11 shows the fields that you need to define for input, and Table 12 shows the fields that are relevant in an output message. Inbound BRIH message header describes the values of fields used for input. Outbound BRIH message header describes the values of fields used for output.
Offset Hex |
Type |
Len |
Name |
Default |
---|---|---|---|---|
(0) |
STRUCTURE |
180 |
BRIH |
|
(0) |
CHARACTER |
4 |
BRIH-STRUCID |
BRIH-STRUC-ID |
(4) |
FULLWORD |
4 |
BRIH-VERSION |
BRIH-CURRENT-VERSION |
(8) |
FULLWORD |
4 |
BRIH-STRUCLENGTH |
BRIH-CURRENT-LENGTH |
(C) |
n/a |
36 |
reserved |
|
(30) |
FULLWORD |
4 |
BRIH-GETWAITINTERVAL |
BRIHGWI-MAXWAIT |
(34) |
n/a |
4 |
reserved |
|
(38) |
FULLWORD |
4 |
BRIH-DATALENGTH |
BRIH-CURRENT-LENGTH |
(3C) |
FULLWORD |
4 |
BRIH-FACILITYKEEPTIME |
BRIHKT-DEFAULT |
(40) |
FULLWORD |
4 |
BRIH-ADSDESCRIPTOR |
BRIHADSD-YES |
(44) |
FULLWORD |
4 |
BRIH-CONVERSATIONALTASK |
BRIHCT-NO |
(48) |
n/a |
4 |
reserved |
|
(4C) |
CHARACTER |
8 |
BRIH-FACILITY |
BRIHFACT-NEW |
(54) |
n/a |
40 |
reserved |
|
(7C) |
CHARACTER |
4 |
BRIH-TRANSACTIONID |
|
(80) |
CHARACTER |
4 |
BRIH-FACILITYLIKE |
BRIHFACL-DEFAULT |
(84) |
CHARACTER |
4 |
BRIH-ATTENTIONID |
DFHENTER |
(88) |
CHARACTER |
4 |
BRIH-STARTCODE |
BRIHSC-TERMINPUT |
(8C) |
CHARACTER |
4 |
BRIH-CANCELCODE |
blanks |
(90) |
n/a |
4 |
reserved |
|
(94) |
CHARACTER |
8 |
BRIH-NETNAME |
BRIHNN-DEFAULT |
(9C) |
CHARACTER |
4 |
BRIH-TERMINAL |
BRIHTN-DEFAULT |
(A0) |
n/a |
4 |
reserved |
|
(A4) |
FULLWORD |
4 |
BRIH-CURSORPOSITION |
BRIHCP-DEFAULT |
(A8) |
n/a |
12 |
reserved |
The following fields are used in an input message. You can supply values in these fields, other fields are ignored on input. A BRIH structure primed with input default values (BRIH-DEFAULT) is supplied in the DFHBRICx copybooks. If a default value is not specified, the field is initialized to nulls.
Fields are valid on all calls, except where indicated. See also Using Link3270 single transaction mode and Using Link3270 session mode.
The default is BRIHFACT-NEW.
The name of an installed terminal that is to be used as a model for the bridge facility. If no value is supplied in single-transaction mode, and a FACILITYLIKE value has been specified in the PROFILE definition of the user transaction, this value is used. Otherwise, or if no value is specified in session mode, a CICS-supplied definition, CBRF, is used.
The default BRIHFACL-DEFAULT means that no value is specified.
The NETNAME to be assigned to the bridge facility.
The default value, BRIHNN-DEFAULT, causes CICS® to generate a name. The name is subject to change or rejection by the autoinstall URM whether specified by the user or generated by CICS. The name, as modified, is returned in this field in the response from the Link3270 bridge.
If you are specifying your own BRIH-NETNAME, the valid character set is the same as that for the NETNAME attribute of the CICS TERMINAL definition. See the CICS Resource Definition Guide.
The TERMID to be assigned to the bridge facility.
The default value, BRIHTN-DEFAULT, causes CICS to generate a name. The name is subject to change or rejection by the autoinstall URM whether specified by the user or generated by CICS. The name, as modified, is returned in this field in the response from the Link3270 bridge.
If you are specifying your own BRIH-TERMINAL, the valid character set is the same as that for the TERMINAL attribute of the CICS TERMINAL definition. See the CICS Resource Definition Guide.
If you plan to specify your own BRIH-TERMINAL and to allow BRIH-NETNAME to default to this, you must use the BRIH-NETNAME character set, which is more restricted.
The length of time that the bridge facility is kept after the user transaction has ended (in seconds). The value used is the smaller of this value, and the value specified in the router region's SIT parameter BRMAXKEEPTIME.
The default is BRIHKT-DEFAULT.
An indicator specifying what the Link3270 bridge should do if the user transaction issues an input command for which no input vector has been provided. Possible values are:
The default is BRIHCT-NO.
The maximum wait interval for message input (in milliseconds). The value used is the smaller of the BRIH-GETWAITINTERVAL and the RTIMEOUT value for the transaction.
This value is used only when BRIH-CONVERSATIONALTASK is BRIHCT-YES
The default is BRIHGWI-MAXWAIT.
The abend code with which the Link3270 bridge is to terminate a user transaction. This value is meaningful only in CONTINUE-CONVERSATION messages. If it is non-blank, Link3270 l abends the suspended user transaction with an abend code of BRIH-CANCELCODE. It should be used only when the client wants to terminate the transaction rather than supply the requested vector.
An indicator specifying whether ADS descriptors are sent on outbound SEND MAP and RECEIVE MAP messages. Possible values are:
The default is BRIHADSD-YES.
The initial value of the AID key (EIBAID) when the user transaction is started. This is a 1-byte value, left justified. EIBAID is reset after each RECEIVE, RECEIVE, or CONVERSE command from the AID value in the input vector
The default is DFHENTER (The enter key).
An indicator available to the first transaction in a session to show the type of start that the request is emulating. The value generated depends on whether there is a RETRIEVE vector present in the input. Possible values are:
The default is BRIHSC-TERMINPUT.
The initial cursor position, EIBCPOSN, when the transaction is started. EIBCPOSN is reset from the value in the input vector after every RECEIVE, RECEIVE MAP or CONVERSE command.
The default is BRIHCP-DEFAULT, the top left of the screen.
Offset Hex |
Type |
Len |
Name |
---|---|---|---|
(0) |
STRUCTURE |
180 |
BRIH |
(0) |
CHARACTER |
4 |
BRIH-STRUCID |
(4) |
FULLWORD |
4 |
BRIH-VERSION |
(8) |
FULLWORD |
4 |
BRIH-STRUCLENGTH |
(C) |
n/a |
20 |
reserved |
(20) |
BINARY |
4 |
BRIH-RETURNCODE |
(24) |
BINARY |
4 |
BRIH-COMPCODE |
(28) |
BINARY |
4 |
BRIH-REASON |
(2C) |
n/a |
8 |
reserved |
(34) |
BINARY |
4 |
BRIH-REMAININGDATALENGTH |
(38) |
FULLWORD |
4 |
BRIH-DATALENGTH |
(3C) |
n/a |
12 |
reserved |
(48) |
FULLWORD |
4 |
BRIH-TASKENDSTATUS |
(4C) |
CHARACTER |
8 |
BRIH-FACILITY |
(54) |
CHARACTER |
4 |
BRIH-FUNCTION |
(58) |
CHARACTER |
4 |
BRIH-ABENDCODE |
(5C) |
CHARACTER |
4 |
BRIH-SYSID1 |
(60) |
n/a |
28 |
reserved |
(7C) |
CHARACTER |
4 |
BRIH-TRANSACTIONID |
(80) |
n/a |
16 |
reserved |
(90) |
CHARACTER |
4 |
BRIH-NEXTTRANSACTIONID |
(94) |
CHARACTER |
8 |
BRIH-NETNAME |
(9C) |
CHARACTER |
4 |
BRIH-TERMINAL |
(A0) |
FULLWORD |
8 |
BRIH-NEXTTRANIDSOURCE |
(A8) |
FULLWORD |
4 |
BRIH-ERROROFFSET |
(AC) |
FULLWORD |
4 |
BRIH-SEQNO |
(B0) |
n/a |
4 |
reserved |
The following fields are returned in an output message. Other fields are not relevant.
The length of the remaining message if the COMMAREA is too small to return the complete outbound message. The remaining message is prefixed by another BRIH (included in the length). If there is no more data , this field is set to zero. See Delivering large messages for information about processing large messages.
Transaction abends are indicated by the return code BRIHAC-APPLICATION-ABEND. See BRIH-RETURNCODE values for details.
The NETNAME assigned to the bridge facility.
The TERMID assigned to the bridge facility.
A sequence number returned on every message. The sequence number is set to 0 on an allocate facility request and incremented on subsequent requests. The exceptions to this are: