request.h

Go to the documentation of this file.

/*_############################################################################
  _## 
  _##  request.h  
  _## 
  _##
  _##  AGENT++ API Version 3.5.31
  _##  -----------------------------------------------
  _##  Copyright (C) 2000-2010 Frank Fock, Jochen Katz
  _##  
  _##  LICENSE AGREEMENT
  _##
  _##  WHEREAS,  Frank  Fock  and  Jochen  Katz  are  the  owners of valuable
  _##  intellectual  property rights relating to  the AGENT++ API and wish to
  _##  license AGENT++ subject to the  terms and conditions set forth  below;
  _##  and
  _##
  _##  WHEREAS, you ("Licensee") acknowledge  that Frank Fock and Jochen Katz
  _##  have the right  to grant licenses  to the intellectual property rights
  _##  relating to  AGENT++, and that you desire  to obtain a license  to use
  _##  AGENT++ subject to the terms and conditions set forth below;
  _##
  _##  Frank  Fock    and Jochen   Katz   grants  Licensee  a  non-exclusive,
  _##  non-transferable, royalty-free  license  to use   AGENT++ and  related
  _##  materials without  charge provided the Licensee  adheres to all of the
  _##  terms and conditions of this Agreement.
  _##
  _##  By downloading, using, or  copying  AGENT++  or any  portion  thereof,
  _##  Licensee  agrees to abide  by  the intellectual property  laws and all
  _##  other   applicable laws  of  Germany,  and  to all of   the  terms and
  _##  conditions  of this Agreement, and agrees  to take all necessary steps
  _##  to  ensure that the  terms and  conditions of  this Agreement are  not
  _##  violated  by any person  or entity under the  Licensee's control or in
  _##  the Licensee's service.
  _##
  _##  Licensee shall maintain  the  copyright and trademark  notices  on the
  _##  materials  within or otherwise  related   to AGENT++, and  not  alter,
  _##  erase, deface or overprint any such notice.
  _##
  _##  Except  as specifically   provided in  this  Agreement,   Licensee  is
  _##  expressly   prohibited  from  copying,   merging,  selling,   leasing,
  _##  assigning,  or  transferring  in  any manner,  AGENT++ or  any portion
  _##  thereof.
  _##
  _##  Licensee may copy materials   within or otherwise related   to AGENT++
  _##  that bear the author's copyright only  as required for backup purposes
  _##  or for use solely by the Licensee.
  _##
  _##  Licensee may  not distribute  in any  form  of electronic  or  printed
  _##  communication the  materials  within or  otherwise  related to AGENT++
  _##  that  bear the author's  copyright, including  but  not limited to the
  _##  source   code, documentation,  help  files, examples,  and benchmarks,
  _##  without prior written consent from the authors.  Send any requests for
  _##  limited distribution rights to fock@agentpp.com.
  _##
  _##  Licensee  hereby  grants  a  royalty-free  license  to  any  and   all 
  _##  derivatives  based  upon this software  code base,  that  may  be used
  _##  as a SNMP  agent development  environment or a  SNMP agent development 
  _##  tool.
  _##
  _##  Licensee may  modify  the sources  of AGENT++ for  the Licensee's  own
  _##  purposes.  Thus, Licensee  may  not  distribute  modified  sources  of
  _##  AGENT++ without prior written consent from the authors. 
  _##
  _##  The Licensee may distribute  binaries derived from or contained within
  _##  AGENT++ provided that:
  _##
  _##  1) The Binaries are  not integrated,  bundled,  combined, or otherwise
  _##     associated with a SNMP agent development environment or  SNMP agent
  _##     development tool; and
  _##
  _##  2) The Binaries are not a documented part of any distribution material. 
  _##
  _##
  _##  THIS  SOFTWARE  IS  PROVIDED ``AS  IS''  AND  ANY  EXPRESS OR  IMPLIED
  _##  WARRANTIES, INCLUDING, BUT NOT LIMITED  TO, THE IMPLIED WARRANTIES  OF
  _##  MERCHANTABILITY AND FITNESS FOR  A PARTICULAR PURPOSE  ARE DISCLAIMED.
  _##  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  _##  INDIRECT,   INCIDENTAL,  SPECIAL, EXEMPLARY,  OR CONSEQUENTIAL DAMAGES
  _##  (INCLUDING,  BUT NOT LIMITED  TO,  PROCUREMENT OF SUBSTITUTE  GOODS OR
  _##  SERVICES; LOSS OF  USE,  DATA, OR PROFITS; OR  BUSINESS  INTERRUPTION)
  _##  HOWEVER CAUSED  AND ON ANY THEORY  OF  LIABILITY, WHETHER IN CONTRACT,
  _##  STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  _##  IN  ANY WAY OUT OF  THE USE OF THIS  SOFTWARE,  EVEN IF ADVISED OF THE
  _##  POSSIBILITY OF SUCH DAMAGE. 
  _##
  _##
  _##  Stuttgart, Germany, Thu Sep  2 00:07:56 CEST 2010 
  _##  
  _##########################################################################*/

#ifndef request_h_
#define request_h_

#include <agent_pp/agent++.h>
#include <agent_pp/threads.h>
#include <agent_pp/snmp_pp_ext.h>
#include <agent_pp/List.h>
#include <agent_pp/mib_entry.h>

#define DEFAULT_WRITE_COMMUNITY "public"
#define DEFAULT_READ_COMMUNITY  "public"

#define PHASE_DEFAULT           0
#define PHASE_PREPARE           1
#define PHASE_COMMIT            2
#define PHASE_UNDO              3
#define PHASE_CLEANUP           4

#ifdef AGENTPP_NAMESPACE
namespace Agentpp {
#endif

#ifdef _SNMPv3
class Vacm;
#endif

/*--------------------------- class Request --------------------------*/

#if !defined (AGENTPP_DECL_TEMPL_ARRAY_MIBENTRY)
#define AGENTPP_DECL_TEMPL_ARRAY_MIBENTRY
        AGENTPP_DECL_TEMPL template class AGENTPP_DECL Array<MibEntry>;
#endif

#ifdef _THREADS
class AGENTPP_DECL Request: public Synchronized {
#else
class AGENTPP_DECL Request {
#endif
friend class RequestList;
friend class Mib;
public:

#ifdef _SNMPv3

        Request(const Pdux&, const NS_SNMP UTarget&);
#else

        Request(const Pdux&, const NS_SNMP CTarget&);
#endif

        Request(const Request&);

        virtual ~Request();

        virtual boolean         contains(const Vbx&);

        virtual int             position(const Vbx&);

        virtual boolean         finished() const;

        virtual boolean         is_done(int) const;

        virtual void            finish(int, const Vbx&);

        virtual void            finish(int);

        virtual void            set_ready(int);

        virtual void            unset_ready(int);

        virtual boolean         is_ready(int) const;

        virtual int             first_pending() const;

        virtual void            error(int, int);

#ifdef _SNMPv3

        virtual void            vacmError(int, int);
#endif

        virtual Vbx             get_value(int);

        Vbx*                    search_value(const Oidx&) const;

        Vbx                     get_original_value(unsigned int i)
                                        { return originalVbs[i]; }

        virtual NS_SNMP SnmpInt32       get_syntax(int);

        virtual Oidx            get_oid(int);

        virtual void            set_oid(const Oidx&, int);


        unsigned short  get_type()              { return pdu->get_type(); }

        unsigned long   get_request_id()   { return pdu->get_request_id(); }

        unsigned long   get_transaction_id()   { return transaction_id; }

        int             get_error_status() { return pdu->get_error_status(); }

        int             get_error_index()  { return pdu->get_error_index(); }

        void            set_error_status(int s) { pdu->set_error_status(s); }

        void            set_error_index(int i)  { pdu->set_error_index(i); }

        void            set_transaction_id(unsigned long id)
                                                { transaction_id = id; }

        int             subrequests() { return size; }


        int             get_non_rep() { return non_rep; }

        int             get_rep() { return repeater; }

        int             get_max_rep() { return max_rep; }


        virtual boolean         add_rep_row();

        virtual boolean         init_rep_row(int);

        virtual void            trim_request(int);

        void                    inc_outstanding();
        void                    dec_outstanding();

        void                    no_outstanding();

        Pdux*           get_pdu() { return pdu; }

#ifdef _SNMPv3

        void            get_security_name(NS_SNMP OctetStr& s);

        unsigned int    get_security_model() { return version; }

        void            init_vacm(Vacm*, const NS_SNMP OctetStr&);

        NS_SNMP OctetStr        get_view_name() const { return viewName; }

        NS_SNMP OctetStr        get_context() const { return pdu->get_context_name(); }

        NS_SNMP UTarget*        get_address() { return &target; }

#else

        NS_SNMP CTarget*        get_address() { return &target; }
#endif

        NS_SNMP snmp_version    get_snmp_version() { return version; }

        u_char          phase;

        MibEntry*       get_locked(int);

        void            set_locked(int, MibEntry*);

        void            set_unlocked(int);

        int             lock_index(MibEntry*);

        void            trim_bulk_response();

#ifdef NO_FAST_MUTEXES

        void            init_lock_queue();

        void            delete_lock_queue()
            { if (lockQueue) { delete lockQueue; lockQueue = 0; } }
#endif

protected:

        Request();

        virtual void    init_from_pdu();

        void            check_exception(int, Vbx&);

        int             get_max_response_length();

        Pdux*           pdu;
        Vbx*            originalVbs;
        int             originalSize;

        NS_SNMP UdpAddress      from;
        boolean*        done;
        boolean*        ready;
        int             outstanding;
        int             size;

        int             non_rep;
        int             max_rep;
        int             repeater;

        NS_SNMP snmp_version    version;
        unsigned long   transaction_id;

        // Locks hold by a mulit-phase (SET) request
        Array<MibEntry> locks;

#ifdef _SNMPv3
        NS_SNMP OctetStr        viewName;
        Vacm*           vacm;
        NS_SNMP UTarget         target;
#else
        NS_SNMP CTarget         target;
#endif
#ifdef NO_FAST_MUTEXES
        static LockQueue* lockQueue;
#endif
};


/*------------------------ class RequestList --------------------------*/

class AGENTPP_DECL RequestList: public ThreadManager {
public:
        RequestList();

        virtual ~RequestList();

        virtual void            set_address_validation(boolean);

        boolean                 get_address_validation()
            { return sourceAddressValidation; }

        virtual void            set_snmp(Snmpx* session) { snmp = session; }

        Snmpx*                  get_snmp() { return snmp; }

#ifdef _SNMPv3

        virtual void             set_v3mp(NS_SNMP v3MP* mp) { v3mp = mp; }


        virtual void             set_vacm(Vacm* v) { vacm = v; }

        virtual Vacm*           get_vacm() { return vacm; }

        virtual NS_SNMP v3MP*           get_v3mp() { return v3mp; }
#else

        void                    set_read_community(const NS_SNMP OctetStr&);

        void                    set_write_community(const NS_SNMP OctetStr&);

#endif

        virtual Request*                receive(int);

        virtual unsigned long   get_request_id(const Vbx&);

        virtual boolean         done(unsigned long, int, const Vbx&);

        virtual void            error(unsigned long, int, int);

        virtual Request*                get_request(unsigned long);

        virtual Request*                find_request_on_id(unsigned long);

        virtual void                    answer(Request*);

#ifdef _SNMPv3

        virtual void                    report(Request*);
#endif

        unsigned long                   create_transaction_id()
                                        { return next_transaction_id++; }

        boolean                         is_empty() { return requests->empty();}

        unsigned long                   size() { return requests->size(); }

        virtual void            remove_request(Request* req);

protected:
        virtual Request*                add_request(Request*);

        virtual boolean         community_ok(int, const NS_SNMP OctetStr&);

        virtual void    authenticationFailure(const NS_SNMP OctetStr& context,
                                              const NS_SNMP GenAddress& sourceAddress,
                                              int status);

        static void     null_vbs(Request* req);

        List<Request>*          requests;
        Snmpx*                  snmp;
#ifdef _SNMPv3
        Vacm*                   vacm;
        NS_SNMP v3MP*                   v3mp;
#endif
        NS_SNMP OctetStr*               write_community;
        NS_SNMP OctetStr*               read_community;

        unsigned long           next_transaction_id;

        boolean                 sourceAddressValidation;
};

#ifdef AGENTPP_NAMESPACE
}
#endif


#endif

---