~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/netsnmp_library.3

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-05-10 22:20:23 UTC
  • mto: (1.4.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 11.
  • Revision ID: james.westby@ubuntu.com-20070510222023-3fr07xb9i17xvq32
Tags: upstream-5.3.1
ImportĀ upstreamĀ versionĀ 5.3.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "The Net-SNMP library" 3 "14 Jul 2006" "Version 5.2.3" "net-snmp" \" -*- nroff -*-
 
1
.TH "The Net-SNMP library" 3 "13 Jul 2006" "Version 5.3.1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
341
341
.br
342
342
.RI "\fIlexicographical compare two object identifiers. \fP"
343
343
.ti -1c
 
344
.RI "int \fBnetsnmp_oid_compare_ll\fP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2, size_t *offpt)"
 
345
.br
 
346
.RI "\fIlexicographical compare two object identifiers and return the point where they differ \fP"
 
347
.ti -1c
344
348
.RI "int \fBsnmp_oidtree_compare\fP (const oid *in_name1, size_t len1, const oid *in_name2, size_t len2)"
345
349
.br
346
350
.RI "\fICompares 2 OIDs to determine if they are equal up until the shortest length. \fP"
444
448
        (tvp)->tv_usec cmp (uvp)->tv_usec))
445
449
.fi
446
450
.PP
447
 
Definition at line 146 of file snmp_api.c.
 
451
Definition at line 147 of file snmp_api.c.
448
452
.PP
449
453
Referenced by snmp_sess_timeout().
450
454
.SH "Function Documentation"
455
459
.PP
456
460
XXX-rks: why no SNMP_FREE(isp->packet); ?? 
457
461
.PP
458
 
Definition at line 5345 of file snmp_api.c.
 
462
Definition at line 5404 of file snmp_api.c.
459
463
.PP
460
464
References asn_check_packet(), snmp_session::callback, snmp_session::callback_magic, snmp_internal_session::check_packet, netsnmp_transport_s::f_accept, netsnmp_transport_s::f_close, netsnmp_transport_s::f_recv, FD_ISSET, netsnmp_transport_s::flags, snmp_internal_session::hook_build, snmp_internal_session::hook_create_pdu, snmp_internal_session::hook_parse, snmp_internal_session::hook_post, snmp_internal_session::hook_pre, snmp_internal_session::hook_realloc_build, session_list::internal, MAX_PACKET_LENGTH, MAXIMUM_PACKET_SIZE, session_list::next, NULL, snmp_internal_session::packet, snmp_internal_session::packet_len, snmp_internal_session::packet_size, snmp_session::s_errno, snmp_session::s_snmp_errno, session_list::session, Sessions, SNMP_FREE, snmp_log(), snmp_sess_add_ex(), snmp_set_detail(), netsnmp_transport_s::sock, strerror(), and session_list::transport.
461
465
.PP
483
487
.PP
484
488
 
485
489
.PP
486
 
Definition at line 272 of file snmp_vars.c.
 
490
Definition at line 270 of file snmp_vars.c.
487
491
.PP
488
492
References _init_agent_callback_transport, init_traps(), netsnmp_ds_get_boolean(), netsnmp_ds_set_boolean(), netsnmp_init_helpers(), NULL, setup_tree(), snmp_log(), and starttime.
489
493
.SS "void init_snmp (const char * type)"
507
511
.PP
508
512
 
509
513
.PP
510
 
Definition at line 788 of file snmp_api.c.
 
514
Definition at line 793 of file snmp_api.c.
511
515
.PP
512
516
References init_callbacks(), init_mib(), init_snmp_alarm(), init_snmp_enums(), init_snmp_logging(), netsnmp_ds_get_string(), netsnmp_ds_set_string(), read_configs(), read_premib_configs(), register_mib_handlers(), and snmp_init_statistics().
 
517
.SS "int netsnmp_oid_compare_ll (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2, size_t * offpt)"
 
518
.PP
 
519
lexicographical compare two object identifiers and return the point where they differ 
 
520
.PP
 
521
Caution: this method is called often by command responder applications (ie, agent).
 
522
.PP
 
523
\fBReturns:\fP
 
524
.RS 4
 
525
-1 if name1 < name2, 0 if name1 = name2, 1 if name1 > name2 and offpt = len where name1 != name2 
 
526
.RE
 
527
.PP
 
528
 
 
529
.PP
 
530
Definition at line 6339 of file snmp_api.c.
 
531
.PP
 
532
Referenced by netsnmp_subtree_change_next(), netsnmp_subtree_change_prev(), and netsnmp_subtree_find_prev().
513
533
.SS "int netsnmp_oid_equals (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
514
534
.PP
515
535
Compares 2 OIDs to determine if they are exactly equal. 
534
554
.PP
535
555
 
536
556
.PP
537
 
Definition at line 6291 of file snmp_api.c.
 
557
Definition at line 6411 of file snmp_api.c.
538
558
.PP
539
559
Referenced by netsnmp_cache_find_by_oid(), netsnmp_subtree_free(), netsnmp_subtree_load(), and unregister_mib_context().
540
560
.SS "int netsnmp_oid_find_prefix (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
559
579
.PP
560
580
 
561
581
.PP
562
 
Definition at line 6347 of file snmp_api.c.
 
582
Definition at line 6467 of file snmp_api.c.
563
583
.PP
564
584
References SNMP_MIN.
565
585
.PP
588
608
.PP
589
609
 
590
610
.PP
591
 
Definition at line 6327 of file snmp_api.c.
 
611
Definition at line 6447 of file snmp_api.c.
592
612
.SS "int snmp_oid_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
593
613
.PP
594
614
lexicographical compare two object identifiers. 
602
622
.PP
603
623
 
604
624
.PP
605
 
Definition at line 6223 of file snmp_api.c.
 
625
Definition at line 6290 of file snmp_api.c.
606
626
.PP
607
 
Referenced by convert_v2pdu_to_v1(), find_varbind_in_list(), lookup_cache_find(), netsnmp_check_getnext_reply(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_subtree_compare(), netsnmp_subtree_find(), netsnmp_subtree_find_next(), netsnmp_subtree_find_prev(), netsnmp_subtree_load(), netsnmp_subtree_split(), netsnmp_table_data_add_row(), netsnmp_table_data_get_from_oid(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_oidtree_compare(), and table_helper_handler().
 
627
Referenced by convert_v2pdu_to_v1(), find_varbind_in_list(), lookup_cache_find(), netsnmp_check_getnext_reply(), netsnmp_container_table_row_insert(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_helper_handler(), netsnmp_iterator_row_get_byoid(), netsnmp_iterator_row_next_byoid(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_to_next_helper(), netsnmp_subtree_compare(), netsnmp_subtree_find(), netsnmp_subtree_find_next(), netsnmp_subtree_find_prev(), netsnmp_subtree_load(), netsnmp_subtree_split(), netsnmp_table_data_add_row(), netsnmp_table_data_get_from_oid(), netsnmp_table_data_row_next_byoid(), netsnmp_tdata_compare_oid(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_oidtree_compare(), and table_helper_handler().
608
628
.SS "int snmp_oidtree_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
609
629
.PP
610
630
Compares 2 OIDs to determine if they are equal up until the shortest length. 
627
647
.PP
628
648
 
629
649
.PP
630
 
Definition at line 6272 of file snmp_api.c.
 
650
Definition at line 6392 of file snmp_api.c.
631
651
.PP
632
652
References snmp_oid_compare().
 
653
.PP
 
654
Referenced by netsnmp_query_walk(), and netsnmp_tdata_compare_subtree_oid().
633
655
.SS "void snmp_shutdown (const char * type)"
634
656
.PP
635
657
Shuts down the application, saving any needed persistent storage, and appropriate clean up. 
646
668
.PP
647
669
 
648
670
.PP
649
 
Definition at line 856 of file snmp_api.c.
 
671
Definition at line 862 of file snmp_api.c.
650
672
.PP
651
673
References clear_callback(), netsnmp_ds_shutdown(), NULL, shutdown_mib(), snmp_alarm_unregister_all(), snmp_call_callbacks(), snmp_close_sessions(), snmp_store(), and unregister_all_config_handlers().
652
674
.SS "int snmpv3_engineID_probe (struct \fBsession_list\fP * slp, \fBnetsnmp_session\fP * in_session)"
680
702
.PP
681
703
 
682
704
.PP
683
 
Definition at line 1272 of file snmp_api.c.
 
705
Definition at line 1278 of file snmp_api.c.
684
706
.PP
685
707
References create_user_from_session(), snmp_session::engineBoots, snmp_session::engineTime, snmp_session::flags, NULL, snmp_session::s_snmp_errno, snmp_session::securityEngineID, snmp_session::securityEngineIDLen, session_list::session, snmp_api_errstring(), snmp_errstring(), snmp_sess_synch_response(), TRUE, and snmp_session::version.
686
708
.PP