Table Of Contents
Data Structures (Assembler Language)
Generating Dummy Control Sections
Assembler Language Definitions
APCB - Application Program Control Block
TEM - Transport Endpoint Error Message
TIB - Transport Service Information Block
TPA - Transport Protocol Address
TPL - Transport Service Parameter List
TPO - Transport Protocol Options
TSW - Transport Endpoint State Word
TUB - Transport Endpoint User Block
TXL - Transport Endpoint Exit List
TXP - Transport Endpoint Exit Parameters
Data Structures (Assembler Language)
This appendix includes the data structures provided by the application program as arguments of Cisco IOS for S/390 transport service functions or generated by the API and referenced by the application program. It defines the API data structures as used by application programs written in assembler language. Read the Cisco IOS for S/390 C/Socket API Programmer's Reference for definitions of the same data structures as used by application programs written in C language. This appendix includes these sections:
•
Generating Dummy Control Sections
Describes the standard and alternate methods for generating dummy control sections (dsects).
•
Assembler Language Definitions
Includes the assembler language definition dsect code as used by application programs written in assembler language.
Generating Dummy Control Sections
Most dummy control sections (dsects) listed in this appendix can be generated with the TDSECT macro instruction, described in .
Data Structure Names
The data structure name of each dsect to be generated must be included in the macro instruction's operand list. For each API data structure listed in this table, a standard and alternate method for generating the dsect is given:
Assembler Language Definitions
This section includes this assembler language definition dsect code:
•
Application Program Control Block (APCB)
•
APCB exit list
•
Transport Endpoint Error Message (TEM)
•
Transport Service Information Block (TIB)
•
Transport Protocol Address (TPA)
•
Transport Service Parameter List (TPL)
•
Transport Protocol Options (TPO)
•
Transport Endpoint State Word (TSW)
•
Transport Endpoint User Block (TUB)
•
Transport Endpoint Exit List (TXL)
•
Transport Endpoint Exit Parameters (TXP)
APCB - Application Program Control Block
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*THE APPLICATION PROGRAM CONTROL BLOCK (APCB). THE APCB*CONTAINS INFORMATION ASSOCIATED WITH THE APPLICATION*PROGRAM AND IS USED TO MAINTAIN A SESSION WITH THE API*SUBSYSTEM. THE ADDRESS OF THE APCB IS INCLUDED IN THE*OPERAND FIELD OF AN AOPEN OR ACLOSE MACRO INSTRUCTION.APCB DSECT APPLICATION PROGRAM CONTROL BLOCKAPCBTAG DS CL4 CONTROL BLOCK IDAPCBSL DS F CONTROL BLOCK LENGTHAPCBAM DS X ACCESS METHOD AND VERSIONAPCBAMSK EQU B'11110000' ACCESS METHOD IDAPCBATLI EQU 1 TRANSPORT LAYER INTERFACEAPCBAMAX EQU APCBATLI MAXIMUM ACCESS METHOD IDAPCBAVER EQU B'00001111' ACCESS METHOD VERSIONAPCBFLAG DS X FLAG BYTEAPCBFSTP EQU B'10000000' APPLID IS STEPNAME FROM TIOTAPCBF31B EQU B'01000000' AMODE=31APCBFANY EQU B'00100000' RMODE=ANYAPCBFOPN EQU B'00010000' APCB IS OPENAPCBFERR EQU B'00001000' PERMANENT ERROR FLAGAPCBFTRM EQU B'00000100' TASK TERMINATION IN PROGRESSAPCBFECB EQU B'00000010' ECB EVENT NOTIFY BLOCKAPCBFBSY EQU B'00000001' OPEN/CLOSE IN PROGRESSAPCBOPTC DS X OPTION CODEAPCBOTRC EQU B'10000000' OPTCD=NOTRACE|TRACEAPCBOGTF EQU B'01000000' OPTCD=NOGTF|GTFAPCBABRT EQU B'00100000' OPTCD=ABORTAPCBAUTH EQU B'00010000' OPTCD=AUTHEXIT* EQU B'00001000' RESERVED* EQU B'00000100' RESERVED* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDDS X RESERVEDAPBCENVR DS X LANGUAGE ENVIRONMENT CODEAPCBASM EQU 0 ASSEMBLER LANGUAGEAPCBIBMC EQU 1 IBM CAPCBSASC EQU 2 SAS CAPCBPLI EQU 3 PLIAPCBCOBL EQU 4 COBOLAPCBFORT EQU 5 FORTRANAPCBEMAX EQU APCBFORT MAXIMUM ENVIRONMENT CODEAPCBERRC DS X ERROR CODEAPCBECFG EQU 1 SUBSYSTEM NOT CONFIGUREDAPCBEACT EQU 2 SUBSYSTEM NOT ACTIVEAPCBERDY EQU 3 SUBSYSTEM NOT INITIALIZEDAPCBESTP EQU 4 SUBSYSTEM IS STOPPINGAPCBEDRA EQU 5 SUBSYSTEM IS DRAININGAPCBEVCK EQU 6 APCB VALIDITY CHECK ERRORAPCBELER EQU 7 INTERNAL LOGIC ERRORAPCBEPRB EQU 8 NOT ISSUED FROM PRBAPCBEOPN EQU 9 APCB ALREADY OPENEDAPCBECLS EQU 10 APCB ALREADY CLOSEDAPCBEBSY EQU 11 APCB IS BUSY WITH AOPEN/ACLOSEAPCBEPER EQU 12 APCB HAS PERMANENT ERRORAPCBECVT EQU 13 ACCESS METHOD CVT NOT AVAILABLEAPCBEMEM EQU 14 INSUFFICIENT MEMORY AVAILABLEAPCBEENV EQU 15 CANNOT INITIAL./TERMIN. ENVIR.APCBEBEG EQU 16 CANNOT ESTABLISH API SESSIONAPCBEVER EQU 17 INVALID ACCESS METHOD VERSIONAPCBEOPT EQU 18 INVALID/UNSUPPORTED OPTIONAPCBEDUP EQU 19 DUPLICATE SESSION FOR THIS AMAPCBEAMD EQU 20 AMODE INCONSISTENT WITH AOPENAPCBETRV EQU 21 AMTV VALIDITY CHECK ERRORAPCBEEND EQU 22 CANNOT RELEASE API SESSIONAPCBDGNC DS XL2 DIAGNOSTIC CODEAPCBAMCB DS A ACCESS METHOD CONTROL BLOCKAPCBAMCV DS A ACCESS METHOD COMMUNICATION VECTORAPCBAMTV DS A ACCESS METHOD UAS TRANSFER VECTORAPCBAMID DS CL4 ACCESS METHOD SUBSYSTEM IDDS F RESERVEDAPCBEXLS DS A APPLIC.-LEVEL EXIT LIST ADDRESSAPCBACTX DS F APPLIC.-LEVEL CONTEXT VARIABLEAPCBECTX DS F ENVIRO.-LEVEL CONTEXT VARIABLEAPCBAPPL DS CL8 APPLICATION IDAPCBPSWD DS CL8 APPLICATION PASSWORDAPCBLEN EQU *-APCB LENGTH OF APCBAPCBXL - APCB Exit List
*THE FOLLOWING DSECT DEFINES THE AM-INDEPENDENT STRUCTURE*OF AN APCB EXIT LIST. IT IS NECESSARY TO DEFINE THIS*STRUCTURE AT THIS LEVEL SO AOPEN CAN VALIDITY CHECK THE*EXIT LIST.APCBXL DSECT COMMON EXIT LIST FORMATAPCBXLEN DS F TOTAL LENGTH OF EXIT LISTAPCBXLST DS 0A LIST OF EXIT ROUTINE ENTRY POINTSTEM - Transport Endpoint Error Message
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*AN ERROR MESSAGE RETURNED BY THE TERROR MACRO INSTRUCTION.*THE INFORMATION RETURNED IS FORMATTED AS A MULTI-LINE WTO*PARAMETER LIST (WTO MF=L), AND CAN BE SUPPLIED DIRECTLY*TO A WTO MF=E MACRO INSTRUCTION. THE APPLICATION PROGRAM*MAY USE THIS DSECT TO MANIPULATE CERTAIN FIELDS WITHIN THE*PARAMETER LIST.TEM DSECT TRANSPORT ENDPOINT ERROR MESSAGETEMTAG DS CL4 CONTROL BLOCK IDENTIFIERTEMSL DS F SUBPOOL AND LENGTHTEMWTO DS 0F WTO PARAMETER LISTTEMSGLEN DS AL2 MESSAGE LENGTH + 4 (FIRST LINE)TEMMCSF1 DS X MCS FLAG BYTE #1TEMMCSF2 DS X MCS FLAG BYTE #2TEMSGTXT DS CL34 MESSAGE TEXT (FIRST LINE)ORG TEMSGTXTTEMSGID DS CL8 MESSAGE IDTEMSGBDY DS CL26 MESSAGE BODYORGTEMDESC DS BL.16 DESCRIPTOR CODESTEMROUT DS BL.16 ROUTING CODESTEMSGTYP DS XL2 MLWTO LINE TYPE (FIRST LINE)TEMAREA DS X MLWTO AREA IDTEMNLINE DS AL1 MLWTO NUMBER OF LINESTEMMLLEN DS AL2 MLWTO LINE LENGTH + 4TEMMLTYP DS XL2 MLWTO LINE TYPETEMMLTXT DS (*-*)C MLWTO LINE TEXTTEMLEN EQU *-TEM MINIMUM LENGTH OF MULTI-LINE TEMTIB - Transport Service Information Block
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*TRANSPORT INFORMATION RETURNED BY THE TINFO (OPTCD=PRIMARY)*TRANSPORT SERVICE FUNCTION. THE FORMAT OF THIS INFORMATION*IS STANDARD FOR ALL TRANSPORT PROVIDERS, AND IS INTENDED TO*CONVEY THE BASIC CHARACTERISTICS OF THE UNDERLYING PROTOCOL*AND SERVICE.TIB DSECT TRANSPORT SERVICE INFORMATION BLOCKTIBTSDOM DS X TRANSPORT SERVICE DOMAINTIBDINET EQU 2 DARPA INTERNETTIBDACP EQU 4 ACP ONLY APITIBTSTYP DS X TRANSPORT SERVICE TYPETIBTCOTS EQU 1 CONNECTION-MODE SERVICETIBTCLTS EQU 2 CONNECTIONLESS-MODE SERVICETIBTRAW EQU 3 RAW MODE SERVICETIBTSCHR DS X TRANSPORT SERVICE CHARACTERISTICS* EQU B'10000000' RESERVED* EQU B'01000000' RESERVED* EQU B'00100000' RESERVEDTIBCTSDU EQU B'00010000' TSDU BOUNDARIES PRESERVEDTIBCXPDT EQU B'00001000' EXPEDITED DATA SUPPORTEDTIBCOPTN EQU B'00000100' USER-SETTABLE OPTS SUPPORTEDTIBCCOND EQU B'00000010' CONNECT USER DATA SUPPORTEDTIBCDISD EQU B'00000001' DISCONNECT USER DATA SUPPORTEDTIBTSOPT DS X TRANSPORT SERVICE OPTIONSTIBOASSO EQU B'10000000' CLTS ASSOCIATIONS SUPPORTEDTIBOSCND EQU B'01000000' SECONDARY INFO. AVAILABLETIBOSTAT EQU B'00100000' STATISTICAL INFO. AVAILABLETIBORLSE EQU B'00010000' COTS ORDERLY RELEASE SUPPORTED* EQU B'00001000' RESERVED* EQU B'00000100' RESERVED* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTIBSYSID DS CL4 TRANSPORT PROVIDER'S SUBSYS. NAMETIBSVCID DS CL8 TRANSPORT PROVIDER'S SERVICE NAMETIBPROTO DS F TRANSPORT PROTOCOL NUMBERTIBQLSTN DS F MAXIMUM SIZE OF LISTEN QUEUETIBQSEND DS F MAXIMUM SIZE OF SEND QUEUETIBQRECV DS F MAXIMUM SIZE OF RECEIVE QUEUETIBLTSND DS F MAXIMUM SIZE OF TSEND/TSENDTO DATATIBLTRCV DS F MAXIMUM SIZE OF TRECV/TRECVFR DATATIBLSEND DS F MAXIMUM SIZE OF SEND BUFFERTIBLRECV DS F MAXIMUM SIZE OF RECEIVE BUFFERTIBLADDR DS F MAXIMUM SIZE OF PROTOCOL ADDRESSTIBLOPTN DS F MAXIMUM SIZE OF PROTOCOL OPTIONSTIBLTSDU DS F MAXIMUM SIZE OF TRANSP. DATA UNITTIBLXPDT DS F MAXIMUM SIZE OF EXPED. DATA UNITTIBLCONN DS F MAXIMUM SIZE OF CONNECT DATATIBLDISC DS F MAXIMUM SIZE OF DISCONNECT DATATIBLINFO DS F MAXIMUM SIZE OF INFORMATION UNITTIBLEN EQU *-TIB LENGTH OF TIBTPA - Transport Protocol Address
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT*OF A TRANSPORT PROTOCOL ADDRESS IN THE INTERNET DOMAIN.*THIS INFORMATION IS TRANSPORT PROVIDER-DEPENDENT AND*IS NOT INTERPRETED BY API**THE GENERAL FORMAT OF A TRANSPORT PROTOCOL ADDRESS IS:**<DOMAIN><T-ADDR><N-ADDR>**WHERE:**DOMAIN = COMMUNICATION DOMAIN (SEE TOPEN)*T-ADDR = TRANSPORT LAYER ADDRESS OF ENDPOINT*N-ADDR = NETWORK LAYER ADDRESS OF TRANSPORT PROVIDERTPA DSECT TRANSPORT PROTOCOL ADDRESSTPAINET DS XL8 DOMAIN=INET TPAORG TPAINETTPAINETD DS XL2 INTERNET DOMAINTPAINETT DS XL2 TCP PORT NUMBERTPAINETN DS XL4 IP HOST ADDRESSORGLTPAINET EQU *-TPAINET LENGTH OF INET TPATPL - Transport Service Parameter List
*THE FOLLOWING DSECT DEFINES THE STRUCTURE OF THE TRANSPORT*SERVICE PARAMETER LIST (TPL) FOR ALL TRANSPORT SERVICE*FUNCTIONS. THE TPL BEGINS WITH A COMMON SECTION (I.E., THE*PARAMETER LIST PREFIX) WHICH IS PRESENT FOR ALL FUNCTIONS.TPL DSECT TRANSPORT SERVICE PARAMETER LISTTPLIDENT DS X CONTROL BLOCK IDTPLIDSTD EQU 234 STANDARD (LONG) FORMAT IDTPLIDSHT EQU 235 SHORT FORMAT IDTPLIDEXT EQU 236 EXTENDED FORMAT IDTPLFNCCD DSX FUNCTION CODETFORG1 EQU 0 ORIGIN FOR STANDARD FUNCTIONSTFACCEPT EQU 1 ACCEPT CONNECTION REQUESTTFADDR EQU 2 ENABLE CONNECTIONSTFBIND EQU 3 BIND PROTOCOL ADDRESSTFCLEAR EQU 4 ACKNOWLEDGE DISCONNECTTFCLOSE EQU 5 CLOSE ENDPOINTTFCONFRM EQU 6 CONFIRM CONNECTION REQUESTTFCONNCT EQU 7 INITIATE CONNECTION REQUESTTFDISCON EQU 8 INITIATE DISCONNECTTFINFO EQU 9 GET TRANSPORT INFORMATIONTFLISTEN EQU 10 LISTEN FOR CONNECTION REQUESTSTFOPEN EQU 11 OPEN ENDPOINTTFOPTION EQU 12 NEGOTIATE OPTIONSTFRECV EQU 13 RECEIVE FROM CONNECTIONTFRECVER EQU 14 RECEIVE DATAGRAM ERRORTFRECVFR EQU 15 RECEIVE DATAGRAMTFREJECT EQU 16 REJECT CONNECTION REQUESTTFRELACK EQU 17 ACKNOWLEDGE CONNECTION RELEASETFRELESE EQU 18 INITIATE CONNECTION RELEASETFRETRCT EQU 19 RETRACT PENDING LISTENTFSEND EQU 20 SEND TO CONNECTIONTFSENDTO EQU 21 SEND DATAGRAMTFUNBIND EQU 22 UNBIND PROTOCOL ADDRESSTFUSER EQU 23 ASSOCIATE USER IDTFMAX1 EQU TFUSER MAXIMUM FUNCTION IDTFORG2 EQU 127 ORIGIN FOR CONTROL FUNCTIONSTFERRORV EQU 128 FORMAT ERROR MESSAGE VERBATIMTFCHECK EQU 129 CHECK TPL FOR COMPLETIONTFERROR EQU 130 FORMAT ERROR MESSAGETFSTATE EQU 131 GET ENDPOINT STATETFMAX2 EQU TFSTATE MAXIMUM FUNCTION IDTPLACTIV DS X SEMAPHORE (TPL ACTIVE)TPLFLAGS DS X FLAG BYTETPLFCMPL EQU B'10000000' TPL COMPLETEDTPLFCERR EQU B'01000000' COMPLETED WITH ERRORTPLFXECB EQU B'00100000' TPLECBXR IS EXTERNAL ECBTPLFEXIT EQU B'00010000' TPLECBXR IS EXIT ROUTINETPLF31B EQU B'00001000' REQUEST ISSUED WITH AMODE=31TPLFACPT EQU B'00000100' ACCEPTING CONNECT INDICATION* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTPLEP DS F ENDPOINTORG*-4TPLEPID DS 0F ENDPOINT IDTPLTCEP DS 0A TCEP ADDRESSORG*+4TPLECBXR DS A IECB/XECB/EXITORG*-4TPLECB DS 0F ECB PARAMETERTPLIECB DS 0F INTERNAL ECBTPLXECB DS 0A EXTERNAL ECB ADDRESSTPLEXIT DS 0A EXIT ROUTINE ADDRESSORG*+4TPLOPTCD DS F OPTION CODESORG TPLOPTCDTPLOPCD1 DS X OPTION CODE #1TOASYNC EQU B'10000000' OPTCD=SYNC|ASYNCTOSHORT EQU B'01000000' OPTCD=LONG|SHORTTOTRUNC EQU B'00100000' OPTCD=NOTRUNC|TRUNCTONEGOT EQU B'00010000' OPTCD=NONEGOT|NEGOTTOMBUF EQU B'00001000' OPTCD=NOMBUF|MBUFTONOBLOK EQU B'00000100' OPTCD=BLOCK|NOBLOCKTOEXTEND EQU B'00000010' OPTCD=EXTEND* EQU B'00000001' RESERVEDTPLOPCD2 DS X OPTION CODE #2TOMORE EQU B'10000000' OPTCD=NOMORE|MORETOEXPDTE EQU B'01000000' OPTCD=NORMAL|EXPEDITETONOTEOM EQU B'00100000' OPTCD=EOM|NOTEOMTOABORT EQU B'00010000' OPTCD=CLEAR|ABORTTOINDIR EQU B'00001000' OPTCD=DIRECT|INDIR* EQU B'00000100' RESERVEDTOFULL EQU B'00000010' OPTCD=NOFULL|FULLTOTIME EQU B'00000001' OPTCD=NOTIME|TIMETPLOPCD3 DS X OPTION CODE #3TOACEE EQU B'10000000' OPTCD=TUB|ACEETOCIPHER EQU B'01000000' OPTCD=PLAIN|CIPHERTOOLD EQU B'00100000' OPTCD=NEW|OLDTOASSIGN EQU B'00010000' OPTCD=USE|ASSIGNTOREMOTE EQU B'00001000' OPTCD=LOCAL|REMOTETOPASS EQU B'00000100' OPTCD=DELETE|PASS* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTPLOPCD4 DS X OPTION CODE #4TOINFO EQU B'11000000' TINFO OPTION CODESTOPRIMRY EQU 0 OPTCD=PRIMARYTOSCNDRY EQU 1 OPTCD=SECNDRYTOSTATS EQU 2 OPTCD=STATSTOOPTION EQU B'00110000' TOPTION OPTION CODESTODECLAR EQU 0 OPTCD=DECLARETOVERIFY EQU 1 OPTCD=VERIFYTOQUERY EQU 2 OPTCD=QUERYTODFAULT EQU 3 OPTCD=DEFAULTTOAPI EQU B'00001000' OPTCD=TP|API* EQU B'00000100' RESERVED* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTPLRTNCD DS F COMPOSITE RETURN CODEORG TPLRTNCDTPLACTCD DS X RECOVERY ACTION CODETAOKAY EQU 0 SUCCESSFUL COMPLETIONTAEXCPTN EQU 4 EXCEPTIONAL CONDITIONTAINTEG EQU 8 CONNECTION/DATA INTEG. ERRORTAENVIRO EQU 12 ENVIRONMENTAL CONDITIONTAFORMAT EQU 16 FORMAT OR SPECIF. ERRORSTAPROCED EQU 20 SEQUENCE AND PROCED. ERRORSTATPLERR EQU 24 LOGIC ERRORS W/NO TPL RTNCDTAUSER EQU 28 USER-DEFINED ACTION CODESTPLERRCD DS X SPECIFIC ERROR CODETCOKAY EQU B'00000000' 00: NO CONDITIONALSTCVERIFY EQU B'10000000' 00: OPTIONS DID NOT VERIFYTCNEGOT EQU B'01000000' 00: OPTIONS NEGOTIATEDTCTRUNC EQU B'00100000' 00: BUFFER TRUNCATEDTCSTOP EQU B'00001000' 00: SUBSYSTEM STOPPINGTCTIME EQU B'00000100' 00: TIMEOUT EXPIREDTENONEGO EQU 6 04: NO NEGOTIATION ALLOWEDTENOBLOK EQU 9 04: NO BLOCKING ALLOWEDTENOLSTN EQU 10 04: NO LISTEN PENDINGTEPROTO EQU 1 08: PROTOCOL ERRORTEOVRFLO EQU 2 08: BUFFER OVERFLOWTEDISCON EQU 3 08: DISCONNECT RECEIVEDTERELESE EQU 4 08: ORDERLY RELEASE RCVD.TEOVLAY EQU 5 08: CONTROL BLOCK OVERLAIDTEFLOW EQU 9 08: TEMPORARY FLOW CONTROLTERETRCT EQU 10 08: LISTEN RETRACTEDTEPURGED EQU 11 08: PURGED BY TCLOSETESYSERR EQU 1 12: SYSTEM ERRORTESUBSYS EQU 2 12: SUBSYSTEM ERRORTENOTCNF EQU 3 12: SUBSYS NOT INSTALLEDTENOTACT EQU 4 12: SUBSYS NOT ACTIVETENOTRDY EQU 5 12: SUBSYS NOT INITIALIZEDTEDRAIN EQU 6 12: SUBSYS DRAINED BY OPER.TESTOP EQU 7 12: SUBSYS STOPPED BY OPER.TETERM EQU 8 12: SUBSYS ABNORMALLY TERM.TEUNSUPO EQU 9 12: UNSUPPORTED OPT./FACIL.TEUNSUPF EQU 10 12: UNSUPPORTED FUNC./SVC.TEUNAVBL EQU 11 12: UNAVAILABLE SVC./FACIL.TEUNAUTH EQU 12 12: USER UNAUTHORIZEDTERSOURC EQU 13 12: INSUFFICIENT RESOURCESTEINUSE EQU 14 12: PROTOCOL ADDRESS IS ALREADY ENABLEDTEUSRXIT EQU 15 12: FAILED BY USER EXITTEBDOPCD EQU 1 16: INVLD OPTION CODETEBDEPID EQU 2 16: INVLD ENDPOINT IDTEBDXECB EQU 3 16: INVLD ECB/EXIT ADDR.TEBDDOM EQU 4 16: INVLD COMM. DOMAINTEBDPROT EQU 5 16: INVLD TRANSPRT PROTO.TEBDTYPE EQU 6 16: INVLD TRANSPRT SVC TYPETEBDXLST EQU 7 16: INVLD EXIT LISTTEBDUSER EQU 8 16: INVLD USER PARMTEBDACEE EQU 9 16: INVLD ACCESSOR ELEMENTTEBDSQNO EQU 10 16: INVLD SEQUENCE NUMBERTEBDQLEN EQU 11 16: INVLD QUEUE LENGTHTEBDTCB EQU 12 16: INVLD TCB ADDRESSTEBDASCB EQU 13 16: INVLD ASCB ADDRESSTEBDADDR EQU 14 16: INVLD PROTOCOL ADDRESSTEBDOPTN EQU 15 16: INVLD OPTIONSTEBDDATA EQU 16 16: INVLD DATA BUFFERTEBDTSID EQU 18 16: INVLD TRANSPORT SVC. IDTESTATE EQU 1 20: INVLD STATE FOR FUNC.TEINEXIT EQU 2 20: INVLD FUNC. WITHIN EXITTEINACTV EQU 3 20: CHECK ISSUED TO INACT. TPLTEINCMPL EQU 4 20: ENDPOINT HAS INCOMPL. FNCTEINDICA EQU 5 20: PENDING CONNECT INDICA.TEBUFOVR EQU 6 20: SEND/RCV. BUFFER OVERRUNTEREQOVR EQU 7 20: SEND/RCV. RQST. OVERRUNTENOCONN EQU 8 20: NO CONNECT INDICATIONTENODISC EQU 9 20: NO DISCONNECT INDICA.TEOUTSEQ EQU 10 20: REQUEST OUT OF SEQUENCETENOERR EQU 11 20: NO ERROR INDICATIONTEAMODE EQU 13 20: AMODE CONFLICTS W/ APCBTEOWNER EQU 14 20: NOT OPENED BY THIS TASKTELISTEN EQU 15 20: LISTEN QUEUE FULLTEACCEPT EQU 16 20: ACCEPTING TO ENDPOINTTEB4EXIT EQU 1 24:TPL CHECKED BEFORE EXITTEACTIVE EQU 2 24:TPL IS STILL ACTIVETPLDGNCD DS H DIAGNOSTIC AND SENSE CODESTPLMIN EQU *-TPL MINIMUM TPL LENGTHTLRELACK EQU *-TPL LENGTH OF SHORT TPL: TRELACKTLRELESE EQU *-TPL LENGTH OF SHORT TPL: TRELEASETLRETRCT EQU *-TPL LENGTH OF SHORT TPL: TRETRACTTLUNBIND EQU *-TPL LENGTH OF SHORT TPL: TUNBINDTPLPARM DS XL(4*3) FIXED-LENGTH FUNCTION PARAMETERSORG TPLPARMTPLPARM1 DS F PARAMETER #1ORG *-4TPLQLSTN DS 0F LISTEN QUEUE LENGTHTPLSEQNO DS 0F SEQUENCE NUMBERTPLTCB DS 0A TCB ADDRESSTPLMBUFO DS 0A OPTCD=MBUF MBUF OFFSETORG *+4TPLPARM2 DS F PARAMETER #2ORG *-4TPLNEWEP DS 0F NEW ENDPOINTTPLASCB DS 0A ASCB ADDRESSTPLCOUNT DS 0F RESIDUAL BYTE COUNTORG *+4TPLPARM3 DS F PARAMETER #3ORG *-4TPLUSER DS 0A TUB OR ACEE ADDRESSTPLDISCD DS 0F DISCONNECT REASON CODETPLDGERR DS 0F DATAGRAM ERROR CODETPLSTATE DS 0F OLD ENDPOINT STATETPLXCNT DS 0F XDATA RESIDUAL COUNTORG *+4TLACCEPT EQU *-TPL LENGTH OF SHORT TPL: TACCEPTTLCLEAR EQU *-TPL LENGTH OF SHORT TPL: TCLEARTLCLOSE EQU *-TPL LENGTH OF SHORT TPL: TCLOSETLDISCON EQU *-TPL LENGTH OF SHORT TPL: TDISCONTLREJECT EQU *-TPL LENGTH OF SHORT TPL: TREJECTTLUSER EQU *-TPL LENGTH OF SHORT TPL: TUSERTPLVAPAR DS XL(8*3) VARIABLE-LENGTH FUNCTION PARMSORG TPLVAPARTPLADDR DS XL(4*2) PROTOCOL ADDRESS PARAMETERORG TPLADDRTPLADBUF DS A PARAMETER ADDRESSTPLADLEN DS F PARAMETER LENGTHTLADDR EQU *-TPL LENGTH OF SHORT TPL: TADDRTLBIND EQU *-TPL LENGTH OF SHORT TPL: TBINDTLCONFRM EQU *-TPL LENGTH OF SHORT TPL: TCONFIRMTLCONNCT EQU *-TPL LENGTH OF SHORT TPL: TCONNECTTLLISTEN EQU *-TPL LENGTH OF SHORT TPL: TLISTENTLRECVER EQU *-TPL LENGTH OF SHORT TPL: TRECVERRTPLDATA DS XL(4*2) USER DATA PARAMETERORG TPLDATATPLDABUF DS A PARAMETER ADDRESSTPLDALEN DS F PARAMETER LENGTHTLINFO EQU *-TPL LENGTH OF SHORT TPL: TINFOTLRECV EQU *-TPL LENGTH OF SHORT TPL: TRECVTLRECVFR EQU *-TPL LENGTH OF SHORT TPL: TRECVFRTLSEND EQU *-TPL LENGTH OF SHORT TPL: TSENDTLSENDTO EQU *-TPL LENGTH OF SHORT TPL: TSENDTOTPLOPTN DS XL(4*2) OPTIONS PARAMETERORG TPLOPTNTPLOPBUF DS A PARAMETER ADDRESSTPLOPLEN DS F PARAMETER LENGTHTLOPTION EQU *-TPL LENGTH OF SHORT TPL: TOPTIONORG TPLLENEQU *-TPL STANDARD (LONG) TPL LENGTH*THE TPL FORMAT FOR TOPEN DIFFERS FROM THAT USED BY THE*OTHER TRANSPORT SERVICE FUNCTIONS. IN PARTICULAR, FUNCTION*ARGUMENTS UNIQUE TO TOPEN OVERLAY THE VARIABLE-LENGTH*PARAMETER SECTION AS DEFINED BELOW.ORG TPLVAPARTPLDOM DS X COMMUNICATION DOMAINTDINETO EQU 1 DARPA INTERNET PRE 3.1TDINET EQU 2 DARPA INTERNETTDACP EQU 4 ACP TASK GROUP DOMAINTDMAX EQU TDACP MAXIMUM VALUE FOR DOMAINTPLOFLAG DS X OPEN FLAGS/ENVIRONMENTTPLOFPRO EQU B'10000000' PROTOCOL NUMBER SPECIFIEDTPLOFORD EQU B'01000000' COTS ORDERLY RELEASE REQUIREDTPLOFASO EQU B'00100000' CLTS ASSOCIATIONS REQUIREDTPLOFECB EQU B'00010000' EVENT LIST SPECIFIEDTPLOFSOC EQU B'00001000' MODE=SOCKETS* EQU B'00000100' RESERVED* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTPLSERVC DS H TRANSPORT SERVICE REQUESTEDORG *-2TPLTYPE DS 0H TRANSPORT SERVICE TYPETTCOTS EQU 1 CONNECTION-MODE SERVICETTCLTS EQU 2 CONNECTIONLESS-MODE SVC.TTRAW EQU 3 RAW-MODE SERVICETTMAX EQU TTRAW MAX. VALUE FOR SERVICE TYPETPLPROTO DS 0H TRANSPORT PROTOCOL NUMBERORG *+2TPLAPCB DS A APCB ADDRESS FOR API SESSIONTPLSVCID DS CL8 PROVIDER'S SERVICE NAMETPLEXLST DS A ADDRESS OF EXIT LISTTPLUCNTX DS F ONE WORD OF USER CONTEXTTLOPEN EQU *-TPL LENGTH OF SHORT TPL: TOPENORGTPLMAX EQU *-TPL MAXIMUM TPL LENGTH*GENERAL RETURN CODES (RETURNED IN R15) ARE USED TO INDICATE*SUCCESSFUL OR UNSUCCESSFUL COMPLETION OF A FUNCTION IN*SYNCHRONOUS MODE, AND ACCEPTANCE OR NON-ACCEPTANCE OF A*FUNCTION IN ASYNCHRONOUS MODE.TROKAY EQU 0 SUCCESSFUL COMPLETION/ACCEPTEDTRFAILED EQU 4 UNSUCCESS. COMPLETION/NOT ACCPT.TRFATLFC EQU 8 INVALID FUNCTION CODETRFATLPL EQU 12 FATAL TPL ERRORTRFATLAM EQU 16 FATAL ACCESS METHOD ERRORTRFATLAP EQU 20 APCB IS CLOSEDTRUSER EQU 24 FIRST USER RETURN CODE**THE DISCONNECT REASON CODE RETURNED INTPLDISCD*AND DATAGRAM ERROR CODE RETURNED IN TPLDGERR ARE*PROVIDER-DEPENDENT.***THE FOLLOWING DISCONNECT REASON CODES MAY BE*RETURNED BY THE API FOR INTERNET DOMAIN*(DOMAIN=INET)*TDTRANTO EQU 1 TRANSMISSION TIMEOUTTDHOSTUN EQU 2 HOST UNREACHABLETDPORTUN EQU 3 PORT UNREACHABLETDRABORT EQU 4 REMOTE ABORTTDLNIDWN EQU 5 LOCAL NETWORK I/F DOWNTDPROTUN EQU 6 PROTOCOL UNREACHABLETDACPRR EQU 7 ACP CONNECTION ERRORTDAPIRR EQU 8 API CONNECTION ERRORTDNETUN EQU 9 NET UNREACHABLETDNOFRAG EQU 10 FRAGMENTATION NEEDED/DFTDSRFAIL EQU 11 SOURCE ROUTE FAILED**TPL EXTENSION*TPLPRM1X DS F TPLPARM1 - ALET OR EXTENSIONTPLPRM2X DS F TPLPARM2 - ALET OR EXTENSIONTPLPRM3X DS F TPLPARM3 - ALET OR EXTENSIONORG TPLPARM3XTPLUSALT DS F USER - ALETORG ,TPLADALT DS F ADBUF - ALETTPLDAALT DS F DAFUF - ALETTPLOPALT DS F OPBUF - ALETTPLXDIAG DS F EXTENDED DIAGNOSTIC CODETPLEXLEN EQU * LENGTH OF EXTENDED TPLTPO - Transport Protocol Options
AM=TLI TRANSPORT PROTOCOL OPTIONS (TPO)*******************************************************************-- TPO --**AM=TLI TRANSPORT PROTOCOL OPTIONS*******************************************************************THE FOLLOWING DSECT DEFINES THE STRUCTURE FOR SPECIFYING*OPTIONS ASSOCIATED WITH A TRANSPORT SERVICE FUNCTION.*GENERALLY SUCH OPTIONS WILL BE INDICATED WITH THE OPLEN*AND OPBUF OPERANDS OF A TRANSPORT SERVICE MACRO INSTRUCTION.**MORE THAN ONE OPTION MAY BE SPECIFIED IN A SINGLE MACRO*INSTRUCTION WHERE EACH OPTION IS FORMATTED IN ACCORDANCE*WITH THE FOLLOWING DSECT. OPBUF POINTS TO THE FIRST OPTION*IN THE LIST, AND OPLEN IS THE TOTAL LENGTH OF THE OPTION*LIST.TPO DSECT TRANSPORT PROTOCOL OPTIONSTPOPTLEN DS H LENGTH OF THIS OPTIONTPOPTION DS H OPTION NAME (I.E., NUMBER)** API-SPECIFIC OPTIONS*TPOAQSND EQU 0 MAXIMUM NUMBER OF SENDSTPOAQRCV EQU 1 MAXIMUM NUMBER OF RECEIVESTPOALSND EQU 2 LENGTH OF SEND BUFFERTPOALRCV EQU 3 LENGTH OF RECEIVE BUFFERTPOAMAX EQU TPOALRLN MAXIMUM OPTION NUMBER** ACP-PROVIDER-SPECIFIC OPTIONS*TPOPRWND EQU 1 TCP RECEIVE WINDOWTPOPKTIM EQU 2 KEEPALIVE TIMETPOPKEEP EQU 3 KEEPALIVE OPTIONSTPOPDNAG EQU 4 DEFEAT NAGLE ALGORITHMTPOPRWND EQU 1 TCP RECEIVE WINDOWTPOPKTIM EQU 2 KEEPALIVE TIMETPOPKEEP EQU 3 KEEPALIVE OPTIONSTPOPDNAG EQU 4 DEFEAT NAGLE ALGORITHMTPOPRTIM EQU 5 FULL RECEIVE TIMEOUTTPOIPOPT EQU 6 IP OPTIONSTPOSIOAR EQU 7 SOCKET ADD ROUTETPOSIODR EQU 8 SOCKET DELETE ROUTETPOSIFCF EQU 9 SOCKET INTERFACE CONFIGTPOSIFLG EQU 10 SOCKET INTERFACE FLAGSTPOSIFMT EQU 11 SOCKET INTERFACE MTUTPOSIFME EQU 12 SOCKET INTERFACE METRICTPOSIFNM EQU 13 SOCKET IFC NETWORK MASKTPOSIFBA EQU 14 SOCKET BROADCAST ADDRTPOSIFAD EQU 15 SOCKET IFC ADDRESSTPOSIFEN EQU 16 SOCKET IFC ENET ADDRESSTPOSIFNO EQU 17 NUMBER OF INTERFACESTPOSIFDS EQU 18 DESTINATION ADDRESSTPOIPTTL EQU 19 IP TIME TO LIVETPOIPTOS EQU 20 IP TYPE OF SERVICETPOTPMSS EQU 21 TCP MAXIMUM SEGMENT SIZETPOIPDNR EQU 22 IP DO NOT ROUTETPOIPBRO EQU 23 IP BROADCASTTPOUDSUM EQU 24 UDP CHECKSUMSTPOTQSND EQU 25 MAXIMUM NUMBER OF SENDSTPOTQRCV EQU 26 MAXIMUM NUMBER OF RECEIVESTPOTLSND EQU 27 LENGTH OF SEND BUFFERTPOTLRCV EQU 28 LENGTH OF RECEIVE BUFFERTPOREUSE EQU 29 REUSE ADDRESSTPOIMIF EQU 30 SAW_IP_MULTICAST_IF (UNSUPPORTED)TPOIMTTL EQU 31 SAW_IP_MULTICAST_TTL (UNSUPPORTED)TPOIMLOO EQU 32 SAW_IP_MULTICAST_LOOP (UNSUPPORTED)TPOIADDM EQU 33 SAW_IP_ADD_MEMBERSHIP (UNSUPPORTED)TPOIDRPM EQU 34 SAW_IP_DROP_MEMBERSHIP (UNSUPPORTED)TPOUDATA EQU 35 User DataTPOACCON EQU 36 SO_ACCEPTCONN optionTPORCVLW EQU 37 SO_RCVLOWAT optionTPOSNDLW EQU 38 SO_SNDLOWAT optionTPOIPHDR EQU 39 IP_HDRINCL optionTPOFIONR EQU 40 FIONREAD optionTPOTMAX EQU TPOFIONR MAXIMUM OPTION NUMBERTPOVALUE DS (*-*)X OPTION VALUETSW - Transport Endpoint State Word
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT*OF THE STATE WORD RETURNED BY THE TSTATE FUNCTION. THE*STATE WORD CONTAINS STATUS FLAGS REPRESENTING PENDING*ACTIVITY ON THE ENDPOINT, AND A HALFWORD STATE VALUE*WHICH REPRESENTS THE STATE OF THE ENDPOINT AT THE MOST*RECENT SUCCESSFUL COMPLETION OF A TRANSPORT SERVICE*FUNCTION.TSW DSECT TRANSPORT ENDPOINT STATE WORDTSWSTATF DC X'00' STATUS FLAGSTSWFCHNG EQU B'10000000' STATE IS CHANGINGTSWFACPT EQU B'01000000' ACCEPTING TO THIS ENDPOINTTSWOPNO EQU B'00100000' OPENING OLD TO THIS EP* EQU B'00010000' RESERVED* EQU B'00001000' RESERVED* EQU B'00000100' RESERVED* EQU B'00000010' RESERVED* EQU B'00000001' RESERVEDTSWPENDF DC X'00' PENDING FUNCTION INDICATORSTSWPFCLS EQU B'10000000' TCLOSE DELETETSWPFDIS EQU B'01000000' TDISCONN, TCLEAR, TRETRACTTSWPFREL EQU B'00100000' TRELEASETSWPFACK EQU B'00010000' TRELACKTSWPFCON EQU B'00001000' CONNECTION ESTABLISHMENT FNCTSWPFLCL EQU B'00000100' LOCAL ENDPOINT MANAGEMENT FNCTSWPFPAS EQU B'00000010' TCLOSE PASSTSWPFOPN EQU B'00000001' TOPENTSWPFRCV EQU B'00000000' TRECVTSWPFSND EQU B'00000000' TSENDTSWPFDGM EQU B'00000000' TRECVFR, TSENDTO, TRECVERRTSWSTATE DC H'0' CURRENT ENDPOINT STATETSCLOSED EQU 0 CLOSED (NON-EXISTENT)TSOPENED EQU 1 OPENED (NOT BOUND)TSDSABLD EQU 2 DISABLED (BOUND, QLSTN EQ 0)TSENABLD EQU 3 ENABLED (BOUND, QLSTN GT 0)TSINCONN EQU 4 CONNECT INDICATION PENDINGTSOUCONN EQU 5 CONNECT IN PROGRESSTSCONNCT EQU 6 CONNECTED (OR ASSOCIATED)TSINRLSE EQU 7 RELEASE INDICATION PENDINGTSOURLSE EQU 8 RELEASE IN PROGRESSTSMAX EQU TSOURLSE MAXIMUM STATE VALUETSWLEN EQU *-TSW LENGTH OF TSWTUB - Transport Endpoint User Block
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*USER ID PARAMETERS REQUIRED FOR ASSOCIATING A USER WITH*AN ENDPOINT. THIS STRUCTURE SHOULD BE PROVIDED AS AN*ARGUMENT TO TOPEN AND TUSER WHEN AN ACCESSOR ENVIRONMENT*ELEMENT (ACEE) IS NOT AVAILABLE OR APPROPRIATE.TUB DSECT TRANSPORT ENDPOINT USER BLOCKTUBUID DS XL9 USER IDORG TUBUIDTUBUIDL DS X USER ID LENGTHTUBUIDC DS CL8 USER ID CHARACTER STRINGORGTUBGRP DS XL9 GROUP NAMEORG TUBGRPTUBGRPL DS X GROUP NAME LENGTHTUBGRPC DS CL8 GROUP NAME CHARACTER STRINGORGTUBPWD DS XL9 PASSWORDORG TUBPWDTUBPWDL DS X PASSWORD LENGTHTUBPWDC DS CL8 PASSWORD CHARACTER STRINGORGTUBLEN EQU *-TUB LENGTH OF TUBTXL - Transport Endpoint Exit List
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*THE EXIT LIST PROVIDED BY THE APPLICATION PROGRAM AS AN*ARGUMENT OF THE TOPEN AND AOPEN MACRO INSTRUCTIONS. EACH*ENTRY IS THE ADDRESS OF AN EXIT ROUTINE WHICH IS TO RECEIVE*CONTROL WHEN A PARTICULAR EVENT OCCURS. IF THE VALUE OF*AN ENTRY IS ZERO, THE CORRESPONDING EXIT ROUTINE IS NOT*DEFINED. THE EXIT LIST CAN BE GENERATED BY A TEXLST MACRO*INSTRUCTION.TXL DSECT TRANSPORT ENDPOINT EXIT LISTTXLLENXL DS F LENGTH OF EXIT LISTTXLEXITS DS 0A LIST OF EXIT ROUTINESTXLPROTO DS 10A PROTOCOL EVENT EXITSORG TXLPROTOTXLCONN DS A CONNECT INDICATIONTXLCONF DS A CONFIRM INDICATIONTXLDATA DS A NORMAL DATA INDICATIONTXLXDATA DS A EXPEDITED DATA INDICATIONTXLDGERR DS A DATAGRAM ERROR INDICATIONTXLDISC DS A DISCONNECT INDICATIONTXLRELSE DS A RELEASE INDICATIONTXLSWIND DS A WINDOW OPEN INDICATIONDS 2A RESERVEDORGTXLTPEND DS A PROVIDER END EXITDS 2A RESERVEDDS H RESERVEDTXLFECB DS H EVENT is ECB FlagsTXLFECI EQU X'8000' Connect Ind. event is ECBTXLFECF EQU X'4000' Confirm event is ECBTXLFEDA EQU X'2000' Data Ind. event is ECBTXLFEXD EQU X'1000' Expedited data event is ECBTXLFEDE EQU X'0800' Datagram error event is ECBTXLFEDI EQU X'0400' Disconnect event is ECBTXLFERL EQU X'0200' Release Ind. event is ECBTXLFESW EQU X'0100' Send window opened is ECBTXLFETP EQU X'0080' TPEND event is an ECBTXLLENTO EQU *-TXL LENGTH OF TOPEN EXIT LIST*THE FOLLOWING EXITS CAN ONLY BE SPECIFIED IN AN AOPEN*EXIT LIST.TXLERROR DS 2A SYNCHRONOUS ERROR EXITSORG TXLERRORTXLSYNAD DS A PHYSICAL ERRORSTXLLERAD DS A LOGICAL ERRORSORGTXLAPEND DS A API SUBSYSTEM END EXITDS 2A RESERVEDTXLLENAO EQU *-TXL LENGTH OF AOPEN EXIT LISTTXLLEN EQU *-TXL MAXIMUM LENGTH OF TXLTXP - Transport Endpoint Exit Parameters
*THE FOLLOWING DSECT DEFINES THE STRUCTURE AND CONTENT OF*THE PARAMETER LIST WHOSE ADDRESS IS PASSED IN R1 TO THE*TPEND AND ALL PROTOCOL EVENT EXIT ROUTINES. A TPL ADDRESS*IS PASSED IN R1 TO THE SYNAD, LERAD, AND TPL COMPLETION*EXIT ROUTINES.TXP DSECT TRANSPORT ENDPOINT EXIT PARAMETERSTXPTYPE DS H EXIT TYPETXPTPROT EQU 1 PROTOCOL EVENT EXITTXPTCMPL EQU 2 ENDPOINT COMPLETION EXITTXPTPEND EQU 3 PROVIDER END EXITTXPTSYNC EQU 4 SYNCHRONOUS ERROR EXITTXPAPEND EQU 5 SUBSYSTEM END EXITDS H RESERVEDTXPEP DS F ENDPOINTORG *-4TXPEPID DS 0F ENDPOINT IDTXPTCEP DS 0A TCEP ADDRESSTXPAPCB DS 0A APCB ADDRESS FOR APENDORG *+4TXPEXIT DS A EXIT ROUTINE ENTRY POINTTXPPARM DS F EXIT PARAMETERORG *-4TXPEVENT DS 0F PROTOCOL EVENT CODETXPECONN EQU 0 CONNECT INDICATIONTXPECONF EQU 4 CONFIRM INDICATIONTXPEDATA EQU 8 NORMAL DATA INDICATIONTXPEXPDT EQU 12 EXPEDITED DATA INDICATIONTXPERROR EQU 16 DATAGRAM ERROR INDICATIONTXPEDISC EQU 20 DISCONNECT INDICATIONTXPERLSE EQU 24 ORDERLY RELEASE INDICATIONTXPESWND EQU 28 SEND WINDOW OPENTXPREASN DS 0F TPEND REASON CODETXPRDRAN EQU 0 OPERATOR DRAINED SUBSYSTEMTXPRSTOP EQU 4 OPERATOR STOPPED SUBSYSTEMTXPRTERM EQU 8 SUBSYS. ABNORM. TERMINATEDTXPTPL DS 0A COMPLETION TPL ADDRESSORG *+4TXPACNTX DS F APPLICATION-LEVEL CONTEXTTXPUCNTX DS F USER-LEVEL (ENDPOINT) CONTEXTTXPECNTX DS F ENVIRONMENT-LEVEL CONTEXTTXPLEN EQU *-TXP LENGTH OF TXPTXPPARM2 DS F SECOND PARAMETER WORDTXPCOUNT EQU TXPPARM2,4 DATA/SEND WINDOW COUNT