All Transports now emit a request event right before passing the AD…

…U to the underlying Connection.
mm-gmbd · Feb 14, 2014 · 126a853 · 126a853
1 parent 4ae8138
commit 126a853
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 2 deletions.
diff --git a/example/init-serial-rtu.js b/example/init-serial-rtu.js
@@ -63,6 +63,13 @@ connection.on('data', function(data)
   console.log('[connection#data]', data);
 });
 
+var transport = master.getTransport();
+
+transport.on('request', function(transaction)
+{
+  console.log('[transport#request] %s', transaction.getRequest());
+});
+
 master.once('connected', function()
 {
   var t1 = master.readDiscreteInputs(0x0000, 8, {

diff --git a/example/verbose-init-tcp-ip.js b/example/verbose-init-tcp-ip.js
@@ -88,6 +88,11 @@ connection.on('data', function(data)
 //     periods and CRC checksum.
 var transport = new IpTransport(connection);
 
+transport.on('request', function(transaction)
+{
+  console.log('[transport#request] %s', transaction.getRequest());
+});
+
 // Master is responsible for managing and executing transactions.
 // Transactions, when executed, are placed in a queue and sent only if a number
 // of currently sent requests is less than the `maxConcurrentRequests` option.

diff --git a/lib/transports/AsciiTransport.js b/lib/transports/AsciiTransport.js
@@ -32,6 +32,8 @@ var FRAME_LF = 0x0A;
  * @constructor
  * @extends {Transport}
  * @param {Connection} connection
+ * @event request Emitted right before the ADU is passed to the underlying
+ * `Connection`.
  */
 function AsciiTransport(connection)
 {
@@ -99,7 +101,11 @@ AsciiTransport.prototype.sendRequest = function(transaction)
 
   this.transaction = transaction;
 
-  this.connection.write(this.getAdu(transaction));
+  var adu = this.getAdu(transaction);
+
+  this.emit('request', transaction);
+
+  this.connection.write(adu);
 
   transaction.start(this.handleTimeout);
 };

diff --git a/lib/transports/IpTransport.js b/lib/transports/IpTransport.js
@@ -11,6 +11,8 @@ module.exports = IpTransport;
  * @constructor
  * @extends {Transport}
  * @param {Connection} connection
+ * @event request Emitted right before the ADU is passed to the underlying
+ * `Connection`.
  */
 function IpTransport(connection)
 {
@@ -156,6 +158,8 @@ IpTransport.prototype.sendRequest = function(transaction)
 
   this.transactions[id] = transaction;
 
+  this.emit('request', transaction);
+
   this.connection.write(adu);
 
   transaction.start(this.createTimeoutHandler(id));

diff --git a/lib/transports/RtuTransport.js b/lib/transports/RtuTransport.js
@@ -58,6 +58,8 @@ var CRC_TABLE = [
  * @constructor
  * @extends {Transport}
  * @param {RtuTransport.Options|object} options
+ * @event request Emitted right before the ADU is passed to the underlying
+ * `Connection`.
  */
 function RtuTransport(options)
 {
@@ -169,7 +171,11 @@ RtuTransport.prototype.sendRequest = function(transaction)
 
   this.transaction = transaction;
 
-  this.connection.write(this.getAdu(transaction));
+  var adu = this.getAdu(transaction);
+
+  this.emit('request', transaction);
+
+  this.connection.write(adu);
 
   transaction.start(this.handleTimeout);
 };