snmp.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
 
/*
This file provides null functions for the SNMP counters and functions
to allow the system to compile without SNMP.
*/
 
#ifndef _NB_SNMP_H
#define _NB_SNMP_H
 
#ifdef ENABLE_SNMP 
#define SNMP
 
struct SNMP_Request; /* Forward declaration */
#include <snmp/asn1.h>
#include <snmp/mibII_vars.h>
#include <snmp/snmp_table.h>
#include <config_obj.h>
#include <servlets.h>
 
#define SNMPCOUNTIF(x,i) {InterfaceBlock * pif=GetInterfaceBlock(i); if(pif) pif->x++; }
#define SNMPCOUNT(x) (x++)
#define SNMPDEC(x) (x--)
#define SNMPADD(x,y) (x=x+y)
 
 
/*****************************************************************************
Start the snmp processor.
   int priority = the UCOS task priority to run at
Returns:
          0=CMD_OK
         -1=CMD_FAIL
 
*****************************************************************************/
[[deprecated]]int StartSnmpProcessor( int priority );
 
 
class SnmpServlet: public servlet
{ 
protected:
    int m_fd;         //fd to hold UDP Socket
    int m_port;
 
//Servlet virtual functions
       virtual int AddToSelectSet(fd_set &rd_set, fd_set &wr_set, fd_set &er_set);
       virtual void ProcessSelectResult(fd_set &rd_set, fd_set &wr_set, fd_set &er_set);
public:
        SnmpServlet(int port=161);
};
 
 
extern const char *SYSDESC;
extern const char *SYSOID;
 
 
class snmp_config : public config_obj
{
public:
    config_string  SysContact{"", "SysContact"};
    config_string  SysName{"", "SysName"};
    config_string  SysLocation{"", "SysLocation"};
    config_pass    ReadCommunity{"public", "ReadCommunity"};
    config_pass    WriteCommunity{"public", "WriteCommunity"};
    config_IPADDR4 trap_destination{"0.0.0.0", "TrapDest", "SNMP Trap destination"};
    config_bool    trap_enable_flags{false, "TrapEnable"};
    ConfigEndMarker;   // No new data members below this line
    snmp_config() : config_obj(sys,"SNMP", "SNMP Configuration") {bDirty=false;}
    bool bDirty;
};
 
extern snmp_config TheSnmpConfig;
 
 
#define READ_COMMUNITY_MASK (0x0001)
#define WRITE_COMMUNITY_MASK (0x0002)
 
/* Overwrite this function pointer to do your own more complex community name processing */
extern uint32_t ( *SnmpCommunityDecodeFunc )( const unsigned char *name );
 
 
/* Trap functionality */
 
class ASN; /* Forward definiton */
typedef  void  ( PutTrapVarBindsFunc )( ASN *put_asn );
 
 
/* Functions to send an SNMP trap */
/*
 
IPADDR dest the trap destination IP address, if passed in as NULL it uses the trap_destination value form the SysInfo structre
const char* community_name, the commu nity name to pass in the trap.
int generic_trap  The Geric trap number;
int specific_trap the specific trap number.
PutTrapVarBindsFunc * pDataCallbackFunction a function pointer to call back to fill in any custom trap varbinds.
See the examples\snmp program for an example of this.
*/
void SnmpBasicTrap( IPADDR dest,
                    const char *community_name,
                    int generic_trap,
                    int specific_trap );
void SnmpTrapWithData( IPADDR dest,
                       const char *community_name,
                       int generic_trap,
                       int specific_trap,
                       PutTrapVarBindsFunc *pDataCallbackFunction );
 
#else
/*
  This provides null functions for the SNMP counters and functions
  to allow the system to compile without SNMP.
*/
 
#define SNMPCOUNTIF(x,y) ((void)0)
#define SNMPCOUNT(x) ((void)0)
#define SNMPDEC(x) ((void)0)
#define SNMPADD(x, y) ((void)0)
     
#endif
#endif