Abstract for IP Programmer's Guide and Reference
Summary of changes
Changes made in z/OS Version 2 Release 1, as updated September 2014
Changes made in z/OS Version 2 Release 1, as updated December 2013
Summary of changes for z/OS Version 2 Release 1
General programming information
Overview of Distributed Protocol Interface (DPI) versions 1.1 and 2.0
SNMP agent Distributed Protocol Interface version 1.1
SNMP agents and subagents
Processing DPI requests
Processing a GET request
Processing a SET request
Processing a GET-NEXT request
Processing a REGISTER request
Processing a TRAP request
SNMP agent DPI header files
SNMP agent DPI: Compiling and linking
SNMP agent DPI: Sample compilation cataloged procedure additions
SNMP agent DPI: Sample link-edit cataloged procedure additions
SNMP DPI library routines
mkDPIlist()
fDPIparse()
mkDPIregister()
mkDPIresponse()
mkDPIset()
mkDPItrap()
mkDPItrape()
pDPIpacket()
query_DPI_port()
Sample SNMP DPI client program for C sockets for version 1.1
Using the DPISAMPL program
DPISAMPN NCCFLST for the SNMP manager
Compiling and linking the DPISAMPL.C source code
dpiSample table MIB descriptions
The DPISAMPL.C source code
SNMP agent Distributed Protocol Interface version 2.0
SNMP agents and subagents
DPI agent requests
SNMP DPI version 2.0 library
SNMP DPI Version 2.0 API
Compiling and linking DPI Version 2.0
Compiling and linking DPI Version 2.0: UNIX System Services environment
Compiling and linking DPI Version 2.0: MVS environment
DPI Version 1.x base code considerations
Migrating your SNMP DPI subagent to Version 2.0
Required actions for migrating your SNMP DPI subagent to Version 2.0
Recommended actions for migrating your SNMP DPI subagent to Version 2.0
snmp_dpi_xxxx_packet structures name changes
SNMP DPI environment variables
SNMP DPI subagent programming concepts
Specifying the SNMP DPI API
DPI subagent connect processing
DPI subagent OPEN request
DPI subagent REGISTER request
DPI subagent GET processing
DPI subagent SET processing
DPI subagent GETNEXT processing
DPI subagent GETBULK processing request
DPI subagent TRAP request
DPI subagent ARE_YOU_THERE request
DPI subagent UNREGISTER request
DPI subagent CLOSE request
Multithreading programming considerations
Functions, data structures, and constants
Basic DPI API functions
The DPIdebug() function
The DPI_PACKET_LEN() macro
The fDPIparse() function
The fDPIset() function
The mkDPIAreYouThere() function
The mkDPIclose() function
The mkDPIopen() function
The mkDPIregister() function
The mkDPIresponse() function
The mkDPIset() function
The mkDPItrap() function
The mkDPIunregister() function
The pDPIpacket() function
Transport-related DPI API functions
The DPIawait_packet_from_agent() function
The DPIconnect_to_agent_TCP() function
The DPIconnect_to_agent_UNIXstream() function
The DPIdisconnect_from_agent() function
The DPIget_fd_for_handle() function
The DPIsend_packet_to_agent() function
The lookup_host() function
The lookup_host6() function
DPI structures
The snmp_dpi_close_packet structure
The snmp_dpi_get_packet structure
The snmp_dpi_hdr structure
The snmp_dpi_next_packet structure
The snmp_dpi_resp_packet structure
The snmp_dpi_set_packet structure
The snmp_dpi_ureg_packet structure
The snmp_dpi_u64 structure
DPI OPEN character set selection
SNMP DPI constants, values, return codes, and include file
DPI CLOSE reason codes
DPI packet types
DPI RESPONSE error codes
DPI UNREGISTER reason codes
DPI SNMP value types
Value representation of DPI SNMP value types
Value ranges and limits for DPI SNMP value types
Return codes from DPI transport-related functions
The snmp_dpi.h include file
snmp_dpi.h include parameters
snmp_dpi.h include description
DPI subagent example
Overview of subagent processing
SNMP DPI: Connecting to the agent
SNMP DPI: Registering a subtree with the agent
SNMP DPI: Processing requests from the agent
SNMP DPI: Processing a GET request
SNMP DPI: Processing a GETNEXT request
SNMP DPI: Processing a SET/COMMIT/UNDO request
SNMP DPI: Processing an UNREGISTER request
SNMP DPI: Processing a CLOSE request
SNMP DPI: Generating a TRAP
Running the sample SNMP DPI client program for version 2.0
Using the sample SNMP DPI client program
Compiling and linking the dpi_mvs_sample.c source code
DPISimple-MIB descriptions
SNMP manager API
SNMP protocol
The SNMP manager API overview
The SNMP notification API overview
SNMP manager API functions
Configuration entry considerations
snmpAddVarBind – Adds a VarBind to the SnmpVarBinds structure
snmpAddVarBind description
snmpAddVarBind parameters
snmpAddVarBind result
snmpBuildPDU – Builds an SNMP PDU
snmpBuildPDU description
snmpBuildPDU parameters
snmpBuildPDU result
snmpBuildSession – Creates a session
snmpBuildSession description
snmpBuildSession parameters
snmpBuildSession result
snmpCreateVarBinds – Creates a VarBind structure
snmpCreateVarBinds description
snmpCreateVarBinds parameters
snmpCreateVarBinds result
snmpFreeDecodedPDU - Free the decoded PDU
snmpFreeDecodedPDU description
snmpFreeDecodedPDU parameters
snmpFreeDecodedPDU result
snmpFreeOID - Free an OID string
snmpFreeOID description
snmpFreeOID parameters
snmpFreeOID result
snmpFreePDU – Frees the resources of a PDU
snmpFreePDU description
snmpFreePDU parameters
snmpFreePDU result
snmpFreeVarBinds – Frees the VarBinds structure
snmpFreeVarBinds description
snmpFreeVarBinds parameters
snmpFreeVarBinds result
snmpGetErrorInfo - Get the error information from the PDU response
snmpGetErrorInfo description
snmpGetErrorInfo parameters
snmpGetErrorInfo result
snmpGetNumberOfVarBinds – Get the number of VarBinds attached to the PDU
snmpGetNumberOfVarBinds description
snmpGetNumberOfVarBinds parameters
snmpGetNumberOfVarBinds result
snmpGetOID – Get the OID from the VarBind structure
snmpGetOID description
snmpGetOID parameters
snmpGetOID result
snmpGetRequestId – Get the PDU’s requestId value
snmpGetRequestId description
snmpGetRequestId parameters
snmpGetRequestId result
snmpGetSockFd – Get the socket’s file descriptor
snmpGetSockFd description
snmpGetSockFd parameters
snmpGetSockFd result
snmpGetValue – Get the value from the VarBind structure
snmpGetValue description
snmpGetValue parameters
snmpGetValue result
snmpGetVarbind – Get a VarBind attached to the PDU
snmpGetVarbind description
snmpGetVarbind parameters
snmpGetVarbind result
snmpInitialize – Initialize the manager environment
snmpInitialize description
snmpInitialize parameters
snmpInitialize result
snmpSendRequest – Send the snmpPDU request to an agent
snmpSendRequest description
snmpSendRequest parameters
snmpSendRequest result
snmpSetLogFunction – Set the logging level
snmpSetLogFunction description
snmpSetLogFunction parameters
snmpSetLogFunction result
snmpSetLogLevel – Set the logging level
snmpSetLogLevel description
snmpSetLogLevel parameters
snmpSetLogLevel result
snmpSetRequestId – Set the PDU’s requestId value
snmpSetRequestId description
snmpSetRequestId parameters
snmpSetRequestId result
snmpTerminate – Release the resources
snmpTerminate description
snmpTerminate parameters
snmpTerminate result
snmpTerminateSession – Terminate a session
snmpTerminateSession description
snmpTerminateSession parameters
snmpTerminateSession result
snmpValueCreateCounter32 – Create an smiValue of type Counter32
snmpValueCreateCounter32 description
snmpValueCreateCounter32 parameters
snmpValueCreateCounter32 result
snmpValueCreateCounter64 – Create an smiValue of type Counter64
snmpValueCreateCounter64 description
snmpValueCreateCounter64 parameters
snmpValueCreateCounter64 result
snmpValueCreateGauge32 – Create an smiValue of type Gauge32
snmpValueCreateGauge32 description
snmpValueCreateGauge32 parameters
snmpValueCreateGauge32 result
snmpValueCreateInteger – Create an smiValue of type Integer
snmpValueCreateInteger description
snmpValueCreateInteger parameters
snmpValueCreateInteger result
snmpValueCreateInteger32 – Create an smiValue of type Integer32
snmpValueCreateInteger32 description
snmpValueCreateInteger32 parameters
snmpValueCreateInteger32 result
snmpValueCreateIPAddr – Create an smiValue of type IPAddr
snmpValueCreateIPAddr description
snmpValueCreateIPAddr parameters
snmpValueCreateIPAddr result
snmpValueCreateNull – Create an smiValue of type Null
snmpValueCreateNull description
snmpValueCreateNull parameters
snmpValueCreateNull result
snmpValueCreateOctet – Create an smiValue of type Octet
snmpValueCreateOctet description
snmpValueCreateOctet parameters
snmpValueCreateOctet result
snmpValueCreateOID – Create an smiValue of type OID
snmpValueCreateOID description
snmpValueCreateOID parameters
snmpValueCreateOID result
snmpValueCreateOpaque – Create an smiValue of type Opaque
snmpValueCreateOpaque description
snmpValueCreateOpaque parameters
snmpValueCreateOpaque result
snmpValueCreateTimerTicks – Create an smiValue of type TimerTicks
snmpValueCreateTimerTicks description
snmpValueCreateTimerTicks parameters
snmpValueCreateTimerTicks result
snmpValueCreateUnsigned32 – Create an smiValue of type Unsigned32
snmpValueCreateUnsigned32 description
snmpValueCreateUnsigned32 parameters
snmpValueCreateUnsigned32 result
SNMP notification API functions
snmpBuildV1TrapPDU – Builds an SNMP V1 trap PDU
snmpBuildV1TrapPDU description
snmpBuildV1TrapPDU parameters
snmpBuildV1TrapPDU result
snmpBuildV2TrapOrInformPDU – Builds an SNMP V2 trap or inform PDU
snmpBuildV2TrapOrInformPDU description
snmpBuildV2TrapOrInformPDU parameters
snmpBuildV2TrapOrInformPDU result
SNMP manager API configuration file
SNMP manager API statement syntax
SNMP manager API general rules
Steps for compiling and linking SNMP manager API applications
Running your SNMP manager API application
Debugging the SNMP manager API
Sample SNMP manager API source code
Resource Reservation Setup Protocol API (RAPI)
API outline
Compiling and linking RAPI applications
Running RAPI applications
Event upcall
rapi_event_rtn_t - Event upcall
rapi_event_rtn_t description
rapi_event_rtn_t parameters
rapi_event_rtn_t result
Client library services
rapi_release - Remove a session
rapi_release description
rapi_release parameters
rapi_release result
rapi_reserve - Make, modify, or delete a reservation
rapi_reserve description
rapi_reserve parameters
rapi_reserve result
rapi_sender - Specify sender parameters
rapi_sender description
rapi_sender parameters
rapi_sender result
rapi_session - Create a session
rapi_session description
rapi_session parameters
rapi_session result
rapi_session extended description
rapi_version - RAPI version
rapi_version description
rapi_version result
RAPI formatting routines
rapi_fmt_adspec - Format an adspec
rapi_fmt_adspec description
rapi_fmt_adspec parameters
rapi_fmt_adspec result
rapi_fmt_filtspec - Format a filtspec
rapi_fmt_filtspec description
rapi_fmt_filtspec parameters
rapi_fmt_filtspec result
rapi_fmt_flowspec - Format a flowspec
rapi_fmt_flowspec description
rapi_fmt_flowspec parameters
rapi_fmt_flowspec result
rapi_fmt_tspec - Format a tspec
rapi_fmt_tspec description
rapi_fmt_tspec parameters
rapi_fmt_tspec result
RAPI objects
RAPI objects - Flowspecs
RAPI_FLOWSTYPE_Simplified
RAPI_FLOWSTYPE_Intserv
RAPI_FLOWSTYPE_Intserv upcalls
RAPI objects - Sender tspecs
RAPI_TSPECTYPE_Simplified
RAPI_TSPECTYPE_Intserv
RAPI_TSPECTYPE_Intserv upcalls
RAPI objects - Adspecs
RAPI_ADSTYPE_Simplified
RAPI_ADSTYPE_Intserv
RAPI_ADSTYPE_Intserv upcalls
RAPI objects - Filter specs and sender templates
RAPI asynchronous event handling
rapi_dispatch - Dispatch API event
rapi_dispatch description
rapi_dispatch parameters
rapi_dispatch result
rapi_getfd - Get file descriptor
rapi_getfd description
rapi_getfd parameters
rapi_getfd result
RAPI error handling
RAPI error codes
RSVP error codes
RAPI header files
RAPI header files: Integer and floating point types
The <rapi.h> header
<rapi.h> header general definitions
<rapi.h> header tspec definitions
<rapi.h> header flowspec definitions
<rapi.h> header adspec definitions
<rapi.h> header filter spec definitions
<rapi.h> header policy definitions
<rapi.h> header reservation style definitions
<rapi.h> header function interface definitions
Integrated services data structures and macros
Integrated services data structures and macros general definitions
Integrated services data structures and macros generic tspec format
Integrated services data structures and macros formats for controlled-load service
Integrated services data structures and macros formats for guaranteed service
Integrated services data structures and macros basic adspec pieces
Integrated services flowspec
Integrated services tspec
Integrated services adspec
X Window System interface in the z/OS Communications Server environment
X Window System and Motif
DLL support for the X Window System
How the X Window System interface works in the MVS environment
z/OS UNIX application resource file
Identifying the target display in z/OS UNIX
X Window System programming considerations
Porting Motif applications to z/OS UNIX MVS
Compiling and linking Motif and X Window System applications
Running an X Window System or Motif DLL-enabled application
X Window System environment variables
Motif environment variables
EBCDIC/ASCII translation in the X Window System
EBCDIC/ASCII translation in the X Window System: Locale independent translation
EBCDIC/ASCII translation in the X Window System: Locale dependent translation
XTextProperty with COMPOUND_TEXT encoding
Standard clients supplied with MVS z/OS UNIX X Window System support
Demonstration programs supplied with MVS z/OS UNIX X Window System support
X Window System and Motif files locations
Previous function X11R6.1 and Motif 1.2
New function X11R6.6 and Motif 2.1.30
Remote procedure calls in the z/OS Communications Server environment
The RPC interface
Portmapper and rpcbind
Contacting portmapper or rpcbind
Portmapper and rpcbind target assistance
Registering with rpcbind
Deregistering with rpcbind
Obtaining address lists from the rpcbind server
RPC servers in a CINET environment
Using ENF event code 80 to listen for rpcbind events
RPCGEN command
clnt_stat enumerated type
Porting RPC applications
Remapping file names with MANIFEST.H
Accessing system return messages
Printing system return messages
Enumerations
Header files for remote procedure calls
Compiling and linking RPC applications
Compatibility considerations when compiling and linking RPC applications
Sample compilation cataloged procedure additions
Compiling and linking RPC applications: Nonreentrant modules
Compiling and linking RPC applications: Reentrant modules
RPC global variables
rpc_createerr
svc_fds
svc_fdset
Remote procedure and external data representation calls
auth_destroy()
authnone_create()
authunix_create()
authunix_create_default()
callrpc()
clnt_broadcast()
clnt_call()
clnt_control()
clnt_create()
clnt_destroy()
clnt_freeres()
clnt_geterr()
clnt_pcreateerror()
clnt_perrno()
clnt_perror()
clnt_spcreateerror()
clnt_sperrno()
clnt_sperror()
clntraw_create()
clnttcp_create()
clntudp_create()
get_myaddress()
getrpcport()
pmap_getmaps()
pmap_getport()
pmap_rmtcall()
pmap_set()
pmap_unset()
registerrpc()
svc_destroy()
svc_freeargs()
svc_getargs()
svc_getcaller()
svc_getreq()
svc_getreqset()
svc_register()
svc_run()
svc_sendreply()
svc_unregister()
svcerr_auth()
svcerr_decode()
svcerr_noproc()
svcerr_noprog()
svcerr_progvers()
svcerr_systemerr()
svcerr_weakauth()
svcraw_create()
svctcp_create()
svcudp_create()
xdr_accepted_reply()
xdr_array()
xdr_authunix_parms()
xdr_bool()
xdr_bytes()
xdr_callhdr()
xdr_callmsg()
xdr_char()
xdr_destroy()
xdr_double()
xdr_enum()
xdr_float()
xdr_free()
xdr_getpos()
xdr_inline()
xdr_int()
xdr_long()
xdr_opaque()
xdr_opaque_auth()
xdr_pmap()
xdr_pmaplist()
xdr_pointer()
xdr_reference()
xdr_rejected_reply()
xdr_replymsg()
xdr_setpos()
xdr_short()
xdr_string()
xdr_text_char()
xdr_u_char()
xdr_u_int()
xdr_u_long()
xdr_u_short()
xdr_union()
xdr_vector()
xdr_void()
xdr_wrapstring()
xdrmem_create()
xdrrec_create()
xdrrec_endofrecord()
xdrrec_eof()
xdrrec_skiprecord()
xdrstdio_create()
xprt_register()
xprt_unregister()
Sample RPC programs
Running RPC sample programs
Starting the GENESERV server
Running GENESEND client
Running the RAWEX module
RPC client
RPC server
RPC raw data stream
RPCGEN sample programs
Generating your own sequential data sets
Building client and server executable modules
Running RPCGEN sample programs
Remote procedure calls in the z/OS UNIX System Services environment
Deviations from Sun RPC 4.0
Using z/OS UNIX System Services RPC
Support for 64-bit integers
UDP transport protocol CLIENT handles
RPC restrictions
Network Computing System
NCS and the Network Computing Architecture
NCS components
Remote procedure call runtime library
Location broker
Network interface definition language compiler
MVS implementation of NCS
NCS system IDL data sets
NCS C header data sets and the Pascal include data set
NCS RPC run-time library
NCS portability issues
NCS defines NCSDEFS.H
Required user-defined USERDEFS.H
NCS: Preprocessing, compiling, and linking
NCS preprocessor programs
NIDL compiler
NIDL compiler limitations
NIDL compiler options
Converting C identifiers using the CPP program
Compiling and linking NCS programs
NCS: Sample compilation cataloged procedure additions
NCS: Sample link-edit cataloged procedure additions
Running UUID@GEN
NCS sample programs
The NCSSMP sample program
NCS sample redefines
Compiling, linking, and running the sample BINOP program
Setting up the sample BINOP program
Compiling the sample BINOP program
Linking the sample BINOP program
Running the sample BINOP program
Compiling, linking, and running the NCSSMP program
Setting up the NCSSMP program
Compiling the NCSSMP program
Linking the NCSSMP program
Running the NCSSMP program
Compiling, linking, and running the sample BANK program
Setting up the sample BANK program
Compiling the sample BANK program
Linking the sample BANK program
Running the sample BANK program
Running the sample mail filter program
Compiling and linking the lf_smpl.c source code
Specifying filters in the sendmail configuration file
Running the sample mail filter program
Library control functions
smfi_register
smfi_register description
smfi_register parameters
smfi_register result
smfi_setconn
smfi_settimeout
smfi_settimeout description
smfi_settimeout parameters
smfi_settimeout result
smfi_main
smfi_main description
smfi_main parameters
smfi_main result
Data access functions
smfi_getsymval
smfi_getpriv
smfi_getpriv description
smfi_getpriv parameters
smfi_getpriv result
smfi_setpriv
smfi_setreply
smfi_setreply description
smfi_setreply parameters
smfi_setreply result
Message modification functions
smfi_addheader
smfi_chgheader
smfi_addrcpt
smfi_delrcpt
smfi_replacebody
Mail filter callbacks
xxfi_connect - Connection information
xxfi_connect description
xxfi_connect parameters
xxfi_connect result
xxfi_helo - SMTP HELO/EHLO command
xxfi_helo description
xxfi_helo parameters
xxfi_envfrom - Envelope sender
xxfi_envfrom description
xxfi_envfrom parameters
xxfi_envfrom result
xxfi_envrcpt - Envelope recipient
xxfi_envrcpt description
xxfi_envrcpt parameters
xxfi_envrcpt result
xxfi_header - Header
xxfi_eoh - End of header
xxfi_eoh description
xxfi_eoh parameters
xxfi_body - body block
xxfi_eom - End of message
xxfi_abort - Message aborted
xxfi_close - Connection cleanup
Policy API (PAPI)
API outline for retrieving data from Policy Agent
Compiling and linking PAPI applications
Running PAPI applications
PAPI return codes
PAPI client library services
PAPI: Connecting and retrieving data
papi_connect - Connect to Policy Agent
papi_connect description
papi_connect parameters
papi_connect result
papi_connect example
papi_debug - Set debug capability
papi_debug description
papi_debug parameters
papi_debug result
papi_disconnect - Disconnect from the Policy Agent
papi_disconnect description
papi_disconnect parameters
papi_disconnect result
papi_disconnect example
papi_free_perf_data - Free retrieved QoS performance data
papi_free_perf_data description
papi_free_perf_data parameters
papi_free_perf_data result
papi_free_perf_data example
papi_get_perf_data - Retrieve QoS performance data
papi_get_perf_data description
papi_get_perf_data parameters
papi_get_perf_data result
papi_get_perf_data example
PAPI helper functions
papi_get_action_perf_by_id - Obtain performance information on the action specified by the action ID
papi_get_action_perf_by_id description
papi_get_action_perf_by_id parameters
papi_get_action_perf_by_id result
papi_get_action_perf_info - Obtain performance information on a particular action
papi_get_action_perf_info description
papi_get_action_perf_info parameters
papi_get_action_perf_info result
papi_get_actions_count - Obtain number of actions in the policy performance data
papi_get_actions_count description
papi_get_actions_count parameters
papi_get_actions_count result
papi_get_policy_instance - Obtain policy instance number for policies in the policy performance data
papi_get_policy_instance description
papi_get_policy_instance parameters
papi_get_policy_instance result
papi_get_rule_perf_by_id - Obtain performance information on the rule specified by the rule ID
papi_get_rule_perf_by_id description
papi_get_rule_perf_by_id parameters
papi_get_rule_perf_by_id result
papi_get_rule_perf_info - Obtain performance information on a particular rule
papi_get_rule_perf_info description
papi_get_rule_perf_info parameters
papi_get_rule_perf_info result
papi_get_rules_count - Obtain number of rules in the policy performance data
papi_get_rules_count description
papi_get_rules_count parameters
papi_get_rules_count result
papi_strerror - Return string describing PAPI return code value
papi_strerror description
papi_strerror parameters
papi_strerror result
FTP Client Application Programming Interface (API)
FTP client API compatibility considerations
FTP client API guidelines and requirements
Java call formats
COBOL, C, REXX, assembler, and PL/I call formats
Converting parameter descriptions
z/OS FTP client behavior when invoked from the FTP client API
FTP Client Application Interface (FCAI) control block
FTP Client Application Interface (FCAI) stem variables
Predefined REXX variables
Sending requests to the FTP client API
INIT
Example of the INIT call instruction
Parameter values that are set by the application
Parameter values that are returned to the application
Guidelines for INIT results
Application tasks for the INIT request
SCMD
Example of the SCMD call instruction
Parameter values that are set by the application
Parameter values that are returned to the application
Guidelines for SCMD results
Application tasks for the SCMD request
POLL
Example of the POLL call instruction
Parameter values that are set by the application
Parameter values that are returned to the application
Guidelines for POLL results
Application tasks for the POLL request
GETL
Example of the GETL call instruction
Parameter values that are set by the application
Parameter values that are returned to the application
Guidelines for GETL results
Application tasks for the GETL request
Using the FIND and COPY operations
Assembler language GETL example
TERM
Example of the TERM call instruction
Parameter values that are set by the application
Parameter values that are returned to the application
Guidelines for TERM results
Application tasks for the TERM request
FTP client API for C functions
FAPI_INIT
FAPI_INIT example:
FAPI_SCMD
FAPI_SCMD example:
FAPI_POLL
FAPI_POLL example:
FAPI_GETL_COPY
FAPI_GETL_COPY example:
FAPI_GETL_FIND
FAPI_GETL_FIND example:
FAPI_TERM
FAPI_TERM example:
FTP client API for REXX function
Handling of SIGCHLD signals
FTP client API for REXX trace
Specifying the FTP client API for REXX trace output location
Specifying the FTP client API for REXX trace output location: TSO environment
Specifying the FTP client API for REXX trace output location: z/OS UNIX shell environment
Specifying the FTP client API for REXX trace output location: MVS batch job environment
Specifying the FTP client API for REXX trace output location: z/OS UNIX environment batch job
FTP client API requests
CREATE request
INIT request
SCMD request
POLL request
GETL_FIND request
GETL_COPY request
SET_TRACE request
SET_REQUEST_TIMER request
GET_FCAI_MAP request
TERM request
FTP client API for REXX trace return codes
Output register information for the FTP client API
FTP client API: Other output that is returned to the application
Prompts from the client
Prompts not used by the FTP client API
Prompts returned in FCAI-Status
FTP client API command prompt
FTP client API messages and replies
Interpreting results from an interface request
FCAI request completion values
Considerations when evaluating request completion values
Programming notes for the FTP client API
FCAI_Status_TraceFailed and FCAI_TraceStatus: Reporting failures in the interface trace function
FCAI_IE_LengthInvalid: Improper lengths passed to the interface
FCAI_ReqTimer: Controlling requests that retrieve results from the created z/OS FTP client process
FCAI_PollWait: Specifying a wait time before POLL
FCAI_IE_InternalErr: Unanticipated exceptional conditions in the interface
Exceptional conditions in the z/OS FTP client
Using the FTP client API trace
FTP client API sample programs
Network management interfaces
Local IPSec NMI
Local IPSec NMI: Configuring the interface
Local IPSec NMI: Connecting to the server
IPSec NMI request/response format
IPSec NMI request and response data structures
IPSec NMI request and response message format
IPSec NMI request messages
IPSec NMI monitoring request format
IPSec NMI control request formats
NMsec_ACTIVATE_IPTUNMANUAL
NMsec_ACTIVATE_IPTUNDYN
NMsec_DEACTIVATE_IPTUNMANUAL
NMsec_DEACTIVATE_IPTUNDYN
NMsec_DEACTIVATE_IKETUN
NMsec_REFRESH_IPTUNDYN
NMsec_REFRESH_IKETUN
NMsec_LOAD_POLICY
IPSec NMI response messages
NMsec_GET_STACKINFO
NMsec_GET_SUMMARY
NMsec_GET_IPFLTCURR, NMsec_GET_IPFLTDEFAULT, and NMsec_GET_IPFLTPOLICY
NMsec_GET_PORTTRAN
NMsec_GET_IPTUNMANUAL
NMsec_GET_IPTUNDYNSTACK
NMsec_GET_IPTUNDYNIKE
NMsec_GET_IKETUN
NMsec_GET_IKETUNCASCADE
NMsec_GET_IPINTERFACES
NMsec_GET_IKENSINFO
NMsec_LOAD_POLICY
NMsec_ACTIVATE_IPTUNMANUAL, NMsec_ACTIVATE_IPTUNDYN, NMsec_DEACTIVATE_IPTUNMANUAL, NMsec_DEACTIVATE_IPTUNDYN, NMsec_DEACTIVATE_IKETUN, NMsec_REFRESH_IPTUNDYN, NMsec_REFRESH_IKETUN
IPSec NMI initialization and termination messages
IPSec NMI return and reason codes
Network security services (NSS) network management NMI
Network security services NMI: Configuring the interface
Network security services NMI: Connecting to the server
Network security services NMI request and response format
Network security services NMI request messages
Network security services NMI response messages
NMsec_GET_CLIENTINFO
Network security services NMI initialization and termination messages
Network security services NMI return and reason codes
Real-time application-controlled TCP/IP trace NMI (EZBRCIFR)
Real-time control NMI: Overview
Real-time control NMI: Configuration and enablement
TCP/IP stack configuration
SAF resource names for NMI resources
Real-time control NMI: Invoking the requests
Requirements
EZBRCIFR invocation format
EZBRCIFR parameters
Common EZBRCIFR return and reason codes
Real-time control NMI: Requests
Common request requirements
RCCOpen - Open a trace instance
Input
Output
Example
RCCSetFilters - Set trace filters and options
Input
Output
Example
RCCStart - Start trace collection
RCCGetRecords - Get the real-time trace records
Input
Output
Example
Format of trace records
Lost records
Segmented records
RCCStop - Stop trace collection
Input
Output
Example
RCCClose - Close a trace instance
Input
Output
Example
Real-time TCP/IP network monitoring NMI
Steps for using the real-time NMI
Connecting to the AF_UNIX stream socket
Obtaining the real-time data
Real-time NMI: Configuration and enablement
Authorizing the applications
Verifying authorization for applications that connect to the real-time interface
Verifying authorization for applications that invoke the TMI copy buffer interface
Real-time NMI: Connecting to the server
Real-time NMI: Interacting with the servers
Real-time NMI: Common record header
Real-time NMI: Requests sent by the client to the server
Real-time NMI: Records sent by the server to the client
Records sent by the server to the client: Initialization record
Records sent by the server to the client: Termination record
Records sent by the server to the client: Token record
Real-time NMI: Copying the real-time data
EZBTMIC1 or EZBTMIC4: Copy real-time data for assembler applications
EZBTMIC1 requirements
EZBTMIC4 requirements
EZBTMIC1 format
EZBTMIC4 format
EZBTMIC1 or EZBTMIC4 parameters
EZBTMIC1 or EZBTMIC4 usage notes
TMI_CopyBuffer: Copy real-time data for C/C++ applications
TMI_CopyBuffer format
TMI_CopyBuffer parameters
TMI_CopyBuffer usage notes
Real-time NMI: Processing the output records
Format of common portion of output records
Format of service-specific portion of output records
Processing the cte records for SYSTCPDA and SYSTCPOT
Processing SYSTCPDA and SYSTCPOT trace records in a buffer
Processing the cte records for SYSTCPCN
Processing the cte records for SYSTCPSM
Real-time SMF NMI: FTP SMF type 119 subtypes 100-104 record formats
Real-time SMF NMI: FTP server transfer initialization record (subtype 100)
Real-time SMF NMI: FTP client transfer initialization record (subtype 101)
Real-time SMF NMI: FTP client login failure record (subtype 102)
Real-time SMF NMI: FTP client session record (subtype 103)
Real-time SMF NMI: FTP server session record (subtype 104)
Resolver NMI (EZBREIFR)
Resolver NMI: Overview
Resolver NMI: Configuration and enablement
Resolver NMI: Using the EZBREIFR requests
EZBREIFR requirements
EZBREIFR format
EZBREIFR parameters
Resolver NMI: Request and response formats
Resolver NMI: Requests
Resolver NMI: Responses
GetResolverConfig response contents
Resolver NMI: Request and response data structures
Resolver NMI: Examples
SMF records
SMF type 109 records
SMF type 118 records
SMF type 119 records
SNA network monitoring NMI
SNA network monitoring NMI configuration
SNA network monitoring NMI: Enabling and disabling the interface
SNA network monitoring NMI: Communicating with the server
SNA network monitoring NMI request/response format
SNA network monitoring NMI request format
SNA network monitoring NMI response format
SNA network monitoring NMI request and response data structures and records
SNA network monitoring NMI initialization record
SNA network monitoring NMI termination record
SNA network monitoring NMI EE summary response record
SNA network monitoring NMI EE connection response record
SNA network monitoring NMI HPR connection response record
SNA network monitoring NMI CSM statistics response record
NMI request errors
TCP/IP callable NMI (EZBNMIFR)
EZBNMIFR overview
EZBNMIFR: Poll-type requests
EZBNMIFR: Action-type requests
EZBNMIFR: Configuration and enablement
Using the EZBNMIFR requests
EZBNMIFR requirements
EZBNMIFR format
EZBNMIFR parameters
TCP⁄IP NMI request format
Format and details for poll-type requests
Filter request section
Filter example
Format and details for action-type requests
TCP⁄IP NMI response format
TCP/IP NMI request and response data structures
TCP/IP NMI examples
Trace record formatting NMI (EZBCTAPI)
EZBCTAPI NMI: Configuration and enablement
EZBCTAPI NMI: Invoking the interface
EZBCTAPI NMI requirements
EZBCTAPI NMI format
EZBCTAPI NMI parameters
EZBCTAPI NMI input register information
EZBCTAPI NMI output register information
EZBCTAPI NMI ABEND codes
EZBCTAPI NMI return and reason codes
EZBCTAPI NMI: Programming considerations
Real-time TCP/IP network monitoring NMI
Obtaining and formatting trace records
Packet trace records – format only headers
Real-time application-controlled TCP/IP trace NMI
Obtaining and formatting trace records
Packet trace records – format only headers
EZBCTAPI NMI Performance implications
EZBCTAPI NMI Example of using the EZBCTAPI NMI
EZBCTAPI NMI: Passing options to the trace formatter
Common real-time trace record attributes
Network management diagnosis
File storage locations
Application Transparent Transport Layer Security (AT-TLS)
CICS transaction considerations
Using the SIOCTTLSCTL ioctl
Starting AT-TLS on a connection
Stopping AT-TLS on a connection
Requesting AT-TLS queries and additional functions
Steps for implementing an aware server application
Steps for implementing a controlling server application
Coding the SIOCTTLSCTL ioctl
SIOCTTLSCTL (X'C038D90B')
Using the TTLSHeader control block
TTLSHeader fixed section
TTLSHeader variable length structure
Get request
SIOCTTLSCTL ioctl return values
SIOCTTLSCTL ioctl coding examples
SIOCTTLSCTL ioctl assembler example
SIOCTTLSCTL ioctl PL/I example
SIOCTTLSCTL ioctl COBOL example
SIOCTTLSCTL ioctl C example
Trusted TCP connections
Sysplex-specific connection routing information
Steps for retrieving connection routing information
Partner security credentials
Steps for retrieving partner security credentials
Programming requirements for the SO_CLUSTERCONNTYPE socket option
Programming requirements for the SIOCGPARTNERINFO and SIOCSPARTNERINFO ioctl calls
Coding the SO_CLUSTERCONNTYPE socket option
Coding the SIOCSPARTNERINFO and SIOCGPARTNERINFO ioctl calls
SIOCSPARTNERINFO (X'8004F613')
Input to SIOCSPARTNERINFO
Output from SIOCSPARTNERINFO
SIOCSPARTNERINFO return values
SIOCGPARTNERINFO (X'C000F612')
Input to SIOCGPARTNERINFO
Output from SIOCGPARTNERINFO
Using the partner information control block
SIOCGPARTNERINFO return values
Coding examples – SIOCSPARTNERINFO and SIOCGPARTNERINFO ioctl calls
Assembler example – SIOCGPARTNERINFO ioctl call
PL/I example – SIOCGPARTNERINFO ioctl call
COBOL example – SIOCGPARTNERINFO ioctl call
C example – SIOCSPARTNERINFO and SIOCGPARTNERINFO ioctl calls
Interfacing with the Digital Certificate Access Server (DCAS)
Understanding how clients interface to DCAS
Interfacing with the DCAS: Defining the format for request and response specifications
Configuring the DCAS server to work with your solution
Miscellaneous programming interfaces
SIOCSAPPLDATA IOCTL
SIOCSAPPLDATA input
SIOCSAPPLDATA output
SIOCSAPPLDATA C language example
SIOCSMOCTL IOCTL
SIOCSMOCTL input
SIOCSMOCTL output
Steps for creating an ancillary socket
Applications in a common INET environment
TCP_KeepAlive socket option
Well-known port assignments
Well-known UDP port assignments
Programming interfaces for providing classification data to be used in differentiated services policies
Passing application classification data on SENDMSG
Additional SENDMSG considerations
Type 109 SMF records
Type 118 SMF records
Standard subtype record numbers
TN3270E Telnet server SMF record layout
FTP server Type 118 SMF record layout
SMF record layout for API calls
SMF record layout for FTP client calls
SMF record layout for Telnet client calls
SMF record layout for TCPIPSTATISTICS
Type 119 SMF records
Mapping SMF records
Assembler applications
C/C++ applications
Processing SMF records for IP security
Common Type 119 SMF record format
SMF 119 record subtypes
Standard data format concepts
Common TCP/IP identification section
TCP connection initiation record (subtype 1)
TCP connection termination record (subtype 2)
FTP client transfer completion record (subtype 3)
TCP/IP profile event record (subtype 4)
Relationship to GetProfile Callable NMI
Continuing the SMF record
Two-phase SMF record creation for VIPADYNAMIC/ENDVIPADYNAMIC profile statement information
Cancelled configuration information
Data format concepts
TCP/IP profile record self-defining section
TCP/IP profile record TCP/IP stack identification section
TCP/IP profile record profile information common section
The NMTP_PICODepStmts and NMTP_PICODepChanged fields
TCP/IP profile record profile information data set name section
TCP/IP profile record autolog procedure section
TCP/IP profile record IPv4 configuration section
TCP/IP profile record IPv6 configuration section
TCP/IP profile record TCP configuration section
TCP/IP profile record UDP configuration section
TCP/IP profile record Global configuration section
TCP/IP profile record Port section
TCP/IP profile record interface section
TCP/IP profile record IPv6 address section
TCP/IP profile record Routing section
TCP/IP profile record source IP section
TCP/IP profile record management section
TCP/IP profile record IPSec common section
TCP/IP profile record IPSec rule section
TCP/IP profile record network access section
TCP/IP profile record dynamic VIPA (DVIPA) address section
TCP/IP profile record dynamic VIPA (DVIPA) routing section
TCP/IP profile record distributed dynamic VIPA (DVIPA) section
TCP/IP profile record policy table for IPv6 default address selection section
TCP/IP statistics record (subtype 5)
Interface statistics record (subtype 6)
Server port statistics record (subtype 7)
TCP/IP stack start/stop record (subtype 8)
UDP socket close record (subtype 10)
TN3270E Telnet server SNA session initiation record (subtype 20)
TN3270E Telnet server SNA session termination record (subtype 21)
TSO Telnet client connection initiation record (subtype 22)
TSO Telnet client connection termination record (subtype 23)
TN3270E Telnet server profile event record (subtype 24)
Relationship to GetTnProfile Callable NMI
Continuing the SMF record
Data format concepts
TN3270E Telnet server profile record self-defining section
TN3270E Telnet server profile record TCP/IP stack identification section
TN3270E Telnet server profile record profile information common section
TN320E Telnet server profile record profile information data set name section
TN3270E Telnet server profile record TelnetGlobals section
TN3270E Telnet server profile record TelnetParms section
TN3270E Telnet server profile record LU section
TN3270E Telnet server profile record LU Group section
TN3270E Telnet server profile record SLU Group section
TN3270E Telnet server profile record APPL group section
TN3270E Telnet server profile record Printer section
TN3270E Telnet server profile record PrintGroup section
TN3270 Telnet server profile record SPRTGROUP section
TN3270 Telnet server profile record ParmsGroup section
TN3270E Telnet server profile record MonitorGroup section
TN3270E Telnet server profile record Client Identifier structure
TN3270E Telnet server profile record LinkGroup section
TN3270E Telnet server profile record IpGroup section
TN3270E Telnet server profile record UserGroup section
TN3270E Telnet server profile record DestIPGroup section
TN3270E Telnet server profile record HnGroup section
TN3270E Telnet server profile record AllowAppl/RestrictAppl section
TN3270E Telnet server profile record DefaultAppl section
TN3270E Telnet server profile record PrtDefaultAppl section
TN3270E Telnet server profile record LineModeAppl section
TN3270E Telnet server profile record MapAppl section
TN3270E Telnet server profile record USSTCP section
TN3270E Telnet server profile record INTERPTCP section
TN3270E Telnet server profile record ParmsMap section
TN3270E Telnet server profile record LUMap section
TN3270E Telnet server profile record PrtMap section
TN3270E Telnet server profile record MonitorMap section
DVIPA status change record (subtype 32)
DVIPA removed record (subtype 33)
DVIPA target added record (subtype 34)
DVIPA target removed record (subtype 35)
DVIPA target server started record (subtype 36)
DVIPA target server ended record (subtype 37)
SMC-R link group statistics record (subtype 41)
SMC-R link state start record (subtype 42)
SMC-R link state end record (subtype 43)
RDMA network interface card (RNIC) interface statistics record (subtype 44)
CSSMTP configuration record (CONFIG subtype 48)
CSSMTP connection record (CONNECT subtype 49)
CSSMTP mail record (MAIL subtype 50)
CSSMTP spool file record (SPOOL subtype 51)
CSSMTP statistical record (STATS subtype 52)
FTP server transfer completion record (subtype 70)
FTP daemon configuration record (subtype 71)
FTP server logon failure record (subtype 72)
IPSec IKE tunnel activation and refresh record (subtype 73)
IPSec IKE tunnel deactivation and expire record (subtype 74)
IPSec dynamic tunnel activation and refresh record (subtype 75)
IPSec dynamic tunnel deactivation record (subtype 76)
IPSec dynamic tunnel added record (subtype 77)
IPSec dynamic tunnel removed record (subtype 78)
IPSec manual tunnel activation record (subtype 79)
IPSec manual tunnel deactivation record (subtype 80)
EZAENF80 Parameter list for ENF event code 80 listen exits
Application data
Identifying application data
CICS socket interface and listener application data
z/OS IP FTP client application data
FTP client application data format for the control connection
FTP client application data format for the data connection
FTP daemon application data format
FTP server application data format for the control connection
FTP server application data format for the data connection
Application data format for IP CICS sockets
Application data format for CSSMTP
TN3270E Telnet server application data
Application data format for Telnet
X Window System interface V11R4 and Motif version 1.1
Software requirements for X Window System interface V11R4 and Motif version 1.1
How the X Window System interface works in the MVS environment
X Window System interface in the MVS environment: Identifying the target display
X Window System interface in the MVS environment: Application resource file
X Window System interface in the MVS environment: Creating an application
X Window System header files
X Window System and Xt Intrinsics header files
Athena widget set header files
Motif header files
X Window System interface in the MVS environment: Compiling and linking
X Window System interface in the MVS environment: Nonreentrant modules
X Window System interface in the MVS environment: Reentrant modules
Using sample X Window System programs
X Window System Interface V11r4: Environment variables
Standard X client applications
Building X client modules
X Window System routines
X Window System routines: Opening and closing a display
X Window System routines: Creating and destroying windows
X Window System routines: Manipulating windows
X Window System routines: Changing window attributes
X Window System routines: Obtaining window information
X Window System routines: Obtaining properties and atoms
X Window System routines: Manipulating window properties
X Window System routines: Setting window selections
X Window System routines: Manipulating colormaps
X Window System routines: Manipulating color cells
X Window System routines: Creating and freeing pixmaps
X Window System routines: Manipulating graphics contexts
X Window System routines: Clearing and copying areas
X Window System routines: Drawing lines
X Window System routines: Filling areas
X Window System routines: Loading and freeing fonts
X Window System routines: Querying character string sizes
X Window System routines: Drawing text
X Window System routines: Transferring images
X Window System routines: Manipulating cursors
X Window System routines: Handling window manager functions
X Window System routines: Manipulating keyboard settings
X Window System routines: Controlling the screen saver
X Window System routines: Manipulating hosts and access control
X Window System routines: Handling events
X Window System routines: Enabling and disabling synchronization
X Window System routines: Using default error handling
X Window System routines: Communicating with window managers
X Window System routines: Manipulating keyboard event functions
X Window System routines: Manipulating regions
X Window System routines: Using cut and paste buffers
X Window System routines: Querying visual types
X Window System routines: Manipulating images
X Window System routines: Manipulating bit maps
X Window System routines: Using the resource manager
X Window System routines: Manipulating display functions
X Window System routines: Extension routines
X Window System routines: MIT extensions to X
X Window System routines: Associate table functions
X Window System routines: Miscellaneous utility routines
X Window System routines: X authorization routines
X Window System toolkit
Xt Intrinsics routines
X Window System toolkit: Application resources
X Window System routines: Athena widget support
X Window System routines: Motif-based widget support
X Window System routines: z/OS UNIX System Services support
X Window System routines: What is provided with z/OS UNIX System Services
X Window System routines: z/OS UNIX System Services software requirements
X Window System routines: z/OS UNIX System Services application resource file
Identifying the target display in z/OS UNIX System Services
Compiling and linking with z/OS UNIX System Services
Compiling and linking with z/OS UNIX System Services using c89
Standard X client applications for z/OS UNIX System Services
Application resources for z/OS UNIX System Services
Syslog daemon name/token pair and ECSA storage mapping
Related protocol specifications
Accessibility
Bibliography
Index for Communications Server: IP Programmer's Guide and Reference