net-snmp 3.9.2 → 3.9.3

package/README.md

@@ -655,7 +655,7 @@ for v1 and v2c.
 
 ## session.on ("close", callback)
 
-The `close` event is emitted by the session when the sessions underlying UDP
+The `close` event is emitted by the session when the session's underlying UDP
 socket is closed.
 
 No arguments are passed to the callback.
@@ -665,7 +665,7 @@ in the failure of each outstanding request.  The error passed back through to
 each request will be an instance of the `Error` class with the errors
 `message` attribute set to `Socket forcibly closed`.
 
-The following example prints a message to the console when a sessions
+The following example prints a message to the console when a session's
 underlying UDP socket is closed:
 
 ```js
@@ -676,7 +676,7 @@ session.on ("close", function () {
 
 ## session.on ("error", callback)
 
-The `error` event is emitted by the session when the sessions underlying UDP
+The `error` event is emitted by the session when the session's underlying UDP
 socket emits an error.
 
 The following arguments will be passed to the `callback` function:
@@ -685,7 +685,7 @@ The following arguments will be passed to the `callback` function:
    will contain a detailed error message.
 
 The following example prints a message to the console when an error occurs
-with a sessions underlying UDP socket, the session is then closed:
+with a session's underlying UDP socket, the session is then closed:
 
 ```js
 session.on ("error", function (error) {
@@ -2704,6 +2704,40 @@ Sends a "ping" to the master agent using a `Ping` PDU, to confirm that the maste
 responsive.  The supplied `callback` is called on reception of the subsequent
 `Response` PDU from the master to the `Ping` PDU.
 
+## subagent.on ("close", callback)
+
+The `close` event is emitted by the subagent when its underlying TCP socket is closed.
+
+No arguments are passed to the callback.
+
+The following example prints a message to the console when a subagent's
+underlying TCP socket is closed:
+
+```js
+subagent.on ("close", function () {
+    console.log ("Subagent socket closed");
+});
+```
+
+## subagent.on ("error", callback)
+
+The `error` event is emitted by the subagent when its underlying TCP socket emits an error.
+
+The following argument will be passed to the `callback` function:
+
+ * `error` - An instance of the `Error` class, the exposed `message` attribute
+   will contain a detailed error message.
+
+The following example prints a message to the console when an error occurs
+with a subagent's underlying TCP socket, and the subagent is then closed:
+
+```js
+subagent.on ("error", function (error) {
+    console.log (error.toString ());
+    subagent.close ();
+});
+```
+
 
 # Example Programs
 
@@ -3251,6 +3285,10 @@ Example programs are included under the module's `example` directory.
 
  * Fix MIB parsing of non-comments in descriptions and unmatched quotations
 
+## Version 3.9.3 - 28/04/2023
+
+ * Add AgentX subagent "error" and "close" events
+
 # License
 
 Copyright (c) 2020 Mark Abrahams <mark@abrahams.co.nz>

package/example/agentx-subagent.js

@@ -66,6 +66,9 @@ agent.open(function (error, data) {
         agent.registerProvider (tableProvider, null);
         agent.getMib ().addTableRow ("smallIfTable", [1, "lo", 24]);
         agent.getMib ().addTableRow ("smallIfTable", [2, "eth0", 6]);
+        agent.on("close", function() {
+            console.log ("Subagent socket closed");
+        });
     }
 });
 

package/example/mib-parser.js

@@ -35,26 +35,12 @@ var mib = agent.getMib ();
 var authorizer = agent.getAuthorizer ();
 authorizer.addCommunity ("public");
 
-
 // IF-MIB load and providers registration
 store.loadFromFile (mibDir + "IANAifType-MIB.mib");
 store.loadFromFile (mibDir + "IF-MIB.mib");
 providers = store.getProvidersForModule ("IF-MIB");
 mib.registerProviders (providers);
 
-store.loadFromFile (mibDir + "SNMP-FRAMEWORK-MIB.mib");
-store.loadFromFile (mibDir + "INET-ADDRESS-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-SMI.mib");
-store.loadFromFile (mibDir + "CISCO-TC.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-TC-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-WLAN-MIB.mib");
-store.loadFromFile (mibDir + "ENTITY-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-RF-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-AP-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-DOT11-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-REAP-MIB.mib");
-store.loadFromFile (mibDir + "CISCO-LWAPP-CDP-MIB.mib");
-
 // ifNumber
 // Scalar type - setScalarValue() and getScalarValue() are the entire API for these
 mib.setScalarValue ("ifNumber", 5);

package/index.js

@@ -5708,6 +5708,16 @@ var Subagent = function (options) {
 	this.setTransactions = {};
 };
 
+util.inherits (Subagent, events.EventEmitter);
+
+Subagent.prototype.onClose = function () {
+	this.emit ("close");
+};
+
+Subagent.prototype.onError = function (error) {
+	this.emit ("error", error);
+};
+
 Subagent.prototype.getMib = function () {
 	return this.mib;
 };
@@ -5720,9 +5730,8 @@ Subagent.prototype.connectSocket = function () {
 	});
 
 	this.socket.on ("data", me.onMsg.bind (me));
-	this.socket.on ("error", function (error) {
-		console.error (error);
-	});
+	this.socket.on ("error", me.onError.bind (me));
+	this.socket.on ("close", me.onClose.bind (me));
 };
 
 Subagent.prototype.open = function (callback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "net-snmp",
-  "version": "3.9.2",
+  "version": "3.9.3",
   "description": "JavaScript implementation of the Simple Network Management Protocol (SNMP)",
   "main": "index.js",
   "directories": {