Advanced Robotics Kit (Ark) – ark::snmp

Docs: ark::snmp::SnmpClient

Mon, 01 Jan 0001 00:00:00 +0000

Defined in header “ark/snmp/snmp_client.hh”.

Thin C++ wrapper around net-snmp session APIs.

Why this exists:

SnmpClient(const SnmpClientConfiguration & config)
~SnmpClient()
SnmpClient()
No copies. SnmpClient owns a net-snmp session handle.
SnmpClient & operator=()
No copies. SnmpClient owns a net-snmp session handle.
SnmpClient()
No moves. Keep ownership simple and avoid invalidating session-owned memory.
SnmpClient & operator=()
No moves. Keep ownership simple and avoid invalidating session-owned memory.
std::vector< std::string > list_mibs()
Returns loaded MIB module names visible to net-snmp in this process.
std::optional< SnmpResult > try_get(const std::string & oid)
Gets a single OID value, returning empty if no variable is returned.
SnmpResult get(const std::string & oid)
Gets a single OID value, throwing on empty result.
std::vector< SnmpResult > get(const std::vector< std::string > & oids)
Gets multiple OID values with a single request PDU.
std::vector< SnmpResult > get_bulk(const std::string & root_oid, int non_repeaters, int max_repetitions)
Performs a GETBULK operation for subtree/root OID.

Mon, 01 Jan 0001 00:00:00 +0000

Defined in header “ark/snmp/snmp_client.hh”.

Connection/configuration fields used to open an SNMP session.

Mon, 01 Jan 0001 00:00:00 +0000

Defined in header “ark/snmp/test/snmp_mock_agent_fixture.hh”.

Lightweight UDP mock SNMP agent used by tests.

This fixture runs a background thread that listens for incoming SNMP requests and emits a minimal response set for known OIDs.

SnmpMockAgentFixture(uint16_t port)
Constructor. Starts the background mock-agent thread bound to the given port.
~SnmpMockAgentFixture()
Destructor. Stops the background thread and releases resources.
SnmpMockAgentFixture()
No copies.
SnmpMockAgentFixture & operator=()
No copies.
uint16_t port()
Returns the actual UDP port the fixture bound (useful when constructed with port 0).
void rethrow_if_failed()
Rethrows any exception captured from the background worker thread.

Mon, 01 Jan 0001 00:00:00 +0000

Defined in header “ark/snmp/snmp_client.hh”.

Represents one OID/value tuple returned by an SNMP request.

std::string oid
OID in textual dotted format (for example: 1.3.6.1.2.1.1.5.0).
SnmpValue value
Decoded value for the OID.

Mon, 01 Jan 0001 00:00:00 +0000

Defined in header “ark/snmp/snmp_client.hh”.

A simple typed representation of an SNMP value.

SNMP can encode many wire-level types; this wrapper focuses on the “major” value families that application code commonly consumes:

Type type= Type::Null
The resolved value type.
std::variant< int64_t, uint64_t, std::string > value= uint64_t{0}
The decoded value payload.