Previous Page Contents Page Next Page

3.168 REMOVE_DLC_TRACE

This verb removes DLC line tracing that was previously specified using ADD_DLC_TRACE. It can be used to remove all tracing on a resource that is currently being traced, to remove the tracing of certain messages from a resource currently being traced, or to remove all DLC line tracing.

3.168.1 VCB Structure

typedef struct remove_dlc_trace
{
   AP_UINT16         opcode;                   /* verb operation code        */
   unsigned char     reserv2;                  /* reserved                   */
   unsigned char     format;                   /* reserved                   */
   AP_UINT16         primary_rc;               /* primary return code        */
   AP_UINT32         secondary_rc;             /* secondary return code      */
   DLC_TRACE_FILTER  filter;                   /* resource to stop tracing   */
} REMOVE_DLC_TRACE;

typedef struct dlc_trace_filter
{
   unsigned char     resource_type;            /* type of resource           */
   unsigned char     resource_name[8];         /* name of resource           */
   SNA_LFSID         lfsid;                    /* session identifier         */
   unsigned char     message_type;             /* type of messages           */
} DLC_TRACE_FILTER;

typedef struct sna_lfsid
{
      union
      {
          AP_UINT16            session_id;
          struct
          {
              unsigned char      sidh;
              unsigned char      sidl;
          } s;
      } uu;
      AP_UINT16       odai;
} SNA_LFSID;

3.168.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_REMOVE_DLC_TRACE

resource_type

The resource type of the trace entry to remove or modify. Possible values are:

AP_ALL_DLC_TRACES

Remove all DLC tracing options, so that no resources are traced. If this option is specified, the remaining parameters on this verb (resource_name through message_type) are reserved.

AP_ALL_RESOURCES

Remove or modify the tracing options used for tracing all DLCs, ports, and LSs; resources for which DLC_TRACE entries are explicitly defined will continue to be traced.

AP_DLC

Remove or modify tracing for the DLC named in resource_name , and for all ports and LSs that use this DLC.

AP_PORT

Remove or modify tracing for the port named in resource_name , and for all LSs that use this port.

AP_LS

Remove or modify tracing for the LS named in resource_name .

AP_RTP

Remove or modify tracing for the RTP (rapid transport protocol) connection named in resource_name.

AP_PORT_DEFINED_LS

Modify tracing for the port named in resource_name and its defined LSs.

AP_PORT_IMPLICIT_LS

Modify tracing for the port named in resource_name and its implicit LSs.

resource_name

The name of the DLC, port, LS, or RTP connection for which tracing is being removed or modified. This parameter is reserved if resource_type is set to AP_ALL_DLC_TRACES or AP_ALL_RESOURCES.

lfsid

The Local Form Session Identifier for a session on the specified LS. This is only valid for resource_type AP_LS, and indicates that only messages on this session are to be removed. The structure contains the following three values, which are returned in the SESSION_STATS section of a QUERY_SESSION verb:

lfsid.uu.s.sidh

Session ID high byte.

lfsid.uu.s.sidl

Session ID low byte.

lfsid.odai

Origin Destination Assignor Indicator.

message_type

The type of messages to trace for the specified resource or session. Set this parameter to AP_TRACE_ALL to remove all messages, or specify one or more of the following values (combined using a logical OR):

AP_TRACE_XID

XID messages

AP_TRACE_SC

Session Control RUs

AP_TRACE_DFC

Data Flow Control RUs

AP_TRACE_FMD

FMD messages

AP_TRACE_SEGS

Non-BBIU segments that do not contain an RH

AP_TRACE_CTL

Messages other then MUs and XIDs

AP_TRACE_NLP

(this message type is currently not used)

AP_TRACE_NC

(this message type is currently not used)

For tracing on an RTP connection, the values AP_TRACE_XID, AP_TRACE_NLP, and AP_TRACE_CTL are ignored.

3.168.3 Returned Parameters: Successful Execution

If the verb executes successfully, SNAP-IX returns the following parameters:

primary_rc

AP_OK

secondary_rc

Not used.

3.168.4 Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAP-IX returns one of the following.

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_INVALID_RESOURCE_TYPE

The resource_type parameter specified a value that was not valid.

AP_INVALID_MESSAGE_TYPE

The message_type parameter specified a value that was not valid.

AP_INVALID_DLC_NAME

The DLC named in resource_name does not have any tracing options set.

AP_INVALID_PORT_NAME

The Port named in resource_name does not have any tracing options set.

AP_INVALID_LS_NAME

The LS named in resource_name does not have any tracing options set.

AP_INVALID_RTP_CONNECTION

The RTP connection named in the resource_name parameter does not have any tracing options set.

AP_INVALID_LFSID_SPECIFIED

The LS named in resource_name does not have any tracing options set for the specified LFSID.

AP_INVALID_FILTER_TYPE

The message_type parameter specified a message type that is not currently being traced for the specified resource.

AP_ALL_RESOURCES_NOT_DEFINED

The resource_type parameter was set to AP_ALL_RESOURCES, but there is no DLC_TRACE entry defined for tracing options on all resources.

Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

3.168.5 Returned Parameters: Other Conditions

Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.

Previous Page Contents Page Top of Page Next page