PDU.hpp

Go to the documentation of this file.

// SNMPpp: https://sourceforge.net/p/snmppp/
// SNMPpp project uses the MIT license. See LICENSE for details.
// Copyright (C) 2013 Stephane Charette <stephanecharette@gmail.com>

#pragma once

#include <map>
#include <string>
#include <SNMPpp/net-snmppp.hpp>
#include <SNMPpp/OID.hpp>
#include <SNMPpp/Varlist.hpp>


namespace SNMPpp
{
    class PDU
    {
        public:

            enum EType
            {
                kInvalid        = 0                 ,
                kUnknown        = 0                 ,   // alias
                // SNMPv1 and higher:
                kGet            = SNMP_MSG_GET      ,   
                kGetNext        = SNMP_MSG_GETNEXT  ,   
                kResponse       = SNMP_MSG_RESPONSE ,   
                kSet            = SNMP_MSG_SET      ,   
                // SNMPv2 and higher:
                kGetBulk        = SNMP_MSG_GETBULK  ,   
                kInform         = SNMP_MSG_INFORM   ,   
                kTrap2          = SNMP_MSG_TRAP2    ,   
                kReport         = SNMP_MSG_REPORT       
            };

            virtual ~PDU( void );

            PDU( const EType t );

            PDU( netsnmp_pdu *p );

            virtual void free( void );

            virtual EType getType( void ) const { return type; }

            virtual void clear( void );

            virtual bool empty( void ) const;

            virtual PDU clone( void ) const;

            virtual operator netsnmp_pdu*( void ) { return pdu; }

            virtual const SNMPpp::Varlist varlist( void ) const;

            virtual SNMPpp::Varlist varlist( void );

            virtual operator netsnmp_variable_list *( void );

            virtual netsnmp_variable_list * operator[]( const size_t idx );

            virtual PDU &setVarlist( Varlist &vl );

            virtual PDU &setVarlist( netsnmp_variable_list *vl );

            // for convenience, expose a few of the Varlist members we're likely to use in simple cases

            virtual size_t size( void ) const;

            virtual bool contains( const SNMPpp::OID &o ) const;

            virtual SNMPpp::OID firstOID( void ) const;

            virtual PDU &addNullVar( const SNMPpp::OID &o );

            virtual PDU &addNullVars( const SNMPpp::SetOID &s );

            virtual PDU &addNullVars( const SNMPpp::VecOID &v );

        protected:

            EType type;
            netsnmp_pdu *pdu; // beware -- this pointer *can* be null if a PDU hasn't been defined or if it has been clear()
    };
};


std::ostream &operator<<( std::ostream &os, const SNMPpp::PDU &pdu );