packages/net/snmp/agent/v2_0/include/mibgroup/mibII/sysORTable.h

   1 //==========================================================================
   2 //
   3 //      ./agent/current/include/mibgroup/mibII/sysORTable.h
   4 //
   5 //
   6 //==========================================================================
   7 //####ECOSGPLCOPYRIGHTBEGIN####
   8 // -------------------------------------------
   9 // This file is part of eCos, the Embedded Configurable Operating System.
  10 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  11 //
  12 // eCos is free software; you can redistribute it and/or modify it under
  13 // the terms of the GNU General Public License as published by the Free
  14 // Software Foundation; either version 2 or (at your option) any later version.
  15 //
  16 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19 // for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License along
  22 // with eCos; if not, write to the Free Software Foundation, Inc.,
  23 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  24 //
  25 // As a special exception, if other files instantiate templates or use macros
  26 // or inline functions from this file, or you compile this file and link it
  27 // with other works to produce a work based on this file, this file does not
  28 // by itself cause the resulting work to be covered by the GNU General Public
  29 // License. However the source code for this file must still be made available
  30 // in accordance with section (3) of the GNU General Public License.
  31 //
  32 // This exception does not invalidate any other reasons why a work based on
  33 // this file might be covered by the GNU General Public License.
  34 //
  35 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  36 // at http://sources.redhat.com/ecos/ecos-license/
  37 // -------------------------------------------
  38 //####ECOSGPLCOPYRIGHTEND####
  39 //####UCDSNMPCOPYRIGHTBEGIN####
  40 //
  41 // -------------------------------------------
  42 //
  43 // Portions of this software may have been derived from the UCD-SNMP
  44 // project,  <http://ucd-snmp.ucdavis.edu/>  from the University of
  45 // California at Davis, which was originally based on the Carnegie Mellon
  46 // University SNMP implementation.  Portions of this software are therefore
  47 // covered by the appropriate copyright disclaimers included herein.
  48 //
  49 // The release used was version 4.1.2 of May 2000.  "ucd-snmp-4.1.2"
  50 // -------------------------------------------
  51 //
  52 //####UCDSNMPCOPYRIGHTEND####
  53 //==========================================================================
  54 //#####DESCRIPTIONBEGIN####
  55 //
  56 // Author(s):    hmt
  57 // Contributors: hmt
  58 // Date:         2000-05-30
  59 // Purpose:      Port of UCD-SNMP distribution to eCos.
  60 // Description:
  61 //
  62 //
  63 //####DESCRIPTIONEND####
  64 //
  65 //==========================================================================
  66 /********************************************************************
  67        Copyright 1989, 1991, 1992 by Carnegie Mellon University
  68
  69                           Derivative Work -
  70 Copyright 1996, 1998, 1999, 2000 The Regents of the University of California
  71
  72                          All Rights Reserved
  73
  74 Permission to use, copy, modify and distribute this software and its
  75 documentation for any purpose and without fee is hereby granted,
  76 provided that the above copyright notice appears in all copies and
  77 that both that copyright notice and this permission notice appear in
  78 supporting documentation, and that the name of CMU and The Regents of
  79 the University of California not be used in advertising or publicity
  80 pertaining to distribution of the software without specific written
  81 permission.
  82
  83 CMU AND THE REGENTS OF THE UNIVERSITY OF CALIFORNIA DISCLAIM ALL
  84 WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED
  85 WARRANTIES OF MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL CMU OR
  86 THE REGENTS OF THE UNIVERSITY OF CALIFORNIA BE LIABLE FOR ANY SPECIAL,
  87 INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
  88 FROM THE LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  89 CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  90 CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  91 *********************************************************************/
  92 /*
  93  *  Template MIB group interface - sysORTable.h
  94  *
  95  */
  96 #ifndef _MIBGROUP_SYSORTABLE_H
  97 #define _MIBGROUP_SYSORTABLE_H
  98
  99 config_require(util_funcs)
 100
 101 struct sysORTable {
 102    char *OR_descr;
 103    oid  *OR_oid;
 104    size_t  OR_oidlen;
 105    struct timeval OR_uptime;
 106    struct snmp_session *OR_sess;
 107    struct sysORTable *next;
 108 };
 109
 110 struct register_sysOR_parameters {
 111    oid  *name;
 112    int   namelen;
 113    const char *descr;
 114 };
 115
 116 extern void     init_sysORTable (void);
 117 extern FindVarMethod var_sysORTable;
 118 extern FindVarMethod var_sysORLastChange;
 119 extern int      register_sysORTable (oid *, size_t, const char *);
 120 extern int    unregister_sysORTable (oid *, size_t);
 121 extern int      register_sysORTable_sess (oid *, size_t, const char *, struct snmp_session *);
 122 extern int    unregister_sysORTable_sess (oid *, size_t, struct snmp_session *);
 123 extern void   unregister_sysORTable_by_session (struct snmp_session *);
 124
 125 #define SYSORTABLEINDEX                 1
 126 #define SYSORTABLEID                    2
 127 #define SYSORTABLEDESCR                 3
 128 #define SYSORTABLEUPTIME                4
 129
 130 #define SYS_ORTABLE_REGISTERED_OK              0
 131 #define SYS_ORTABLE_REGISTRATION_FAILED       -1
 132 #define SYS_ORTABLE_UNREGISTERED_OK            0
 133 #define SYS_ORTABLE_NO_SUCH_REGISTRATION      -1
 134
 135 #ifdef  USING_MIBII_SYSORTABLE_MODULE
 136 #define REGISTER_SYSOR_ENTRY(theoid, descr)                      \
 137   (void)register_sysORTable(theoid, sizeof(theoid)/sizeof(oid), descr);
 138 #define REGISTER_SYSOR_TABLE(theoid, len, descr)                      \
 139   (void)register_sysORTable(theoid, len, descr);
 140
 141 #else
 142 #define REGISTER_SYSOR_ENTRY
 143 #define REGISTER_SYSOR_TABLE
 144 #endif /* USING_MIBII_SYSORTABLE_MODULE */
 145 #endif /* _MIBGROUP_SYSORTABLE_H */