1
.TH "Net-SNMP Agent handler and extensibility API" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
1
.TH "Net-SNMP Agent handler and extensibility API" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
5
Net-SNMP Agent handler and extensibility API \- The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
5
Net-SNMP Agent handler and extensibility API \-
7
The basic theory goes something like this: In the past, with the original mib \fBmodule\fP api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
13
.RI "struct \fBnetsnmp_mib_handler_s\fP"
15
.RI "\fIthe mib handler structure to be registered \fP"
17
.RI "struct \fBnetsnmp_handler_registration_s\fP"
19
.RI "\fIRoot registration info. \fP"
21
.RI "struct \fBnetsnmp_handler_args_s\fP"
24
.RI "struct \fBnetsnmp_delegated_cache_s\fP"
12
31
.RI "\fButility_handlers\fP"
14
35
.RI "\fISimplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object. \fP"
19
37
.RI "\fBleaf_handlers\fP"
21
41
.RI "\fIProcess individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table). \fP"
26
43
.RI "\fBbaby_steps\fP"
28
47
.RI "\fICalls your handler in baby_steps for set processing. \fP"
33
49
.RI "\fBold_api\fP"
35
.RI "\fICalls mib module code written in the old style of code. \fP"
53
.RI "\fICalls mib \fBmodule\fP code written in the old style of code. \fP"
40
55
.RI "\fBstash_cache\fP"
42
59
.RI "\fIAutomatically caches data for certain handlers. \fP"
49
65
.RI "\fIHelps you implement a table. \fP"
57
.RI "struct \fBnetsnmp_mib_handler_s\fP"
59
.RI "\fIthe mib handler structure to be registered \fP"
61
.RI "struct \fBnetsnmp_handler_registration_s\fP"
63
.RI "\fIRoot registration info. \fP"
65
.RI "struct \fBnetsnmp_handler_args_s\fP"
68
.RI "struct \fBnetsnmp_delegated_cache_s\fP"
71
.RI "struct \fBnetsnmp_mib_handler_s\fP"
73
.RI "\fIthe mib handler structure to be registered \fP"
75
.RI "struct \fBnetsnmp_handler_registration_s\fP"
77
.RI "\fIRoot registration info. \fP"
294
282
.SH "Detailed Description"
296
The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
284
The basic theory goes something like this: In the past, with the original mib \fBmodule\fP api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
298
286
This worked well at the time but in todays world of subagents, device instrumentation, low resource consumption, etc, it just isn't flexible enough. 'handlers' are here to fix all that.
300
288
With the rewrite of the agent internals for the net-snmp 5.0 release, we introduce a modular calling scheme that allows agent modules to be written in a very flexible manner, and more importantly allows reuse of code in a decent way (and without the memory and speed overheads of OO languages like C++).
302
Functionally, the notion of what a handler does is the same as the older api: A handler is \fBcreated\fP and then \fBregistered\fP with the main agent at a given OID in the OID tree and gets called any time a request is made that it should respond to. You probably should use one of the convenience helpers instead of doing anything else yourself though:
290
Functionally, the notion of what a handler does is the same as the older api: A handler is \fBcreated\fP and then \fBregistered\fP with the main agent at a given OID in the OID \fBtree\fP and gets called any time a request is made that it should respond to. You probably should use one of the convenience helpers instead of doing anything else yourself though:
304
Most importantly, though, is that the handlers are built on the notion of modularity and reuse. Specifically, rather than do all the really hard work (like parsing table indexes out of an incoming oid request) in each module, the API is designed to make it easy to write 'helper' handlers that merely process some aspect of the request before passing it along to the final handler that returns the real answer. Most people will want to make use of the \fBinstance\fP, \fBtable\fP, \fBtable_iterator\fP, \fBtable_data\fP, or \fBtable_dataset\fP helpers to make their life easier. These 'helpers' interpert important aspects of the request and pass them on to you.
292
Most importantly, though, is that the handlers are built on the notion of modularity and reuse. Specifically, rather than do all the really hard work (like parsing table indexes out of an incoming oid request) in each \fBmodule\fP, the API is designed to make it easy to write 'helper' handlers that merely process some aspect of the request before passing it along to the final handler that returns the real answer. Most people will want to make use of the \fBinstance\fP, \fBtable\fP, \fBtable_iterator\fP, \fBtable_data\fP, or \fBtable_dataset\fP helpers to make their life easier. These 'helpers' interpert important aspects of the request and pass them on to you.
306
294
For instance, the \fBtable\fP helper is designed to hand you a list of extracted index values from an incoming request. THe \fBtable_iterator\fP helper is built on top of the table helper, and is designed to help you iterate through data stored elsewhere (like in a kernel) that is not in OID lexographical order (ie, don't write your own index/oid sorting routine, use this helper instead). The beauty of the \fBtable_iterator helper\fP, as well as the \fBinstance\fP helper is that they take care of the complex GETNEXT processing entirely for you and hand you everything you need to merely return the data as if it was a GET request. Much less code and hair pulling. I've pulled all my hair out to help you so that only one of us has to be bald.
307
295
.SH "Typedef Documentation"
309
297
.SS "struct \fBnetsnmp_handler_registration_s\fP \fBnetsnmp_handler_registration\fP"
311
299
Typedefs the \fBnetsnmp_handler_registration_s\fP struct into netsnmp_handler_registration.
313
300
.SS "struct \fBnetsnmp_mib_handler_s\fP \fBnetsnmp_mib_handler\fP"
315
302
Typedefs the \fBnetsnmp_mib_handler_s\fP struct into netsnmp_mib_handler.
317
303
.SH "Function Documentation"
319
305
.SS "int netsnmp_call_handler (\fBnetsnmp_mib_handler\fP * next_handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
321
307
calls a handler with with appropriate NULL checking of arguments, etc.
323
Definition at line 394 of file agent_handler.c.
325
References netsnmp_mib_handler_s::access_method, netsnmp_mib_handler_s::handler_name, MIB_HANDLER_AUTO_NEXT, MIB_HANDLER_AUTO_NEXT_OVERRIDE_ONCE, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::next, NULL, and snmp_log().
327
Referenced by netsnmp_call_handlers(), netsnmp_call_next_handler(), netsnmp_call_next_handler_one_request(), netsnmp_mode_end_call_helper(), and netsnmp_multiplexer_helper_handler().
328
308
.SS "int netsnmp_call_next_handler (\fBnetsnmp_mib_handler\fP * current, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
330
310
calls the next handler in the chain after the current one with with appropriate NULL checking, etc.
332
Definition at line 524 of file agent_handler.c.
334
References netsnmp_call_handler(), netsnmp_mib_handler_s::next, NULL, and snmp_log().
336
Referenced by _netsnmp_stash_cache_load(), netsnmp_bulk_to_next_helper(), netsnmp_debug_helper(), netsnmp_instance_counter32_handler(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_mode_end_call_helper(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_serialize_helper_handler(), netsnmp_stash_to_next_helper(), and table_helper_handler().
337
311
.SS "int netsnmp_call_next_handler_one_request (\fBnetsnmp_mib_handler\fP * current, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
339
313
calls the next handler in the chain after the current one with with appropriate NULL checking, etc.
341
Definition at line 546 of file agent_handler.c.
343
References netsnmp_call_handler(), netsnmp_mib_handler_s::next, netsnmp_request_info_s::next, NULL, and snmp_log().
344
314
.SS "void netsnmp_clear_handler_list (void)"
346
316
clears the entire handler-registration list
348
Definition at line 905 of file agent_handler.c.
350
References netsnmp_free_all_list_data(), and NULL.
352
Referenced by shutdown_agent().
353
.SS "NETSNMP_INLINE \fBnetsnmp_delegated_cache\fP * netsnmp_create_delegated_cache (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests, void * localinfo)"
355
creates a cache of information which can be saved for future reference.
357
Use \fBnetsnmp_handler_check_cache()\fP later to make sure it's still valid before referencing it in the future.
317
.SS "\fBnetsnmp_delegated_cache\fP * netsnmp_create_delegated_cache (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests, void * localinfo)"
319
creates a cache of information which can be saved for future reference. Use \fBnetsnmp_handler_check_cache()\fP later to make sure it's still valid before referencing it in the future.
361
323
\fBdelayed_instance.c\fP.
363
Definition at line 696 of file agent_handler.c.
365
References netsnmp_agent_request_info_s::asp, netsnmp_delegated_cache_s::handler, netsnmp_delegated_cache_s::localinfo, netsnmp_agent_session_s::pdu, netsnmp_delegated_cache_s::reginfo, netsnmp_delegated_cache_s::reqinfo, netsnmp_delegated_cache_s::requests, SNMP_MALLOC_TYPEDEF, netsnmp_delegated_cache_s::transaction_id, and snmp_pdu::transid.
366
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_create_handler (const char * name, \fBNetsnmp_Node_Handler\fP * handler_access_method)"
368
creates a netsnmp_mib_handler structure given a name and a access method.
370
The returned handler should then be \fBregistered.\fP
324
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_create_handler (const char * name, Netsnmp_Node_Handler * handler_access_method)"
326
creates a netsnmp_mib_handler structure given a name and a access method. The returned handler should then be \fBregistered.\fP
372
328
\fBParameters:\fP
386
\fBnetsnmp_create_handler_registration()\fP
342
netsnmp_create_handler_registration()
388
344
\fBnetsnmp_register_handler()\fP
393
Definition at line 105 of file agent_handler.c.
395
References netsnmp_mib_handler_s::access_method, netsnmp_mib_handler_s::handler_name, NULL, SNMP_FREE, and SNMP_MALLOC_TYPEDEF.
397
Referenced by get_old_api_handler(), netsnmp_baby_steps_access_multiplexer_get(), netsnmp_baby_steps_handler_get(), netsnmp_cache_handler_get(), netsnmp_container_table_handler_get(), netsnmp_create_handler_registration(), netsnmp_get_bulk_to_next_handler(), netsnmp_get_debug_handler(), netsnmp_get_instance_handler(), netsnmp_get_mode_end_call_handler(), netsnmp_get_multiplexer_handler(), netsnmp_get_read_only_handler(), netsnmp_get_row_merge_handler(), netsnmp_get_scalar_group_handler(), netsnmp_get_scalar_handler(), netsnmp_get_serialize_handler(), netsnmp_get_stash_to_next_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_get_table_iterator_handler(), netsnmp_get_tdata_handler(), netsnmp_get_timed_bare_stash_cache_handler(), netsnmp_get_watched_spinlock_handler(), netsnmp_get_watched_timestamp_handler(), netsnmp_get_watcher_handler(), netsnmp_sparse_table_handler_get(), netsnmp_sparse_table_register(), netsnmp_table_array_register(), and netsnmp_table_row_handler_get().
398
348
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_find_handler_by_name (\fBnetsnmp_handler_registration\fP * reginfo, const char * name)"
400
350
Returns a handler from a chain based on the name.
402
Definition at line 838 of file agent_handler.c.
404
References netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, and NULL.
406
Referenced by netsnmp_find_handler_data_by_name().
407
351
.SS "void * netsnmp_find_handler_data_by_name (\fBnetsnmp_handler_registration\fP * reginfo, const char * name)"
409
Returns a handler's void * pointer from a chain based on the name.
411
This probably shouldn't be used by the general public as the void * data may change as a handler evolves. Handlers should really advertise some function for you to use instead.
413
Definition at line 855 of file agent_handler.c.
415
References netsnmp_mib_handler_s::myvoid, netsnmp_find_handler_by_name(), and NULL.
417
Referenced by netsnmp_find_table_registration_info().
418
.SS "NETSNMP_INLINE void netsnmp_free_delegated_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
353
Returns a handler's void * pointer from a chain based on the name. This probably shouldn't be used by the general public as the void * data may change as a handler evolves. Handlers should really advertise some function for you to use instead.
354
.SS "void netsnmp_free_delegated_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
420
356
frees a cache once you're finished using it
424
360
\fBdelayed_instance.c\fP.
426
Definition at line 734 of file agent_handler.c.
428
References SNMP_FREE.
429
.SS "NETSNMP_INLINE void netsnmp_free_request_data_set (\fBnetsnmp_request_info\fP * request)"
361
.SS "void netsnmp_free_request_data_set (\fBnetsnmp_request_info\fP * request)"
431
363
Free the extra data stored in a request.
433
Definition at line 820 of file agent_handler.c.
435
References netsnmp_free_list_data(), and netsnmp_request_info_s::parent_data.
436
.SS "NETSNMP_INLINE void netsnmp_free_request_data_sets (\fBnetsnmp_request_info\fP * request)"
364
.SS "void netsnmp_free_request_data_sets (\fBnetsnmp_request_info\fP * request)"
438
366
Free the extra data stored in a bunch of requests (all data in the chain).
440
Definition at line 828 of file agent_handler.c.
442
References netsnmp_free_all_list_data(), NULL, and netsnmp_request_info_s::parent_data.
444
Referenced by free_agent_snmp_session(), get_set_cache(), netsnmp_add_varbind_to_cache(), and netsnmp_delete_request_infos().
445
.SS "NETSNMP_INLINE \fBnetsnmp_delegated_cache\fP * netsnmp_handler_check_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
447
check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request.
449
Returns NULL if it's no longer valid.
367
.SS "\fBnetsnmp_delegated_cache\fP * netsnmp_handler_check_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
369
check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request. Returns NULL if it's no longer valid.
453
373
\fBdelayed_instance.c\fP.
455
Definition at line 720 of file agent_handler.c.
457
References netsnmp_check_transaction_id(), NULL, and netsnmp_delegated_cache_s::transaction_id.
458
374
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_handler_dup (\fBnetsnmp_mib_handler\fP * handler)"
460
376
dulpicates a handler and all subsequent handlers see also _clone_handler
462
Definition at line 591 of file agent_handler.c.
464
References netsnmp_mib_handler_s::myvoid, netsnmp_handler_free(), netsnmp_mib_handler_s::next, NULL, and netsnmp_mib_handler_s::prev.
466
Referenced by netsnmp_handler_registration_dup().
467
377
.SS "void netsnmp_handler_free (\fBnetsnmp_mib_handler\fP * handler)"
469
379
free's the resourceses associated with a given handler
471
381
make sure we aren't pointing to ourselves.
473
XXX : segv here at shutdown if SHUTDOWN_AGENT_CLEANLY defined. About 30 functions down the stack, starting in \fBclear_context()\fP -> \fBclear_subtree()\fP
475
Definition at line 569 of file agent_handler.c.
477
References netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, NULL, and SNMP_FREE.
479
Referenced by handler_free_callback(), netsnmp_baby_steps_handler_get(), netsnmp_get_scalar_group_handler(), netsnmp_get_timed_bare_stash_cache_handler(), netsnmp_handler_dup(), and netsnmp_handler_registration_free().
383
XXX : segv here at shutdown if SHUTDOWN_AGENT_CLEANLY defined. About 30 functions down the stack, starting in clear_context() -> clear_subtree()
480
384
.SS "void netsnmp_handler_mark_requests_as_delegated (\fBnetsnmp_request_info\fP * requests, int isdelegated)"
482
386
marks a list of requests as delegated (or not if isdelegaded = 0)
484
Definition at line 748 of file agent_handler.c.
486
References netsnmp_request_info_s::delegated, and netsnmp_request_info_s::next.
487
387
.SS "\fBnetsnmp_handler_registration\fP * netsnmp_handler_registration_create (const char * name, \fBnetsnmp_mib_handler\fP * handler, oid * reg_oid, size_t reg_oid_len, int modes)"
489
creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports.
491
If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. A hander which supports sets but not row creation should set us a mode of HANDLER_CAN_SET_ONLY.
389
creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports. If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. A hander which supports sets but not row creation should set us a mode of HANDLER_CAN_SET_ONLY.
541
Definition at line 163 of file agent_handler.c.
543
References netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, netsnmp_handler_registration_s::handlerName, memdup(), netsnmp_handler_registration_s::modes, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and SNMP_MALLOC_TYPEDEF.
545
Referenced by netsnmp_create_handler_registration().
546
438
.SS "\fBnetsnmp_handler_registration\fP * netsnmp_handler_registration_dup (\fBnetsnmp_handler_registration\fP * reginfo)"
548
440
duplicates the handler registration object
550
Definition at line 634 of file agent_handler.c.
552
References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, netsnmp_handler_registration_s::handlerName, memdup(), netsnmp_handler_registration_s::modes, netsnmp_handler_dup(), netsnmp_handler_registration_free(), NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and netsnmp_handler_registration_s::timeout.
554
Referenced by netsnmp_subtree_deepcopy().
555
441
.SS "void netsnmp_handler_registration_free (\fBnetsnmp_handler_registration\fP * reginfo)"
557
443
free the resources associated with a handler registration object
559
Definition at line 620 of file agent_handler.c.
561
References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, netsnmp_handler_registration_s::handlerName, netsnmp_handler_free(), NULL, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and SNMP_FREE.
563
Referenced by netsnmp_handler_registration_dup(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), netsnmp_subtree_free(), and unregister_mibs_by_session().
564
444
.SS "int netsnmp_inject_handler (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_mib_handler\fP * handler)"
566
inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer.
568
The new handler is injected at the top of the list and hence will be the new handler to be called first.
570
Definition at line 386 of file agent_handler.c.
572
References netsnmp_inject_handler_before(), and NULL.
574
Referenced by netsnmp_cache_handler_register(), netsnmp_container_table_register(), netsnmp_register_cache_handler(), netsnmp_register_handler(), netsnmp_register_instance(), netsnmp_register_read_only_instance(), netsnmp_register_read_only_scalar(), netsnmp_register_read_only_table_data(), netsnmp_register_row_merge(), netsnmp_register_scalar(), netsnmp_register_scalar_group(), netsnmp_register_serialize(), netsnmp_register_table(), netsnmp_register_table_data(), netsnmp_register_table_data_set(), netsnmp_register_table_iterator(), netsnmp_register_watched_instance(), netsnmp_register_watched_scalar(), netsnmp_register_watched_spinlock(), netsnmp_sparse_table_register(), netsnmp_table_array_register(), netsnmp_table_row_register(), netsnmp_tdata_register(), and netsnmp_watched_timestamp_register().
446
inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. The new handler is injected at the top of the list and hence will be the new handler to be called first.
575
447
.SS "int netsnmp_inject_handler_before (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_mib_handler\fP * handler, const char * before_what)"
577
inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer.
579
The new handler is injected after the before_what handler, or if NULL at the top of the list and hence will be the new handler to be called first.
581
Definition at line 329 of file agent_handler.c.
583
References netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, NULL, netsnmp_mib_handler_s::prev, and snmp_log().
585
Referenced by netsnmp_inject_handler(), and netsnmp_inject_handler_into_subtree().
449
inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. The new handler is injected after the before_what handler, or if NULL at the top of the list and hence will be the new handler to be called first.
586
450
.SS "int netsnmp_register_handler (\fBnetsnmp_handler_registration\fP * reginfo)"
588
452
register a handler, as defined by the netsnmp_handler_registration pointer.
590
Definition at line 202 of file agent_handler.c.
592
References netsnmp_handler_registration_s::contextName, netsnmp_mib_handler_s::flags, netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, HANDLER_CAN_GETBULK, netsnmp_mib_handler_s::handler_name, netsnmp_handler_registration_s::handlerName, MIB_HANDLER_INSTANCE, netsnmp_handler_registration_s::modes, netsnmp_get_bulk_to_next_handler(), netsnmp_inject_handler(), netsnmp_register_mib(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_log(), and netsnmp_handler_registration_s::timeout.
594
Referenced by netsnmp_cache_handler_register(), netsnmp_register_cache_handler(), netsnmp_register_old_api(), netsnmp_register_row_merge(), netsnmp_register_serialize(), netsnmp_register_table(), netsnmp_sparse_table_register(), and netsnmp_table_row_register().
595
453
.SS "void netsnmp_register_handler_by_name (const char * name, \fBnetsnmp_mib_handler\fP * handler)"
597
455
registers a given handler by name so that it can be found easily later.
599
Definition at line 893 of file agent_handler.c.
601
References handler_free_callback(), netsnmp_add_list_data(), and netsnmp_create_data_list().
603
Referenced by netsnmp_baby_steps_handler_init(), netsnmp_init_bulk_to_next_helper(), netsnmp_init_debug_helper(), netsnmp_init_read_only_helper(), netsnmp_init_row_merge(), netsnmp_init_serialize(), and netsnmp_init_stash_cache_helper().
604
456
.SS "int netsnmp_register_handler_nocallback (\fBnetsnmp_handler_registration\fP * reginfo)"
606
458
register a handler, as defined by the netsnmp_handler_registration pointer.
608
Definition at line 277 of file agent_handler.c.
610
References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, netsnmp_mib_handler_s::handler_name, netsnmp_handler_registration_s::modes, netsnmp_register_mib(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_log(), and netsnmp_handler_registration_s::timeout.
612
Referenced by netsnmp_register_mib_table_row().
613
.SS "NETSNMP_INLINE void netsnmp_request_add_list_data (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_data_list\fP * node)"
615
add data to a request that can be extracted later by submodules
459
.SS "void netsnmp_request_add_list_data (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_data_list\fP * node)"
461
add data to a request that can be extracted later by submodules \fBParameters:\fP
619
463
\fIrequest\fP the netsnmp request info structure
621
\fInode\fP this is the data to be added to the linked list request->parent_data
465
\fI\fBnode\fP\fP this is the data to be added to the linked list request->parent_data
added
removed
man/netsnmp_handler.3
