source: npl/monitoring/syn3_snmp_subagent/subagent/syn3FacilitiesTable/syn3FacilitiesTable.h

/*
 * Note: this file originally auto-generated by mib2c using
 *       version : 14170 $ of $
 *
 * $Id:$
 */
#ifndef SYN3FACILITIESTABLE_H
#define SYN3FACILITIESTABLE_H

#ifdef __cplusplus
extern "C" {
#endif


/** @addtogroup misc misc: Miscellaneous routines
 *
 * @{
 */
#include <net-snmp/library/asn1.h>

/* other required module components */
    /* *INDENT-OFF*  */
config_add_mib(SYN3-MIB)
config_require(SYN3-MIB/syn3FacilitiesTable/syn3FacilitiesTable_interface)
config_require(SYN3-MIB/syn3FacilitiesTable/syn3FacilitiesTable_data_access)
config_require(SYN3-MIB/syn3FacilitiesTable/syn3FacilitiesTable_data_get)
config_require(SYN3-MIB/syn3FacilitiesTable/syn3FacilitiesTable_data_set)
    /* *INDENT-ON*  */

/* OID and column number definitions for syn3FacilitiesTable */
#include "syn3FacilitiesTable_oids.h"

/* enum definions */
#include "syn3FacilitiesTable_enums.h"

/* *********************************************************************
 * function declarations
 */
void init_syn3FacilitiesTable(void);
void shutdown_syn3FacilitiesTable(void);

/* *********************************************************************
 * Table declarations
 */
/**********************************************************************
 **********************************************************************
 ***
 *** Table syn3FacilitiesTable
 ***
 **********************************************************************
 **********************************************************************/
/*
 * SYN3-MIB::syn3FacilitiesTable is subid 1 of syn3Facilities.
 * Its status is Current.
 * OID: .1.3.6.1.4.1.31337.1.2.1, length: 10
*/
/* *********************************************************************
 * When you register your mib, you get to provide a generic
 * pointer that will be passed back to you for most of the
 * functions calls.
 *
 * TODO:100:r: Review all context structures
 */
    /*
     * TODO:101:o: |-> Review syn3FacilitiesTable registration context.
     */
typedef netsnmp_data_list syn3FacilitiesTable_registration;

/**********************************************************************/
/*
 * TODO:110:r: |-> Review syn3FacilitiesTable data context structure.
 * This structure is used to represent the data for syn3FacilitiesTable.
 */
/*
 * This structure contains storage for all the columns defined in the
 * syn3FacilitiesTable.
 */
typedef struct syn3FacilitiesTable_data_s {
    
        /*
         * syn3FacilityStatus(2)/DisplayString/ASN_OCTET_STR/char(char)//L/A/w/e/R/d/H
         */
   char   syn3FacilityStatus[255];
size_t      syn3FacilityStatus_len; /* # of char elements, not bytes */
    
        /*
         * syn3FacilityDescription(3)/DisplayString/ASN_OCTET_STR/char(char)//L/A/w/e/R/d/H
         */
   char   syn3FacilityDescription[255];
size_t      syn3FacilityDescription_len; /* # of char elements, not bytes */
    
        /*
         * syn3FacilityAck(4)/DisplayString/ASN_OCTET_STR/char(char)//L/A/w/e/R/d/H
         */
   char   syn3FacilityAck[255];
size_t      syn3FacilityAck_len; /* # of char elements, not bytes */
    
} syn3FacilitiesTable_data;


/*
 * TODO:120:r: |-> Review syn3FacilitiesTable mib index.
 * This structure is used to represent the index for syn3FacilitiesTable.
 */
typedef struct syn3FacilitiesTable_mib_index_s {

        /*
         * syn3FacilityName(1)/DisplayString/ASN_OCTET_STR/char(char)//L/A/w/e/R/d/H
         */
        /** 128 - 0(other indexes) - oid length(12) = 115 */
   char   syn3FacilityName[115];
   size_t      syn3FacilityName_len;


} syn3FacilitiesTable_mib_index;

    /*
     * TODO:121:r: |   |-> Review syn3FacilitiesTable max index length.
     * If you KNOW that your indexes will never exceed a certain
     * length, update this macro to that length.
     *
     * BE VERY CAREFUL TO TAKE INTO ACCOUNT THE MAXIMUM
     * POSSIBLE LENGHT FOR EVERY VARIABLE LENGTH INDEX!
     * Guessing 128 - col/entry(2)  - oid len(10)
*/
#define MAX_syn3FacilitiesTable_IDX_LEN     116


/* *********************************************************************
 * TODO:130:o: |-> Review syn3FacilitiesTable Row request (rowreq) context.
 * When your functions are called, you will be passed a
 * syn3FacilitiesTable_rowreq_ctx pointer.
 */
typedef struct syn3FacilitiesTable_rowreq_ctx_s {

    /** this must be first for container compare to work */
    netsnmp_index        oid_idx;
    oid                  oid_tmp[MAX_syn3FacilitiesTable_IDX_LEN];
    
    syn3FacilitiesTable_mib_index        tbl_idx;
    
    syn3FacilitiesTable_data              data;

    /*
     * flags per row. Currently, the first (lower) 8 bits are reserved
     * for the user. See mfd.h for other flags.
     */
    u_int                       rowreq_flags;

    /*
     * TODO:131:o: |   |-> Add useful data to syn3FacilitiesTable rowreq context.
     */
    
    /*
     * storage for future expansion
     */
    netsnmp_data_list             *syn3FacilitiesTable_data_list;

} syn3FacilitiesTable_rowreq_ctx;

typedef struct syn3FacilitiesTable_ref_rowreq_ctx_s {
    syn3FacilitiesTable_rowreq_ctx *rowreq_ctx;
} syn3FacilitiesTable_ref_rowreq_ctx;

/* *********************************************************************
 * function prototypes
 */
    int syn3FacilitiesTable_pre_request(syn3FacilitiesTable_registration * user_context);
    int syn3FacilitiesTable_post_request(syn3FacilitiesTable_registration * user_context,
        int rc);

    int syn3FacilitiesTable_rowreq_ctx_init(syn3FacilitiesTable_rowreq_ctx *rowreq_ctx,
                                   void *user_init_ctx);
    void syn3FacilitiesTable_rowreq_ctx_cleanup(syn3FacilitiesTable_rowreq_ctx *rowreq_ctx);


    syn3FacilitiesTable_rowreq_ctx *
                  syn3FacilitiesTable_row_find_by_mib_index(syn3FacilitiesTable_mib_index *mib_idx);

extern oid syn3FacilitiesTable_oid[];
extern int syn3FacilitiesTable_oid_size;


#include "syn3FacilitiesTable_interface.h"
#include "syn3FacilitiesTable_data_access.h"
#include "syn3FacilitiesTable_data_get.h"
#include "syn3FacilitiesTable_data_set.h"

/*
 * DUMMY markers, ignore
 *
 * TODO:099:x: *************************************************************
 * TODO:199:x: *************************************************************
 * TODO:299:x: *************************************************************
 * TODO:399:x: *************************************************************
 * TODO:499:x: *************************************************************
 */

#ifdef __cplusplus
}
#endif

#endif /* SYN3FACILITIESTABLE_H */
/** @} */