mib_context.h

Go to the documentation of this file.

/*_############################################################################
  _## 
  _##  AGENT++ 4.0 - mib_context.h  
  _## 
  _##  Copyright (C) 2000-2013  Frank Fock and Jochen Katz (agentpp.com)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/

#ifndef _mib_context_h_
#define _mib_context_h_

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

#ifdef AGENTPP_NAMESPACE
namespace Agentpp {
#endif


/*--------------------------- class MibGroup --------------------------*/

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

class AGENTPP_DECL MibGroup: public MibEntry {
friend class Mib;  
public:
        MibGroup(const Oidx&);

        MibGroup(const Oidx&, const NS_SNMP OctetStr&);

        virtual ~MibGroup();

        mib_type                type() const;

        MibEntryPtr             add(MibEntryPtr item);  

        void                    remove(const Oidx&);
        
        
        ListCursor<MibEntry>    get_content();

        void                    clearAll();

        virtual void            load_from_file(const char*);

        virtual void            save_to_file(const char*);

        bool                    is_persistent() { return (persistencyName!=0);}

        NS_SNMP OctetStr        get_persistency_name()
                                        { return *persistencyName; }

        void                    set_timeout(unsigned int t) { timeout = t; }

        unsigned int            get_timeout() { return timeout; }

protected:

        List<MibEntry>  content;
        NS_SNMP OctetStr*       persistencyName;
        unsigned int    timeout;
};


/*--------------------------- class MibContext --------------------------*/

#if !defined (AGENTPP_DECL_TEMPL_OIDLIST_MIBENTRY)
#define AGENTPP_DECL_TEMPL_OIDLIST_MIBENTRY
        AGENTPP_DECL_TEMPL template class AGENTPP_DECL OidList<MibEntry>;
#endif
#if !defined (AGENTPP_DECL_TEMPL_OIDLIST_MIBGROUP)
#define AGENTPP_DECL_TEMPL_OIDLIST_MIBGROUP
        AGENTPP_DECL_TEMPL template class AGENTPP_DECL OidList<MibGroup>;
#endif

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

        MibContext(const NS_SNMP OctetStr&);

        virtual ~MibContext();

        virtual bool            init_from(const NS_SNMP OctetStr&);

        virtual bool            load_from(const NS_SNMP OctetStr&);

        virtual bool            save_to(const NS_SNMP OctetStr&);

        OidxPtr                 key();

        virtual MibEntry*       add(MibEntry*);

        virtual MibEntry*       remove(const Oidx&);

        virtual MibEntry*       get(const Oidx&);

        virtual MibEntry*       seek(const Oidx&);

        virtual int             find(const Oidx&, MibEntryPtr&);

        virtual int             find_lower(const Oidx&, MibEntryPtr&);

        virtual int             find_upper(const Oidx&, MibEntryPtr&);

        virtual MibEntry*       find_next(const Oidx&);

        OidListCursor<MibEntry>         get_content();

        OidListCursor<MibGroup>         get_groups();

        virtual MibGroup*               find_group(const Oidx&);

        virtual bool                    remove_group(const Oidx&);

        virtual MibGroup*       find_group_of(const Oidx&);

        NS_SNMP OctetStr                get_name() { return context; }

        unsigned int            get_num_groups() const
                                        { return groups.size(); }
        
        MibGroup*               get_group(int n)
            { return ((n>=0) && (n<groups.size())) ? groups.getNth(n) : 0; } 

        unsigned int            get_num_entries() const
                                        { return content.size(); }

 protected:
        OidList<MibEntry>               content;
        OidList<MibGroup>               groups; 
        Oidx                            contextKey;
        NS_SNMP OctetStr                context;
        NS_SNMP OctetStr*               persistencyPath;
};

#ifdef AGENTPP_NAMESPACE
}
#endif


#endif