Merge pull request #2 from joelmenezes/Access_Remote_Queues

Added logic to receive messages from remote queue. Refactored logic t…

Author: joelmenezes

MSMQLib/MSMQInterface.cs

@@ -27,21 +27,12 @@ public async Task<object> CreateQueue(string path)
         }
 
         /// <summary>
-        /// Sends a message to a remote MSMQ queue.
+        /// Creates a MSMQ queue.
         /// </summary>
-        /// <param name="input">The queue's path and the message.</param>
-        /// <returns>True if queue can be connected to.</returns>
-        public async Task<object> SendToRemoteQueue(dynamic input)
+        /// <param name="path">The remote queue's path.</param>
+        /// <returns>True.</returns>
+        public async Task<object> ConnectRemote(string path)
         {
-            string path = (string)input.path;
-            string message = (string)input.message;
-
-            byte[] bytes = Encoding.UTF8.GetBytes(message);
-            MessageQueue queue = new MessageQueue(path);
-            Message msg = new Message();
-            msg.BodyStream = new MemoryStream(bytes); 
-
-            await Task.Run(() => queue.Send(msg));
             return true;
         }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "updated-node-msmq",
-  "version": "0.1.6",
+  "version": "0.1.9",
   "description": "A MSMQ implementation for node.js",
   "main": "dist/index.js",
   "scripts": {

proxy.js

@@ -17,5 +17,5 @@ export var queueProxy = {
 	receive: getMethod('ReceiveMessages'),
 	list: getMethod('GetAllMessages'),
   clear: getMethod('PurgeQueue'),
-  sendRemote: getMethod('SendToRemoteQueue')
+  connectRemote: getMethod('ConnectRemote')
 };

queue.js

@@ -27,13 +27,9 @@ export default class Queue extends EventEmitter {
 		return new Queue(path);
 	}
 
-  static sendToRemoteQueue(path, message, cb) {
-    let formattedMessage = JSON.stringify(message);
-
-		return queueProxy.sendRemote({
-			path: path,
-			message: formattedMessage
-		}, cb);
+  static connectToRemoteQueue(path) {
+    queueProxy.connectRemote(path, true);
+    return new Queue(path);
   }
 
 	startReceiving() {

readme.md

@@ -10,15 +10,15 @@ NPM package is published as updated-node-msmq. https://www.npmjs.com/package/upd
 
 * Support for Node.Js 6.x, 7.x, 8.x, 9.x, 10.x
 * Support to push objects to the queue instead of just strings. 
-* Support to send messages to a queue on a **remote** machine.
+* Support to send/receive messages to/from a queue on a **remote** machine.
 
 ## Install
 
 ```
 $ npm install --save updated-node-msmq
 ```
 
-## Usage
+## Usage (Local Queue)
 
 ### Send a message
 
@@ -33,6 +33,48 @@ var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
 queue.send('Hello from Node.JS!');
 ```
 
+### Receive messages
+
+Start receiving messages from a queue.
+
+```js
+const msmq = require('updated-node-msmq');
+
+var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
+
+// Set receive listener callback
+queue.on('receive', (msg) => {
+  console.log(msg.body);
+});
+
+// Start receiving messages from the queue
+queue.startReceiving();
+```
+
+### Get all messages
+
+Gets all messages without removing them from queue.
+
+```js
+const msmq = require('updated-node-msmq');
+
+var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
+var messages = queue.getAllMessages();
+```
+
+### Purge a queue
+
+Clears all messages from the queue.
+
+```js
+const msmq = require('updated-node-msmq');
+
+var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
+queue.purge();
+```
+
+## Usage (Remote Queue)
+
 ### Send a message to a remote queue
 
 Sends a message to a remote MSMQ queue.
@@ -41,35 +83,26 @@ Sends a message to a remote MSMQ queue.
 const msmq = require('updated-node-msmq');
 
 // Send message to a remote queue using hostname
-msmq.sendToRemoteQueue('FormatName:DIRECT=OS:mobile-000000\\private$\\privatetest', 'Hello from Node.JS!');
+let queue1 = msmq.connectToRemoteQueue('FormatName:DIRECT=OS:mobile-000000\\private$\\privatetest');
 
-msmq.sendToRemoteQueue('FormatName:DIRECT=TCP:192.168.1.5\\private$\\privatetest', 'Hello again from Node.JS!');
-```
+queue1.send('Hello again from Node.JS!');
 
-#### Note: 
-* Creating a queue on a remote machine is not currently supported by MSMQ.
-* To send messages to a remote queue, MSMQ should be enabled in the sender's machine too. Also, in the _Security_ tab of the queue on the remote machine should have the appropriate permissions set for _Everyone_ and _ANONYMOUS LOGON_.
-* The queue should already be created on the remote machine.
-* The format to send a message to a remote queue is as follows:
-`
-msmsq.sendToRemoteQueue(path, message);
-`
-* `path` has to be in the following format:
+// Send message to a remote queue using IP address
+let queue2 = msmq.connectToRemoteQueue('FormatName:DIRECT=TCP:192.168.5.21\\private$\\privatetest');
 
-    `FormatName:DIRECT=TCP:`_`<ip_address>`_`\\private$\\`_`<queue_name>`_`
+queue2.send('Hello again from Node.JS!');
 
-    or
 
-    `FormatName:DIRECT=OS:`_`<machine_name>`_`\\private$\\`_`<queue_name>`_`
+```
 
-### Receive messages
+### Receive messages from a remote queue
 
-Start receiving messages from a queue.
+Start receiving messages from a remote queue.
 
 ```js
 const msmq = require('updated-node-msmq');
 
-var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
+var queue = msmq.connectToRemoteQueue('FormatName:DIRECT=OS:mobile-000000\\private$\\privatetest');
 
 // Set receive listener callback
 queue.on('receive', (msg) => {
@@ -82,25 +115,31 @@ queue.startReceiving();
 
 ### Get all messages
 
-Gets all messages without removing them from queue.
+Gets all messages without removing them from a remote queue.
 
 ```js
 const msmq = require('updated-node-msmq');
 
-var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
+var queue = msmq.connectToRemoteQueue('.\\Private$\\MyAwesomeQueue');
 var messages = queue.getAllMessages();
 ```
 
-### Purge a queue
+#### Note: 
+* Creating a queue / Checking if a queue exists on a remote machine is currently not supported by MSMQ.
+* To communicate with a remote queue, MSMQ should be enabled in the sender's machine too. Also, in the _Security_ tab of the queue on the remote machine should have the appropriate permissions set for _Everyone_ and _ANONYMOUS LOGON_.
+* The queue should already be created on the remote machine.
+* The format to connect to a remote queue is as follows:
+`
+msmsq.connectToRemoteQueue(path);
+`
+* `path` has to be in the following format:
 
-Clears all messages from the queue.
+    `FormatName:DIRECT=TCP:`_`<ip_address>`_`\\private$\\`_`<queue_name>`_`
 
-```js
-const msmq = require('updated-node-msmq');
+    or
+
+    `FormatName:DIRECT=OS:`_`<machine_name>`_`\\private$\\`_`<queue_name>`_`
 
-var queue = msmq.openOrCreateQueue('.\\Private$\\MyAwesomeQueue');
-queue.purge();
-```
 
 ## License