The snmp_dpi_set_packet Structure

Structure Definition

struct dpi_set_packet {
  char             *object_p;    /* ptr to Object ID (string) */
  char             *group_p;     /* ptr to sub-tree (group)   */
  char             *instance_p;  /* ptr to rest of OID        */
  unsigned char     value_type;  /* value type: SNMP_TYPE_xxx */
  unsigned short    value_len;   /* value length              */
  char             *value_p;     /* ptr to the value itself   */
  struct dpi_set_packet *next_p; /* ptr to next in chain      */
};
typedef struct dpi_set_packet       snmp_dpi_set_packet;
#define snmp_dpi_set_packet_NULL_p  ((snmp_dpi_set_packet *)0)

Structure Members

object_p

A pointer to a NULL terminated character string that represents the full OBJECT IDENTIFIER of the variable instance that is being accessed. It basically is a concatenation of the fields group_p and instance_p. Using this field is not recommended because it is only included for DPI Version 1 compatibility and it maybe withdrawn in a later version.
group_p
A pointer to a NULL terminated character string that represents the registered sub-tree that caused this SET, COMMIT, or UNDO request to be passed to this DPI subagent. The sub-tree must have a trailing dot.
instance_p
A pointer to a NULL terminated character string that represents the rest, which is the piece following the sub-tree part, of the OBJECT IDENTIFIER of the variable instance being accessed.

Use of the term instance_p here should not be confused with an OBJECT instance because this string may consist of a piece of the OBJECT IDENTIFIER plus the INSTANCE IDENTIFIER.

value_type
The type of the value.

See DPI SNMP Value Types for a list of currently defined value types.

value_len
This is an unsigned 16-bit integer that specifies the length in octets of the value pointed to by the value field. The length may be zero if the value if of type SNMP_TYPE_NULL.
value_p
A pointer to the actual value. This field may contain a NULL pointer if the value if of type SNMP_TYPE_NULL.

See Value Representation for information on how the data is represented for the various value types.

next_p
A pointer to a possible next snmp_dpi_set_packet structure. If this next field contains the NULL pointer, this is the end of the chain.

Description

The snmp_dpi_set_packet structure represents a parse tree for a DPI SET request.

The snmp_dpi_set_packet structure may be created as a result of a call to pDPIpacket(). This is the case if the DPI packet is of type SNMP_DPI_SET, SNMP_DPI_COMMIT or SNMP_DPI_UNDO. The snmp_dpi_hdr structure then contains a pointer to a chain of one or more snmp_dpi_set_packet structures.

This structure can also be created with a mkDPIset() call, which is typically used when preparing varBinds for a DPI RESPONSE packet.

Related Information

The pDPIpacket() Function The mkDPIset() Function
DPI SNMP Value Types
Value Representation
The snmp_dpi_hdr Structure

---

[Back: The snmp_dpi_resp_packet Structure]
[Next: The snmp_dpi_ureg_packet Structure]