SNMP编程

开发平台：
Unix_Linux

netsnmp_snmp_session.3：源码内容
							.TH "snmp_session" 3 "28 Nov 2005" "Version 5.2.1.rc3" "net-snmp" " -*- nroff -*-
.ad l
.nh
.SH NAME
snmp_session - The snmp session structure.  
.PP
.SH SYNOPSIS
.br
.PP
fC#include <snmp_api.h>fP
.PP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "long fBversionfP"
.br
.RI "fIsnmp version fP"
.ti -1c
.RI "int fBretriesfP"
.br
.RI "fINumber of retries before timeout. fP"
.ti -1c
.RI "long fBtimeoutfP"
.br
.RI "fINumber of uS until first timeout, then exponential backoff. fP"
.ti -1c
.RI "u_long fBflagsfP"
.br
.ti -1c
.RI "fBsnmp_sessionfP * fBsubsessionfP"
.br
.ti -1c
.RI "fBsnmp_sessionfP * fBnextfP"
.br
.ti -1c
.RI "char * fBpeernamefP"
.br
.RI "fIDomain name or dotted IP address of default peer. fP"
.ti -1c
.RI "u_short fBremote_portfP"
.br
.RI "fIUDP port number of peer. fP"
.ti -1c
.RI "char * fBlocalnamefP"
.br
.RI "fIMy Domain name or dotted IP address, 0 for default. fP"
.ti -1c
.RI "u_short fBlocal_portfP"
.br
.RI "fIMy UDP port number, 0 for default, picked randomly. fP"
.ti -1c
.RI "u_char *(* fBauthenticatorfP )(u_char *, size_t *, u_char *, size_t)"
.br
.RI "fIAuthentication function or NULL if null authentication is used. fP"
.ti -1c
.RI "netsnmp_callback fBcallbackfP"
.br
.RI "fIFunction to interpret incoming data. fP"
.ti -1c
.RI "void * fBcallback_magicfP"
.br
.RI "fIPointer to data that the callback function may consider important. fP"
.ti -1c
.RI "int fBs_errnofP"
.br
.RI "fIcopy of system errno fP"
.ti -1c
.RI "int fBs_snmp_errnofP"
.br
.RI "fIcopy of library errno fP"
.ti -1c
.RI "long fBsessidfP"
.br
.RI "fISession id - AgentX only. fP"
.ti -1c
.RI "u_char * fBcommunityfP"
.br
.RI "fIcommunity for outgoing requests. fP"
.ti -1c
.RI "size_t fBcommunity_lenfP"
.br
.RI "fILength of community name. fP"
.ti -1c
.RI "size_t fBrcvMsgMaxSizefP"
.br
.RI "fILargest message to try to receive. fP"
.ti -1c
.RI "size_t fBsndMsgMaxSizefP"
.br
.RI "fILargest message to try to send. fP"
.ti -1c
.RI "u_char fBisAuthoritativefP"
.br
.RI "fIare we the authoritative engine? fP"
.ti -1c
.RI "u_char * fBcontextEngineIDfP"
.br
.RI "fIauthoritative snmpEngineID fP"
.ti -1c
.RI "size_t fBcontextEngineIDLenfP"
.br
.RI "fILength of contextEngineID. fP"
.ti -1c
.RI "u_int fBengineBootsfP"
.br
.RI "fIinitial engineBoots for remote engine fP"
.ti -1c
.RI "u_int fBengineTimefP"
.br
.RI "fIinitial engineTime for remote engine fP"
.ti -1c
.RI "char * fBcontextNamefP"
.br
.RI "fIauthoritative contextName fP"
.ti -1c
.RI "size_t fBcontextNameLenfP"
.br
.RI "fILength of contextName. fP"
.ti -1c
.RI "u_char * fBsecurityEngineIDfP"
.br
.RI "fIauthoritative snmpEngineID fP"
.ti -1c
.RI "size_t fBsecurityEngineIDLenfP"
.br
.RI "fILength of contextEngineID. fP"
.ti -1c
.RI "char * fBsecurityNamefP"
.br
.RI "fIon behalf of this principal fP"
.ti -1c
.RI "size_t fBsecurityNameLenfP"
.br
.RI "fILength of securityName. fP"
.ti -1c
.RI "oid * fBsecurityAuthProtofP"
.br
.RI "fIauth protocol oid fP"
.ti -1c
.RI "size_t fBsecurityAuthProtoLenfP"
.br
.RI "fILength of auth protocol oid. fP"
.ti -1c
.RI "u_char fBsecurityAuthKeyfP [USM_AUTH_KU_LEN]"
.br
.RI "fIKu for auth protocol XXX. fP"
.ti -1c
.RI "size_t fBsecurityAuthKeyLenfP"
.br
.RI "fILength of Ku for auth protocol. fP"
.ti -1c
.RI "u_char * fBsecurityAuthLocalKeyfP"
.br
.RI "fIKul for auth protocol. fP"
.ti -1c
.RI "size_t fBsecurityAuthLocalKeyLenfP"
.br
.RI "fILength of Kul for auth protocol XXX. fP"
.ti -1c
.RI "oid * fBsecurityPrivProtofP"
.br
.RI "fIpriv protocol oid fP"
.ti -1c
.RI "size_t fBsecurityPrivProtoLenfP"
.br
.RI "fILength of priv protocol oid. fP"
.ti -1c
.RI "u_char fBsecurityPrivKeyfP [USM_PRIV_KU_LEN]"
.br
.RI "fIKu for privacy protocol XXX. fP"
.ti -1c
.RI "size_t fBsecurityPrivKeyLenfP"
.br
.RI "fILength of Ku for priv protocol. fP"
.ti -1c
.RI "u_char * fBsecurityPrivLocalKeyfP"
.br
.RI "fIKul for priv protocol. fP"
.ti -1c
.RI "size_t fBsecurityPrivLocalKeyLenfP"
.br
.RI "fILength of Kul for priv protocol XXX. fP"
.ti -1c
.RI "int fBsecurityModelfP"
.br
.RI "fIsnmp security model, v1, v2c, usm fP"
.ti -1c
.RI "int fBsecurityLevelfP"
.br
.RI "fInoAuthNoPriv, authNoPriv, authPriv fP"
.ti -1c
.RI "void * fBsecurityInfofP"
.br
.RI "fIsecurity module specific fP"
.ti -1c
.RI "void * fBmyvoidfP"
.br
.RI "fIuse as you want data fP"
.in -1c
.SH "Detailed Description"
.PP 
The snmp session structure. 
.PP
Definition at line 187 of file snmp_api.h.
.SH "Field Documentation"
.PP 
.SS "u_char*(* fBsnmp_session::authenticatorfP)(u_char *, size_t *, u_char *, size_t)"
.PP
Authentication function or NULL if null authentication is used. 
.PP
Referenced by netsnmp_register_agent_nsap().
.SS "netsnmp_callback fBsnmp_session::callbackfP"
.PP
Function to interpret incoming data. 
.PP
Definition at line 214 of file snmp_api.h.
.PP
Referenced by _sess_read(), netsnmp_register_agent_nsap(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
.SS "void* fBsnmp_session::callback_magicfP"
.PP
Pointer to data that the callback function may consider important. 
.PP
Definition at line 218 of file snmp_api.h.
.PP
Referenced by _sess_read(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
.SS "u_char* fBsnmp_session::communityfP"
.PP
community for outgoing requests. 
.PP
Definition at line 230 of file snmp_api.h.
.PP
Referenced by create_trap_session().
.SS "size_t fBsnmp_session::community_lenfP"
.PP
Length of community name. 
.PP
Definition at line 232 of file snmp_api.h.
.PP
Referenced by create_trap_session().
.SS "u_char* fBsnmp_session::contextEngineIDfP"
.PP
authoritative snmpEngineID 
.PP
Definition at line 244 of file snmp_api.h.
.SS "size_t fBsnmp_session::contextEngineIDLenfP"
.PP
Length of contextEngineID. 
.PP
Definition at line 246 of file snmp_api.h.
.SS "char* fBsnmp_session::contextNamefP"
.PP
authoritative contextName 
.PP
Definition at line 252 of file snmp_api.h.
.PP
Referenced by unregister_mibs_by_session().
.SS "size_t fBsnmp_session::contextNameLenfP"
.PP
Length of contextName. 
.PP
Definition at line 254 of file snmp_api.h.
.SS "u_int fBsnmp_session::engineBootsfP"
.PP
initial engineBoots for remote engine 
.PP
Definition at line 248 of file snmp_api.h.
.PP
Referenced by snmpv3_engineID_probe().
.SS "u_int fBsnmp_session::engineTimefP"
.PP
initial engineTime for remote engine 
.PP
Definition at line 250 of file snmp_api.h.
.PP
Referenced by snmpv3_engineID_probe().
.SS "u_char fBsnmp_session::isAuthoritativefP"
.PP
are we the authoritative engine? 
.PP
Definition at line 242 of file snmp_api.h.
.PP
Referenced by netsnmp_register_agent_nsap().
.SS "u_short fBsnmp_session::local_portfP"
.PP
My UDP port number, 0 for default, picked randomly. 
.PP
Definition at line 208 of file snmp_api.h.
.SS "char* fBsnmp_session::localnamefP"
.PP
My Domain name or dotted IP address, 0 for default. 
.PP
Definition at line 206 of file snmp_api.h.
.PP
Referenced by create_trap_session().
.SS "void* fBsnmp_session::myvoidfP"
.PP
use as you want data 
.PP
Definition at line 303 of file snmp_api.h.
.SS "char* fBsnmp_session::peernamefP"
.PP
Domain name or dotted IP address of default peer. 
.PP
Definition at line 202 of file snmp_api.h.
.PP
Referenced by create_trap_session().
.SS "size_t fBsnmp_session::rcvMsgMaxSizefP"
.PP
Largest message to try to receive. 
.PP
Definition at line 234 of file snmp_api.h.
.PP
Referenced by snmp_sess_add_ex(), and snmp_sess_init().
.SS "u_short fBsnmp_session::remote_portfP"
.PP
UDP port number of peer. 
.PP
Definition at line 204 of file snmp_api.h.
.PP
Referenced by snmp_sess_init().
.SS "int fBsnmp_session::retriesfP"
.PP
Number of retries before timeout. 
.PP
Definition at line 194 of file snmp_api.h.
.PP
Referenced by create_trap_session(), snmp_sess_init(), and snmp_sess_timeout().
.SS "int fBsnmp_session::s_errnofP"
.PP
copy of system errno 
.PP
Definition at line 220 of file snmp_api.h.
.PP
Referenced by _sess_read(), and snmp_error().
.SS "int fBsnmp_session::s_snmp_errnofP"
.PP
copy of library errno 
.PP
Definition at line 222 of file snmp_api.h.
.PP
Referenced by _sess_read(), handle_snmp_packet(), snmp_build(), snmp_error(), snmp_sess_async_send(), snmp_sess_open(), snmp_sess_read(), and snmpv3_engineID_probe().
.SS "u_char fBsnmp_session::securityAuthKeyfP[USM_AUTH_KU_LEN]"
.PP
Ku for auth protocol XXX. 
.PP
Definition at line 269 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityAuthKeyLenfP"
.PP
Length of Ku for auth protocol. 
.PP
Definition at line 271 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "u_char* fBsnmp_session::securityAuthLocalKeyfP"
.PP
Kul for auth protocol. 
.PP
Definition at line 273 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityAuthLocalKeyLenfP"
.PP
Length of Kul for auth protocol XXX. 
.PP
Definition at line 275 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "oid* fBsnmp_session::securityAuthProtofP"
.PP
auth protocol oid 
.PP
Definition at line 265 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityAuthProtoLenfP"
.PP
Length of auth protocol oid. 
.PP
Definition at line 267 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "u_char* fBsnmp_session::securityEngineIDfP"
.PP
authoritative snmpEngineID 
.PP
Definition at line 256 of file snmp_api.h.
.PP
Referenced by create_user_from_session(), and snmpv3_engineID_probe().
.SS "size_t fBsnmp_session::securityEngineIDLenfP"
.PP
Length of contextEngineID. 
.PP
Definition at line 258 of file snmp_api.h.
.PP
Referenced by create_user_from_session(), and snmpv3_engineID_probe().
.SS "void* fBsnmp_session::securityInfofP"
.PP
security module specific 
.PP
Definition at line 298 of file snmp_api.h.
.SS "int fBsnmp_session::securityLevelfP"
.PP
noAuthNoPriv, authNoPriv, authPriv 
.PP
Definition at line 293 of file snmp_api.h.
.SS "int fBsnmp_session::securityModelfP"
.PP
snmp security model, v1, v2c, usm 
.PP
Definition at line 291 of file snmp_api.h.
.PP
Referenced by snmp_sess_close(), and snmp_sess_init().
.SS "char* fBsnmp_session::securityNamefP"
.PP
on behalf of this principal 
.PP
Definition at line 260 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityNameLenfP"
.PP
Length of securityName. 
.PP
Definition at line 262 of file snmp_api.h.
.SS "u_char fBsnmp_session::securityPrivKeyfP[USM_PRIV_KU_LEN]"
.PP
Ku for privacy protocol XXX. 
.PP
Definition at line 282 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityPrivKeyLenfP"
.PP
Length of Ku for priv protocol. 
.PP
Definition at line 284 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "u_char* fBsnmp_session::securityPrivLocalKeyfP"
.PP
Kul for priv protocol. 
.PP
Definition at line 286 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityPrivLocalKeyLenfP"
.PP
Length of Kul for priv protocol XXX. 
.PP
Definition at line 288 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "oid* fBsnmp_session::securityPrivProtofP"
.PP
priv protocol oid 
.PP
Definition at line 278 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "size_t fBsnmp_session::securityPrivProtoLenfP"
.PP
Length of priv protocol oid. 
.PP
Definition at line 280 of file snmp_api.h.
.PP
Referenced by create_user_from_session().
.SS "long fBsnmp_session::sessidfP"
.PP
Session id - AgentX only. 
.PP
Definition at line 224 of file snmp_api.h.
.PP
Referenced by send_trap_to_sess().
.SS "size_t fBsnmp_session::sndMsgMaxSizefP"
.PP
Largest message to try to send. 
.PP
Definition at line 236 of file snmp_api.h.
.PP
Referenced by snmpv3_parse().
.SS "long fBsnmp_session::timeoutfP"
.PP
Number of uS until first timeout, then exponential backoff. 
.PP
Definition at line 196 of file snmp_api.h.
.PP
Referenced by create_trap_session(), and snmp_sess_init().
.SS "long fBsnmp_session::versionfP"
.PP
snmp version 
.PP
Definition at line 192 of file snmp_api.h.
.PP
Referenced by add_trap_session(), create_trap_session(), netsnmp_register_agent_nsap(), send_trap_to_sess(), snmp_sess_add_ex(), snmp_sess_init(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
.SH "Author"
.PP 
Generated automatically by Doxygen for net-snmp from the source code.

						