daqctl v2 library : ksnmplib

The KLOE DAQ specific snmp routines version 2.

Library name : ksnmplib

Author : Enrico Pasqualucci

This library contains all the routines used by the KLOE run control and DFC processes and based on the SNMP utility. It is based on SNMP version 2 by CMU. The library structure has been completely reviewed in such a way that the snmp session and remote process variable management can be completely hidden to the user. The source itself has been logically divided into several files; in the following the documentation of the entry points has been divided per-files.

Have also a look to the example programs :

     mapnet.c
     rget.c
     snmpset.c
     timeval.c
     toproc.c

A more general (and simpler) example of how to retrieve the value of a remote variable can be found in:

     getvalue.c

In the following file an example of how to send a trap to the KLOE dfc daemon can be found:

     ktrap.c

A simple extension of trap daemon (first standalone version of the KLOE dfc daemon) can be found in:

     dfcd.c

To evaluate the time needed to send commands and to react to traps, the following programs have been used:

     commtime.c
     traptime.c

ksnmplib application interface version 2

File name : ksnmp_api.c

Author : Enrico Pasqualucci

This part of the library contains the functions to initialize and end the ksnmp library and to perform simple snmp operation in the standard KLOE environment.

Entry points:

• ksnmp_init()
• ksnmp_end()
• ksnmp_get_next()
• ksnmp_get()
• ksnmp_set()

ksnmplib environment interface version 2

File name : ksnmp_environment.c

Author : Enrico Pasqualucci

This part of the library contains the function to read the enviromental variables that can superseed the default global variable values and to set that variables.

Entry points:

• ksnmp_getenv()

ksnmplib network map management version 2

File name : ksnmp_map.c

Author : Enrico Pasqualucci

This part of the library contains the functions to manage the map of the KLOE network.

Entry points:

• ksnmp_map_init()
• ksnmp_map_close_knode_sessions()
• ksnmp_map_close_sessions()
• ksnmp_map_free_network_map()
• ksnmp_map_print_network_map()
• ksnmp_map_init_knode_list()
• ksnmp_map_init_srvs()
• ksnmp_map_network()
• ksnmp_map_network_remap()
• ksnmp_map_retrieve_network_map()
• ksnmp_map_get_arp_ss()
• ksnmp_map_get_switch_ss()

ksnmplib message system interface version 2

File name : ksnmp_message_system_interface.c

Author : Enrico Pasqualucci

This part of the library contains the functions directly used by the KLOE message system; in particular, to send remote messages and read acknowledgements.

Entry points:

• ksnmp_send_message()
• ksnmp_get_ack()
• ksnmp_wait_for_var_val()
• ksnmp_parse_message()
• ksnmp_parse_procname()

ksnmplib session management version 2

File name : ksnmp_session.c

Author : Enrico Pasqualucci

This part of the library contains the functions to manage the snmp sessions. This part of the library should be never used directly by the user, it takes care of opening the needed snmp sessions, keeping them in memory as a list, retrieving them when needed and closing them.

Entry points:

• ksnmp_session_init()
• ksnmp_session_add_to_list()
• ksnmp_session_find()
• ksnmp_session_close()
• ksnmp_session_close_all()
• ksnmp_session_remove_from_list()
• ksnmp_session_list_free()

ksnmplib remote variable management version 2

File name : ksnmp_vars.c

Author : Enrico Pasqualucci

This part of the library contains the functions to manage the remote process variables, taking care of searching the snmp names corresponding to them and keeping a list of remote indexes of requested variables. A function is provided to the user to read remote variables.

Entry points:

• ksnmp_vars_find()
• ksnmp_vars_add_to_list()
• ksnmp_vars_remove_from_list()
• ksnmp_vars_free_varlist()
• ksnmp_vars_read_variable()
• ksnmp_vars_search_remote_vlist()
• ksnmp_vars_get_remote_process_index()
• ksnmp_vars_get_remote_variable_index()

ksnmplib include files version 2

Author : Enrico Pasqualucci

• ksnmplib_protos.h
• ksnmp_api_protos.h
• ksnmp_environment_protos.h
• ksnmp_map_protos.h
• ksnmp_message_system_interface_protos.h
• ksnmp_session_protos.h
• ksnmp_vars_protos.h
• netmap.h
• default_parameters.h
• environmental.h