SNMP agent context. More...
#include <snmp_agent.h>
Data Fields | |
| NetContext * | netContext |
| TCP/IP stack context. More... | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| SnmpVersion | versionMin |
| Minimum version accepted by the SNMP agent. More... | |
| SnmpVersion | versionMax |
| Maximum version accepted by the SNMP agent. More... | |
| uint16_t | port |
| SNMP port number. More... | |
| uint16_t | trapPort |
| SNMP trap port number. More... | |
| SnmpAgentRandCallback | randCallback |
| Random data generation callback function. More... | |
| bool_t | running |
| Operational state of the SNMP agent. More... | |
| bool_t | stop |
| Stop request. More... | |
| OsMutex | mutex |
| Mutex preventing simultaneous access to SNMP agent context. More... | |
| OsEvent | event |
| Event object used to poll the underlying socket. More... | |
| OsTaskParameters | taskParams |
| Task parameters. More... | |
| OsTaskId | taskId |
| Task identifier. More... | |
| uint8_t | enterpriseOid [SNMP_MAX_OID_SIZE] |
| Enterprise OID. More... | |
| size_t | enterpriseOidLen |
| Length of the enterprise OID. More... | |
| const MibModule * | mibTable [SNMP_AGENT_MAX_MIBS] |
| MIB modules. More... | |
| SnmpUserEntry | communityTable [SNMP_AGENT_MAX_COMMUNITIES] |
| Community strings. More... | |
| SnmpUserEntry | userTable [SNMP_AGENT_MAX_USERS] |
| List of users. More... | |
| SnmpGroupEntry | groupTable [SNMP_AGENT_GROUP_TABLE_SIZE] |
| List of groups. More... | |
| SnmpAccessEntry | accessTable [SNMP_AGENT_ACCESS_TABLE_SIZE] |
| Access rights for groups. More... | |
| SnmpViewEntry | viewTable [SNMP_AGENT_VIEW_TABLE_SIZE] |
| Families of subtrees within MIB views. More... | |
| Socket * | socket |
| Underlying socket. More... | |
| NetInterface * | localInterface |
| Network interface the SNMP request was received on. More... | |
| IpAddr | localIpAddr |
| Destination IP address of the received SNMP request. More... | |
| IpAddr | remoteIpAddr |
| Source IP address of the received SNMP request. More... | |
| uint16_t | remotePort |
| Source port of the received SNMP request. More... | |
| int32_t | requestId |
| Request identifier. More... | |
| SnmpMessage | request |
| SNMP request message. More... | |
| SnmpMessage | response |
| SNMP response message. More... | |
| SnmpUserEntry | user |
| Security profile of current user. More... | |
| uint8_t | contextEngine [SNMP_MAX_CONTEXT_ENGINE_SIZE] |
| Context engine identifier. More... | |
| size_t | contextEngineLen |
| Length of the context engine identifier. More... | |
| char_t | contextName [SNMP_MAX_CONTEXT_NAME_LEN+1] |
| Context name. More... | |
| systime_t | systemTime |
| System time. More... | |
| int32_t | engineBoots |
| Number of times that the SNMP engine has rebooted. More... | |
| int32_t | engineTime |
| SNMP engine time. More... | |
| int32_t | msgId |
| Message identifier. More... | |
| uint8_t | salt [8] |
| Integer initialized to a random value at boot time. More... | |
| uint8_t | privParameters [8] |
| Privacy parameters. More... | |
| SnmpAgentState | informState |
| State of the inform sending process. More... | |
| int32_t | informRequestId |
| Inform request identifier. More... | |
| systime_t | informTimestamp |
| Timestamp to manage retransmissions. More... | |
| uint_t | informRetransmitCount |
| Retransmission counter. More... | |
| OsEvent | informEvent |
| Event object. More... | |
| uint8_t | informContextEngine [SNMP_MAX_CONTEXT_ENGINE_SIZE] |
| Context engine identifier of the remote application. More... | |
| size_t | informContextEngineLen |
| Length of the context engine identifier. More... | |
| int32_t | informEngineBoots |
| Number of times that the remote SNMP engine has rebooted. More... | |
| int32_t | informEngineTime |
| SNMP engine time of the remote application. More... | |
| int32_t | informMsgId |
| Message identifier. More... | |
Detailed Description
SNMP agent context.
Definition at line 148 of file snmp_agent.h.
Field Documentation
◆ accessTable
| SnmpAccessEntry accessTable[SNMP_AGENT_ACCESS_TABLE_SIZE] |
Access rights for groups.
Definition at line 174 of file snmp_agent.h.
◆ communityTable
| SnmpUserEntry communityTable[SNMP_AGENT_MAX_COMMUNITIES] |
Community strings.
Definition at line 167 of file snmp_agent.h.
◆ contextEngine
| uint8_t contextEngine[SNMP_MAX_CONTEXT_ENGINE_SIZE] |
Context engine identifier.
Definition at line 187 of file snmp_agent.h.
◆ contextEngineLen
| size_t contextEngineLen |
Length of the context engine identifier.
Definition at line 188 of file snmp_agent.h.
◆ contextName
| char_t contextName[SNMP_MAX_CONTEXT_NAME_LEN+1] |
Context name.
Definition at line 189 of file snmp_agent.h.
◆ engineBoots
| int32_t engineBoots |
Number of times that the SNMP engine has rebooted.
Definition at line 191 of file snmp_agent.h.
◆ engineTime
| int32_t engineTime |
SNMP engine time.
Definition at line 192 of file snmp_agent.h.
◆ enterpriseOid
| uint8_t enterpriseOid[SNMP_MAX_OID_SIZE] |
Enterprise OID.
Definition at line 163 of file snmp_agent.h.
◆ enterpriseOidLen
| size_t enterpriseOidLen |
Length of the enterprise OID.
Definition at line 164 of file snmp_agent.h.
◆ event
| OsEvent event |
Event object used to poll the underlying socket.
Definition at line 160 of file snmp_agent.h.
◆ groupTable
| SnmpGroupEntry groupTable[SNMP_AGENT_GROUP_TABLE_SIZE] |
List of groups.
Definition at line 173 of file snmp_agent.h.
◆ informContextEngine
| uint8_t informContextEngine[SNMP_MAX_CONTEXT_ENGINE_SIZE] |
Context engine identifier of the remote application.
Definition at line 204 of file snmp_agent.h.
◆ informContextEngineLen
| size_t informContextEngineLen |
Length of the context engine identifier.
Definition at line 205 of file snmp_agent.h.
◆ informEngineBoots
| int32_t informEngineBoots |
Number of times that the remote SNMP engine has rebooted.
Definition at line 206 of file snmp_agent.h.
◆ informEngineTime
| int32_t informEngineTime |
SNMP engine time of the remote application.
Definition at line 207 of file snmp_agent.h.
◆ informEvent
| OsEvent informEvent |
Event object.
Definition at line 202 of file snmp_agent.h.
◆ informMsgId
| int32_t informMsgId |
Message identifier.
Definition at line 208 of file snmp_agent.h.
◆ informRequestId
| int32_t informRequestId |
Inform request identifier.
Definition at line 199 of file snmp_agent.h.
◆ informRetransmitCount
| uint_t informRetransmitCount |
Retransmission counter.
Definition at line 201 of file snmp_agent.h.
◆ informState
| SnmpAgentState informState |
State of the inform sending process.
Definition at line 198 of file snmp_agent.h.
◆ informTimestamp
| systime_t informTimestamp |
Timestamp to manage retransmissions.
Definition at line 200 of file snmp_agent.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 151 of file snmp_agent.h.
◆ localInterface
| NetInterface* localInterface |
Network interface the SNMP request was received on.
Definition at line 178 of file snmp_agent.h.
◆ localIpAddr
| IpAddr localIpAddr |
Destination IP address of the received SNMP request.
Definition at line 179 of file snmp_agent.h.
◆ mibTable
| const MibModule* mibTable[SNMP_AGENT_MAX_MIBS] |
MIB modules.
Definition at line 165 of file snmp_agent.h.
◆ msgId
| int32_t msgId |
Message identifier.
Definition at line 193 of file snmp_agent.h.
◆ mutex
| OsMutex mutex |
Mutex preventing simultaneous access to SNMP agent context.
Definition at line 159 of file snmp_agent.h.
◆ netContext
| NetContext* netContext |
TCP/IP stack context.
Definition at line 150 of file snmp_agent.h.
◆ port
| uint16_t port |
SNMP port number.
Definition at line 154 of file snmp_agent.h.
◆ privParameters
| uint8_t privParameters[8] |
Privacy parameters.
Definition at line 195 of file snmp_agent.h.
◆ randCallback
| SnmpAgentRandCallback randCallback |
Random data generation callback function.
Definition at line 156 of file snmp_agent.h.
◆ remoteIpAddr
| IpAddr remoteIpAddr |
Source IP address of the received SNMP request.
Definition at line 180 of file snmp_agent.h.
◆ remotePort
| uint16_t remotePort |
Source port of the received SNMP request.
Definition at line 181 of file snmp_agent.h.
◆ request
| SnmpMessage request |
SNMP request message.
Definition at line 183 of file snmp_agent.h.
◆ requestId
| int32_t requestId |
Request identifier.
Definition at line 182 of file snmp_agent.h.
◆ response
| SnmpMessage response |
SNMP response message.
Definition at line 184 of file snmp_agent.h.
◆ running
| bool_t running |
Operational state of the SNMP agent.
Definition at line 157 of file snmp_agent.h.
◆ salt
| uint8_t salt[8] |
Integer initialized to a random value at boot time.
Definition at line 194 of file snmp_agent.h.
◆ socket
| Socket* socket |
Underlying socket.
Definition at line 177 of file snmp_agent.h.
◆ stop
| bool_t stop |
Stop request.
Definition at line 158 of file snmp_agent.h.
◆ systemTime
| systime_t systemTime |
System time.
Definition at line 190 of file snmp_agent.h.
◆ taskId
| OsTaskId taskId |
Task identifier.
Definition at line 162 of file snmp_agent.h.
◆ taskParams
| OsTaskParameters taskParams |
Task parameters.
Definition at line 161 of file snmp_agent.h.
◆ trapPort
| uint16_t trapPort |
SNMP trap port number.
Definition at line 155 of file snmp_agent.h.
◆ user
| SnmpUserEntry user |
Security profile of current user.
Definition at line 185 of file snmp_agent.h.
◆ userTable
| SnmpUserEntry userTable[SNMP_AGENT_MAX_USERS] |
List of users.
Definition at line 170 of file snmp_agent.h.
◆ versionMax
| SnmpVersion versionMax |
Maximum version accepted by the SNMP agent.
Definition at line 153 of file snmp_agent.h.
◆ versionMin
| SnmpVersion versionMin |
Minimum version accepted by the SNMP agent.
Definition at line 152 of file snmp_agent.h.
◆ viewTable
| SnmpViewEntry viewTable[SNMP_AGENT_VIEW_TABLE_SIZE] |
Families of subtrees within MIB views.
Definition at line 175 of file snmp_agent.h.
The documentation for this struct was generated from the following file:
- cyclone_tcp/snmp/snmp_agent.h