Logo
Home page Net-SNMP

Archive Search:

Require all words?

Site Search:
Google

snmp_session Struct Reference

The snmp session structure. More...

#include <types.h>

Data Fields

long  version
  snmp version
int  retries
  Number of retries before timeout.
long  timeout
  Number of uS until first timeout, then exponential backoff.
u_long  flags
struct snmp_session subsession
struct snmp_session next
char *  peername
  name or address of default peer (may include transport specifier and/or port number)
u_short  remote_port
  UDP port number of peer.
char *  localname
  My Domain name or dotted IP address, 0 for default.
u_short  local_port
  My UDP port number, 0 for default, picked randomly.
u_char *(*  authenticator )(u_char *, size_t *, u_char *, size_t)
  Authentication function or NULL if null authentication is used.
netsnmp_callback  callback
  Function to interpret incoming data.
void *  callback_magic
  Pointer to data that the callback function may consider important.
int  s_errno
  copy of system errno
int  s_snmp_errno
  copy of library errno
long  sessid
  Session id - AgentX only.
u_char *  community
  community for outgoing requests.
size_t  community_len
  Length of community name.
size_t  rcvMsgMaxSize
  Largest message to try to receive.
size_t  sndMsgMaxSize
  Largest message to try to send.
u_char  isAuthoritative
  are we the authoritative engine?
u_char *  contextEngineID
  authoritative snmpEngineID
size_t  contextEngineIDLen
  Length of contextEngineID.
u_int  engineBoots
  initial engineBoots for remote engine
u_int  engineTime
  initial engineTime for remote engine
char *  contextName
  authoritative contextName
size_t  contextNameLen
  Length of contextName.
u_char *  securityEngineID
  authoritative snmpEngineID
size_t  securityEngineIDLen
  Length of contextEngineID.
char *  securityName
  on behalf of this principal
size_t  securityNameLen
  Length of securityName.
oid *  securityAuthProto
  auth protocol oid
size_t  securityAuthProtoLen
  Length of auth protocol oid.
u_char  securityAuthKey [USM_AUTH_KU_LEN]
  Ku for auth protocol XXX.
size_t  securityAuthKeyLen
  Length of Ku for auth protocol.
u_char *  securityAuthLocalKey
  Kul for auth protocol.
size_t  securityAuthLocalKeyLen
  Length of Kul for auth protocol XXX.
oid *  securityPrivProto
  priv protocol oid
size_t  securityPrivProtoLen
  Length of priv protocol oid.
u_char  securityPrivKey [USM_PRIV_KU_LEN]
  Ku for privacy protocol XXX.
size_t  securityPrivKeyLen
  Length of Ku for priv protocol.
u_char *  securityPrivLocalKey
  Kul for priv protocol.
size_t  securityPrivLocalKeyLen
  Length of Kul for priv protocol XXX.
int  securityModel
  snmp security model, v1, v2c, usm
int  securityLevel
  noAuthNoPriv, authNoPriv, authPriv
char *  paramName
  target param name
void *  securityInfo
  security module specific
void *  myvoid
  use as you want data

Detailed Description

The snmp session structure.

Definition at line 260 of file types.h.


Field Documentation

u_char*(* snmp_session::authenticator)(u_char *, size_t *, u_char *, size_t)

Authentication function or NULL if null authentication is used.

netsnmp_callback snmp_session::callback

Function to interpret incoming data.

Definition at line 287 of file types.h.

Pointer to data that the callback function may consider important.

Definition at line 291 of file types.h.

community for outgoing requests.

Definition at line 303 of file types.h.

Length of community name.

Definition at line 305 of file types.h.

authoritative snmpEngineID

Definition at line 317 of file types.h.

Length of contextEngineID.

Definition at line 319 of file types.h.

authoritative contextName

Definition at line 325 of file types.h.

Length of contextName.

Definition at line 327 of file types.h.

initial engineBoots for remote engine

Definition at line 321 of file types.h.

initial engineTime for remote engine

Definition at line 323 of file types.h.

are we the authoritative engine?

Definition at line 315 of file types.h.

My UDP port number, 0 for default, picked randomly.

Definition at line 281 of file types.h.

My Domain name or dotted IP address, 0 for default.

Definition at line 279 of file types.h.

use as you want data

used by 'SNMP_FLAGS_RESP_CALLBACK' handling in the agent XXX: or should we add a new field into this structure?

Definition at line 381 of file types.h.

target param name

Definition at line 368 of file types.h.

name or address of default peer (may include transport specifier and/or port number)

Definition at line 275 of file types.h.

Largest message to try to receive.

Definition at line 307 of file types.h.

UDP port number of peer.

(NO LONGER USED - USE peername INSTEAD)

Definition at line 277 of file types.h.

Number of retries before timeout.

Definition at line 267 of file types.h.

copy of system errno

Definition at line 293 of file types.h.

copy of library errno

Definition at line 295 of file types.h.

u_char snmp_session::securityAuthKey[USM_AUTH_KU_LEN]

Ku for auth protocol XXX.

Definition at line 342 of file types.h.

Length of Ku for auth protocol.

Definition at line 344 of file types.h.

Kul for auth protocol.

Definition at line 346 of file types.h.

Length of Kul for auth protocol XXX.

Definition at line 348 of file types.h.

auth protocol oid

Definition at line 338 of file types.h.

Length of auth protocol oid.

Definition at line 340 of file types.h.

authoritative snmpEngineID

Definition at line 329 of file types.h.

Length of contextEngineID.

Definition at line 331 of file types.h.

security module specific

Definition at line 373 of file types.h.

noAuthNoPriv, authNoPriv, authPriv

Definition at line 366 of file types.h.

snmp security model, v1, v2c, usm

Definition at line 364 of file types.h.

on behalf of this principal

Definition at line 333 of file types.h.

Length of securityName.

Definition at line 335 of file types.h.

u_char snmp_session::securityPrivKey[USM_PRIV_KU_LEN]

Ku for privacy protocol XXX.

Definition at line 355 of file types.h.

Length of Ku for priv protocol.

Definition at line 357 of file types.h.

Kul for priv protocol.

Definition at line 359 of file types.h.

Length of Kul for priv protocol XXX.

Definition at line 361 of file types.h.

priv protocol oid

Definition at line 351 of file types.h.

Length of priv protocol oid.

Definition at line 353 of file types.h.

Session id - AgentX only.

Definition at line 297 of file types.h.

Largest message to try to send.

Definition at line 309 of file types.h.

Number of uS until first timeout, then exponential backoff.

Definition at line 269 of file types.h.

snmp version

Definition at line 265 of file types.h.


The documentation for this struct was generated from the following file:

Generated on 28 Sep 2009 for net-snmp by  doxygen 1.6.1

Last modified: Monday, 28-Sep-2009 20:19:10 UTC
For questions regarding web content and site functionality, please write to the net-snmp-users mail list.