feat(bacnet-client): implement close function for BACstack and underlying UDP socket

fh1ch · fh1ch · commit 4be06bd2afd3 · 2017-06-27T12:26:32.000+02:00
diff --git a/index.js b/index.js
@@ -133,5 +133,16 @@ module.exports = function(settings) {
     client.readPropertyMultiple(address, propertyIdAndArrayIndex, next);
   };
 
+  /**
+   * Unloads the current BACstack instance and closes the underlying UDP socket.
+   * @function bacstack.close
+   * @example
+   * var client = new bacnet();
+   * client.close();
+   */
+  self.close = function() {
+    client.close();
+  };
+
   return self;
 };
diff --git a/lib/bacnet-client.js b/lib/bacnet-client.js
@@ -316,6 +316,9 @@ module.exports = function(settings) {
   };
 
   transport.setHandler(receiveData);
+  self.close = function() {
+    transport.close();
+  };
 
   return self;
 };
diff --git a/lib/bacnet-transport.js b/lib/bacnet-transport.js
@@ -33,5 +33,9 @@ module.exports = function(settings) {
     server.setBroadcast(true);
   });
 
+  self.close = function() {
+    server.close();
+  };
+
   return self;
 };
diff --git a/test/integration/read-property-multiple.spec.js b/test/integration/read-property-multiple.spec.js
@@ -3,14 +3,14 @@ var utils = require('./utils');
 
 describe('bacstack - readPropertyMultiple integration', function() {
   it('should return a timeout error if no device is available', function(next) {
-    var client = utils.globalBacnetClient;
-    this.timeout(5000);
+    var client = new utils.bacnetClient({adpuTimeout: 200});
     var requestArray = [
       {objectIdentifier: {type: 8, instance: 4194303}, propertyReferences: [{propertyIdentifier: 8}]}
     ];
     client.readPropertyMultiple('127.0.0.1', requestArray, function(err, value) {
       expect(err).to.eql(new Error('ERR_TIMEOUT'));
       expect(value).to.eql(undefined);
+      client.close();
       next();
     });
   });
@@ -49,6 +49,7 @@ describe('bacstack - readPropertyMultiple integration', function() {
         {value: {value: [0], bits_used: 1}, type: 8}
       ]);
       expect(object[5102]).to.deep.equal([{value: 41, type: 9}]);
+      client.close();
       next();
     });
     transport.handler(data, '127.0.0.1');
@@ -99,6 +100,7 @@ describe('bacstack - readPropertyMultiple integration', function() {
       expect(object[5103]).to.deep.equal([{value: '', type: 7}]);
       expect(object[5104]).to.deep.equal([{value: 0, type: 9}]);
       expect(object[5107]).to.deep.equal([{value: 1, type: 2}]);
+      client.close();
       next();
     });
     transport.handler(data, '127.0.0.1');
diff --git a/test/integration/read-property.spec.js b/test/integration/read-property.spec.js
@@ -3,11 +3,11 @@ var utils = require('./utils');
 
 describe('bacstack - readProperty integration', function() {
   it('should return a timeout error if no device is available', function(next) {
-    var client = utils.globalBacnetClient;
-    this.timeout(5000);
+    var client = new utils.bacnetClient({adpuTimeout: 200});
     client.readProperty('127.0.0.1', 8, 44301, 28, null, function(err, value) {
       expect(err).to.eql(new Error('ERR_TIMEOUT'));
       expect(value).to.eql(undefined);
+      client.close();
       next();
     });
   });
diff --git a/test/integration/utils.js b/test/integration/utils.js
@@ -1,7 +1,6 @@
 var bacnet = require('../../');
 
 module.exports.bacnetClient = bacnet;
-module.exports.globalBacnetClient = bacnet();
 
 module.exports.transportStub = function() {
   var self = this;
@@ -16,6 +15,7 @@ module.exports.transportStub = function() {
     return 1482;
   };
   self.send = function() {};
+  self.close = function() {};
   return self;
 };
 
diff --git a/test/integration/who-is.spec.js b/test/integration/who-is.spec.js
@@ -3,14 +3,15 @@ var utils = require('./utils');
 
 describe('bacstack - whoIs integration', function() {
   it('should not invoke a event if no device is available', function(next) {
-    var client = utils.globalBacnetClient;
-    this.timeout(5000);
+    var client = new utils.bacnetClient({adpuTimeout: 200});
     client.on('iAm', function(address, deviceId, maxAdpu, segmentation, vendorId) {
+      client.close();
       next(new Erro('Unallowed Callback'));
     });
     setTimeout(function() {
+      client.close();
       next();
-    }, 3100);
+    }, 300);
     client.whoIs();
   });
 });
diff --git a/test/integration/write-property.spec.js b/test/integration/write-property.spec.js
@@ -3,11 +3,11 @@ var utils = require('./utils');
 
 describe('bacstack - writeProperty integration', function() {
   it('should return a timeout error if no device is available', function(next) {
-    var client = utils.globalBacnetClient;
-    this.timeout(5000);
+    var client = new utils.bacnetClient({adpuTimeout: 200});
     client.writeProperty('127.0.0.1', 8, 44301, 28, 12, [{Tag: 4, Value: 100}], function(err, value) {
       expect(err).to.eql(new Error('ERR_TIMEOUT'));
       expect(value).to.eql(undefined);
+      client.close();
       next();
     });
   });
