The snmp_dpi_resp_packet Structure

Structure Definition

struct dpi_resp_packet {
  char                   error_code; /* like: SNMP_ERROR_xxx  */
  unsigned long int      error_index;/* 1st varBind in error  */
  #define resp_priority  error_index /* if respons to register*/
  struct dpi_set_packet *varBind_p;  /* ptr to varBind, chain */
                                     /* of dpi_set_packets    */
};
typedef struct dpi_resp_packet       snmp_dpi_resp_packet;
#define snmp_dpi_resp_packet_NULL_p  ((snmp_dpi_resp_packet *)0)

Structure Members

error_code

The return code or the error code.

See DPI RESPONSE Error Codes for a list of valid codes.

error_index
Specifies the first varBind is in error. Counting starts at 1 for the first varBind. This field should be zero (SNMP_ERROR_noError) if there is no error.
resp_priority
This is a redefinition of the error_index field. If the response is a response to a DPI REGISTER request and the error_code is equal to SNMP_ERROR_DPI_noError or SNMP_ERROR_DPI_higherPriorityRegistered, then this field contains the priority that was actually assigned. Otherwise, this field is set to zero for responses to a DPI REGISTER..
varBind_p
A pointer to the chain of one or more snmp_dpi_set_structures, representing varBinds of the response. This field contains a NULL pointer if there are no varBinds in the response.

Description

The snmp_dpi_resp_packet structure represents a parse tree for a DPI RESPONSE packet.

The snmp_dpi_resp_packet structure is normally created as a result of a call to pDPIpacket(). This is the case if the DPI packet is of type SNMP_DPI_RESPONSE. The snmp_dpi_hdr structure then contains a pointer to a snmp_dpi_resp_packet structure.

At the DPI subagent side, a DPI RESPONSE should only be expected at initialization and termination time when the subagent has issued a DPI OPEN, DPI REGISTER or DPI UNREGISTER request.

The DPI programmer is advised to use the mkDPIresponse() function to prepare a DPI RESPONSE packet.

Related Information

The pDPIpacket() Function The mkDPIresponse() Function
The snmp_dpi_set_packet Structure
The snmp_dpi_hdr Structure

---

[Back: The snmp_dpi_next_packet Structure]
[Next: The snmp_dpi_set_packet Structure]