include/snmp_api.h

   1 #ifndef SQUID_SNMP_API_H
   2 #define SQUID_SNMP_API_H
   3
   4 /***********************************************************
   5         Copyright 1989 by Carnegie Mellon University
   6
   7                       All Rights Reserved
   8
   9 Permission to use, copy, modify, and distribute this software and its
  10 documentation for any purpose and without fee is hereby granted,
  11 provided that the above copyright notice appear in all copies and that
  12 both that copyright notice and this permission notice appear in
  13 supporting documentation, and that the name of CMU not be
  14 used in advertising or publicity pertaining to distribution of the
  15 software without specific, written prior permission.
  16
  17 CMU DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  18 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  19 CMU BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  20 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  22 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  23 SOFTWARE.
  24 ******************************************************************/
  25
  26 /*
  27  * snmp_api.h - API for access to snmp.
  28  */
  29
  30 /*
  31  * Set fields in session and pdu to the following to get a default or unconfigured value.
  32  */
  33 #define SNMP_DEFAULT_COMMUNITY_LEN  0   /* to get a default community name */
  34 #define SNMP_DEFAULT_RETRIES        3
  35 #define SNMP_DEFAULT_TIMEOUT        1
  36 #define SNMP_DEFAULT_REMPORT        0
  37 #define SNMP_DEFAULT_PEERNAME       NULL
  38 #define SNMP_DEFAULT_ENTERPRISE_LENGTH  0
  39 #define SNMP_DEFAULT_TIME           0
  40 #define SNMP_DEFAULT_MAXREPETITIONS 5
  41 #define SNMP_DEFAULT_MACREPEATERS   0
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47     /* Parse the buffer pointed to by arg3, of length arg4, into pdu arg2.
  48      *
  49      * Returns the community of the incoming PDU, or NULL
  50      */
  51     u_char *snmp_parse(struct snmp_session *, struct snmp_pdu *, u_char *, int);
  52
  53     /* Encode pdu arg2 into buffer arg3.  arg4 contains the size of
  54      * the buffer.
  55      */
  56     int snmp_build(struct snmp_session *, struct snmp_pdu *, u_char *, int *);
  57
  58     /*
  59      * struct snmp_session *snmp_open(session)
  60      *      struct snmp_session *session;
  61      *
  62      * Sets up the session with the snmp_session information provided
  63      * by the user.  Then opens and binds the necessary UDP port.
  64      * A handle to the created session is returned (this is different than
  65      * the pointer passed to snmp_open()).  On any error, NULL is returned
  66      * and snmp_errno is set to the appropriate error code.
  67      */
  68 #if 0
  69     struct snmp_session *snmp_open(struct snmp_session *);
  70
  71     /*
  72      * int snmp_close(session)
  73      *     struct snmp_session *session;
  74      *
  75      * Close the input session.  Frees all data allocated for the session,
  76      * dequeues any pending requests, and closes any sockets allocated for
  77      * the session.  Returns 0 on error, 1 otherwise.
  78      */
  79     int snmp_close(struct snmp_session *);
  80
  81     /*
  82      * int snmp_send(session, pdu)
  83      *     struct snmp_session *session;
  84      *     struct snmp_pdu  *pdu;
  85      *
  86      * Sends the input pdu on the session after calling snmp_build to create
  87      * a serialized packet.  If necessary, set some of the pdu data from the
  88      * session defaults.  Add a request corresponding to this pdu to the list
  89      * of outstanding requests on this session, then send the pdu.
  90      * Returns the request id of the generated packet if applicable, otherwise 1.
  91      * On any error, 0 is returned.
  92      * The pdu is freed by snmp_send() unless a failure occured.
  93      */
  94     int snmp_send(struct snmp_session *, struct snmp_pdu *);
  95
  96     /*
  97      * void snmp_read(fdset)
  98      *     fd_set  *fdset;
  99      *
 100      * Checks to see if any of the fd's set in the fdset belong to
 101      * snmp.  Each socket with it's fd set has a packet read from it
 102      * and snmp_parse is called on the packet received.  The resulting pdu
 103      * is passed to the callback routine for that session.  If the callback
 104      * routine returns successfully, the pdu and it's request are deleted.
 105      */
 106     void snmp_read(fd_set *);
 107
 108     /*
 109      * int snmp_select_info(numfds, fdset, timeout, block)
 110      * int *numfds;
 111      * fd_set   *fdset;
 112      * struct timeval *timeout;
 113      * int *block;
 114      *
 115      * Returns info about what snmp requires from a select statement.
 116      * numfds is the number of fds in the list that are significant.
 117      * All file descriptors opened for SNMP are OR'd into the fdset.
 118      * If activity occurs on any of these file descriptors, snmp_read
 119      * should be called with that file descriptor set.
 120      *
 121      * The timeout is the latest time that SNMP can wait for a timeout.  The
 122      * select should be done with the minimum time between timeout and any other
 123      * timeouts necessary.  This should be checked upon each invocation of select.
 124      * If a timeout is received, snmp_timeout should be called to check if the
 125      * timeout was for SNMP.  (snmp_timeout is idempotent)
 126      *
 127      * Block is 1 if the select is requested to block indefinitely, rather than time out.
 128      * If block is input as 1, the timeout value will be treated as undefined, but it must
 129      * be available for setting in snmp_select_info.  On return, if block is true, the value
 130      * of timeout will be undefined.
 131      *
 132      * snmp_select_info returns the number of open sockets.  (i.e. The number of sessions open)
 133      */
 134     int snmp_select_info(int *, fd_set *, struct timeval *, int *);
 135
 136     /*
 137      * void snmp_timeout();
 138      *
 139      * snmp_timeout should be called whenever the timeout from snmp_select_info expires,
 140      * but it is idempotent, so snmp_timeout can be polled (probably a cpu expensive
 141      * proposition).  snmp_timeout checks to see if any of the sessions have an
 142      * outstanding request that has timed out.  If it finds one (or more), and that
 143      * pdu has more retries available, a new packet is formed from the pdu and is
 144      * resent.  If there are no more retries available, the callback for the session
 145      * is used to alert the user of the timeout.
 146      */
 147     void snmp_timeout(void);
 148
 149     /*
 150      * This routine must be supplied by the application:
 151      *
 152      * int callback(operation, session, reqid, pdu, magic)
 153      * int operation;
 154      * struct snmp_session *session;    The session authenticated under.
 155      * int reqid;                       The request id of this pdu (0 for TRAP)
 156      * struct snmp_pdu *pdu;            The pdu information.
 157      * void *magic                      A link to the data for this routine.
 158      *
 159      * Returns 1 if request was successful, 0 if it should be kept pending.
 160      * Any data in the pdu must be copied because it will be freed elsewhere.
 161      * Operations are defined below:
 162      */
 163
 164     void snmp_api_stats(void *);
 165 #endif
 166 #ifdef __cplusplus
 167 }
 168
 169 #endif
 170
 171 #endif                          /* SQUID_SNMP_API_H */