agt_ypsnmp.h

Go to the documentation of this file.

/*****************************************************************************
Various copyrights apply to this package, listed in various separate
parts below.  Please make sure that you read all the parts.
 
---- Part 1: Sparta, Inc (BSD) -----
 
Copyright (c) 2003-2010, Sparta, Inc
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
*  Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 
*  Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
*  Neither the name of Sparta, Inc nor the names of its contributors may
   be used to endorse or promote products derived from this software
   without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``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 COPYRIGHT HOLDERS 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.
 
---- Part 2: ScienceLogic, LLC (BSD) ----
 
Copyright (c) 2006, ScienceLogic, LLC
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
*  Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 
*  Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
*  Neither the name of ScienceLogic, LLC nor the names of its
   contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``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 COPYRIGHT
HOLDERS 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.
*************************************************************************/
 
 
/*************************************************************************
   OVERVIEW
 
    This module implements an snmp abstraction layer that acts as a
    an intermediate between the yang data store and the snmp library.
    This module makes use of restconf apis to interface with the data
    store(s) and provides sort of a gateway functionality by converting
    requests and responses between snmp and restconf interface.
*************************************************************************/
 
 
/*
 * Copyright (c) 2016 - 2020, YumaWorks. Inc., All Rights Reserved.
 *
 * 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.
 */
 
#if defined(WITH_SNMP) && defined(WITH_RESTCONF)
#ifndef _H_agt_ypsnmp
#define _H_agt_ypsnmp
 
/*  FILE: agt_ypsnmp.h
*********************************************************************
*                                                                   *
*                         P U R P O S E                             *
*                                                                   *
*********************************************************************/
 
/*********************************************************************
*                                                                   *
*                   C H A N G E         H I S T O R Y               *
*                                                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
08-sep-16    rmb      Begun.
*/
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifndef _H_agt_ypsnmp_util
#include "agt_ypsnmp_util.h"
#endif
 
#ifndef _H_yangapi
#include "yangapi.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                                                   *
*                         C O N S T A N T S                         *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                             T Y P E S                             *
*                                                                   *
*********************************************************************/
 
 
/********************************************************************
*                                                                   *
*                        F U N C T I O N S                          *
*                                                                   *
*********************************************************************/
 
/* header only */
 
 
extern int
    ypsnmp_snmp_packet (int op_type,
                        netsnmp_session *session,
                        int reqid,
                        netsnmp_pdu *pdu,
                        void *magic);
 
 
extern int
    ypsnmp_check_packet (netsnmp_session * session,
                         netsnmp_transport *transport,
                         void *transport_data,
                         int transport_data_length);
 
 
extern int
    ypsnmp_check_parse (netsnmp_session * session,
                        netsnmp_pdu *pdu,
                        int result);
 
 
extern status_t
    agt_ypsnmp_init (void);
 
 
extern void
    agt_ypsnmp_cleanup (void);
 
 
extern void
    agt_ypsnmp_check_io (void);
 
 
extern status_t
    agt_ypsnmp_reply_handler (ses_cb_t *scb,
                              yangapi_cb_t *rcb,
                              rpc_msg_t *msg,
                              status_t result);
 
 
extern status_t
    agt_ypsnmp_notification_handler (agt_not_msg_t *notif);
 
 
extern status_t
    agt_ypsnmp_handle_request (ypsnmp_agent_session_t *asp);
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif  // _H_agt_ypsnmp
#endif  // defined(WITH_SNMP) && defined(WITH_RESTCONF)