Previous Page Contents Page Next Page

3.172 SET_CS_TRACE

This verb specifies tracing options for data sent between computers on the SNAP-IX LAN. For more information about tracing options, see the SNAP-IX Administration Guide.

This verb may be issued to a running node, or to a Solaris client computer on which the SNAP-IX software is running. To obtain a target handle for the client in order to issue this verb, use the CONNECT_NODE verb without specifying a node name; the NOF application must be running on the client.

On Windows clients, client-server tracing is controlled by options in the Windows Program Registry. For more information, see the SNAP-IX Administration Guide.

3.172.1 VCB Structure

typedef struct set_cs_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              */
   unsigned char    dest_sys[64];      /* node to which messages are traced  */
   unsigned char    reserv4[4];        /* reserved                           */
   AP_UINT16        trace_flags;       /* trace flags                        */
   AP_UINT16        trace_direction;   /* direction (send/rcv/both) to trace */
   unsigned char    reserv3[8];        /* reserved                           */
} SET_CS_TRACE;

3.172.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_SET_CS_TRACE

dest_sys

The server name for which tracing is required. This is an ASCII string, padded on the right with spaces if the name is shorter than 64 characters.

To manage tracing on messages flowing between the computer to which this verb is issued (identified by the target_handle parameter on the NOF API call) and one other server on the LAN, specify the name of the other server here. Tracing on messages flowing to and from other computers on the LAN will be unchanged; in particular, you can issue two SET_CS_TRACE verbs to activate tracing between the same target computer and two different destination servers.

To manage tracing on messages flowing between the computer to which this verb is issued (identified by the target_handle parameter on the NOF API call) and all other servers and clients on the LAN, set this parameter to 64 ASCII space characters. The options you specify on this verb override any previous settings for tracing to specific computers (identified by dest_sys on the previous verbs).

trace_flags

The types of tracing required. To turn off all tracing, or to turn on tracing of all types, specify one of the following values:

AP_NO_TRACE

No tracing.

AP_ALL_TRACE

Tracing of all types.

To activate tracing on specific message types, select one or more values from the list below, combined using a logical OR operation.

AP_CS_ADMIN_MSG

Internal messages relating to client-server topology

AP_CS_DATAGRAM

Datagram messages

AP_CS_DATA

Data messages

trace_direction

Specifies the direction(s) in which tracing is required. This parameter is ignored if trace_flags is set to AP_NO_TRACE. Possible values are:

AP_CS_SEND

Trace messages flowing from the target computer to the computer defined by dest_sys.

AP_CS_RECEIVE

Trace messages flowing from the computer defined by dest_sys to the target computer.

AP_CS_BOTH

Trace messages flowing in both directions.

3.172.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.172.4 Returned Parameters: Parameter Check

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

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_NAME_NOT_FOUND

The server specified by the dest_sys parameter did not exist or was not started.

AP_LOCAL_SYSTEM

The server specified by the dest_sys parameter is the same as the target node to which this verb was issued.

AP_INVALID_TRC_DIRECTION

The trace_direction parameter was not set to a valid value.

AP_INVALID_TARGET

The verb was issued on a standalone server. This verb can only be issued on a client-server system.

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

3.172.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