z/OS Communications Server: IP Programmer's Guide and Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


RCCStart - Start trace collection

z/OS Communications Server: IP Programmer's Guide and Reference
SC27-3659-02

Use this request to cause the TCP/IP stack to start collecting trace records based on the trace types, filters, and options that were set by the RCCSetFilters request. The trace records are written to the staging buffer of the trace instance. Your application can invoke the RCCGetRecords request to obtain the trace records that the TCP/IP stack collects.

Rules:
  • If a RCCSetFilters request has not been successfully processed for the trace instance, the RCCStart request fails.
  • The staging buffer statistics are initialized as part of the RCCStart processing. Any records remaining in the staging buffer are lost. If your application had previously invoked the RCCStop request to stop a trace, the application must invoke the RCCGetRecords request to obtain all the records currently in the staging buffer before invoking the RCCStart request; otherwise, the records are lost.
Guideline: If the trace collection has been started, your network management application should immediately invoke the RCCGetRecords request to start obtaining the trace records. A delay in invoking the RCCGetRecords request might result in lost trace records.
This request performs the following actions:
  • Set the status of the trace to active.

Input

  • RCCHeader structure

    The RCHRRequest field is set to RCCStart

Output

  • If the request is successful, no additional output is returned.
  • If the request fails, use the list of error return code and reason codes in Table 1 and Table 1 to determine the cause of the failure.
Table 1. RCCStart Return values, return codes, and reason codes
Return code Return code value Reason code Reason code value Meaning
EINVAL 0121 (X'079') JrOutOfSequence 29544 (X'7368') Request out of sequence. This error is returned for the following reasons:
  • The request was invoked for a trace instance, for which no filters have been set. In this case, invoke the RCCSetFilters request before invoking the RCCStart request.
  • The request was invoked for an active trace instance.
ENOMEM 0132 (X'084') JRTcpError 00657 (X'0291') Storage is not available in the TCP/IP address space for internal control blocks.

Example

The following assembler program example shows how to invoke the RCCStart request:
***********************************************************************         
*        RCCStart request                                             *         
*                                                                     *         
*        The RCCHeader is reused from the RCCOpen request.            *         
*                                                                     *         
***********************************************************************         
Start    DS    0H                                                               
         MVI   RCHRRequest,RCCStart     Setup request header                   
         XR    R0,R0                    No other input structures                           
         STH   R0,RCHRNum                                                       
         LHI   R0,RCHRSize              Size of header                  
         ST    R0,DynReqLn                                                      
*                                                                               
         EZBRCIFR RCCHeader,DynReqLn,                                  X        
               DynRtVal,DynRtCde,DynRtRsn,                             X        
               MF=(E,DynRcIfr)          Issue RCCStart request                  
         LT    R15,DynRtVal             Did it work?                            
         JNZ   ErrRtn                   Error                                   
.                                                                               
.                                                                               
                                                                                
DynRcIfr EZBRCIFR MF=L                  RCC API parameter list                  
DynReqLn DS    F                        Length of request input               
DynRtVal DS    F                        Return value                            
DynRtCde DS    F                        Return Code                             
DynRtRsn DS    F                        Reason Code                             
DynRccH  DS    XL(RCHRSize)             Space for the RCC header 

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014