Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

netsnmp_mode_end_call(3) [suse man page]

mode_end_call(3)						     net-snmp							  mode_end_call(3)

NAME

       mode_end_call -

       At the end of a series of requests, call another handler hook.

   Functions
       netsnmp_mib_handler * netsnmp_get_mode_end_call_handler (netsnmp_mode_handler_list *endlist)
	   returns a mode_end_call handler that can be injected into a given handler chain.
       netsnmp_mode_handler_list * netsnmp_mode_end_call_add_mode_callback (netsnmp_mode_handler_list *endlist, int mode, netsnmp_mib_handler
	   *callbackh)
	   adds a mode specific callback to the callback list.
       int netsnmp_mode_end_call_helper (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info *reqinfo,
	   netsnmp_request_info *requests)

Detailed Description
       At the end of a series of requests, call another handler hook.

       Handlers that want to loop through a series of requests and then receive a callback at the end of a particular MODE can use this helper to
       make this possible. For most modules, this is not needed as the handler itself could perform a for() loop around the request list and then
       perform its actions afterwards. However, if something like the serialize helper is in use this isn't possible because not all the requests
       for a given handler are being passed downward in a single group. Thus, this helper *must* be added above other helpers like the serialize
       helper to be useful.

       Multiple mode specific handlers can be registered and will be called in the order they were regestered in. Callbacks regesterd with a mode
       of NETSNMP_MODE_END_ALL_MODES will be called for all modes.

Function Documentation
   netsnmp_mib_handler* netsnmp_get_mode_end_call_handler (netsnmp_mode_handler_list * endlist)
       returns a mode_end_call handler that can be injected into a given handler chain. Parameters:
	   endlist The callback list for the handler to make use of.

       Returns:
	   An injectable Net-SNMP handler.

       Definition at line 45 of file mode_end_call.c.

   netsnmp_mode_handler_list* netsnmp_mode_end_call_add_mode_callback (netsnmp_mode_handler_list * endlist, int mode, netsnmp_mib_handler *
       callbackh)
       adds a mode specific callback to the callback list. Parameters:
	   endlist the information structure for the mode_end_call helper. Can be NULL to create a new list.
	   mode the mode to be called upon. A mode of NETSNMP_MODE_END_ALL_MODES = all modes.
	   callbackh the netsnmp_mib_handler callback to call.

       Returns:
	   the new registration information list upon success.

       Definition at line 65 of file mode_end_call.c.

Author
       Generated automatically by Doxygen for net-snmp from the source code.

Version 5.5							    23 Sep 2009 						  mode_end_call(3)

Check Out this Related Man Page

multiplexer(3)							     net-snmp							    multiplexer(3)

NAME

       multiplexer -

       Splits mode requests into calls to different handlers.

   Functions
       netsnmp_mib_handler * netsnmp_get_multiplexer_handler (netsnmp_mib_handler_methods *req)
	   returns a multiplixer handler given a netsnmp_mib_handler_methods structure of subhandlers.
       int netsnmp_multiplexer_helper_handler (netsnmp_mib_handler *handler, netsnmp_handler_registration *reginfo, netsnmp_agent_request_info
	   *reqinfo, netsnmp_request_info *requests)
	   implements the multiplexer helper

Detailed Description
       Splits mode requests into calls to different handlers.

       The multiplexer helper lets you split the calling chain depending on the calling mode (get vs getnext vs set). Useful if you want different
       routines to handle different aspects of SNMP requests, which is very common for GET vs SET type actions.

       Functionally:

       1.  GET requests call the get_method

       2.  GETNEXT requests call the getnext_method, or if not present, the get_method.

       3.  GETBULK requests call the getbulk_method, or if not present, the getnext_method, or if even that isn't present the get_method.

       4.  SET requests call the set_method, or if not present return a SNMP_ERR_NOTWRITABLE error.

Function Documentation
   netsnmp_mib_handler* netsnmp_get_multiplexer_handler (netsnmp_mib_handler_methods * req)
       returns a multiplixer handler given a netsnmp_mib_handler_methods structure of subhandlers.

       Definition at line 33 of file multiplexer.c.

   int netsnmp_multiplexer_helper_handler (netsnmp_mib_handler * handler, netsnmp_handler_registration * reginfo, netsnmp_agent_request_info *
       reqinfo, netsnmp_request_info * requests)
       implements the multiplexer helper

       Definition at line 54 of file multiplexer.c.

Author
       Generated automatically by Doxygen for net-snmp from the source code.

Version 5.5							    23 Sep 2009 						    multiplexer(3)
Man Page