Fix #54: Add end() method to Client.

yui · Apr 3, 2012 · 142e093 · 142e093
1 parent a3fea60
commit 142e093
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/doc/api/index.mustache b/doc/api/index.mustache
@@ -113,6 +113,12 @@ Emitted when an Agent requests a page (test or capture) from the connected Hub.
 Begin the connection to the Hub.
 </p>
 
+<h4>client.end()</h4>
+
+<p>
+End the connection to the Hub.
+</p>
+
 <h4>client.createBatch([configuration])</h4>
 
 <p>

diff --git a/lib/client.js b/lib/client.js
@@ -198,6 +198,18 @@ Client.prototype.connect = function (cb) {
     });
 };
 
+/**
+ * Disconnect from the Yeti Hub.
+ *
+ * @method end
+ */
+Client.prototype.end = function () {
+    if (!this.session) {
+        throw new Error("Session not started.");
+    }
+    this.session.end();
+};
+
 /**
  * @method handleBlizzardError
  * @protected

diff --git a/test/functional.js b/test/functional.js
@@ -265,7 +265,7 @@ function attachServerContext(testContext, explicitRoute) {
                 topic: hub.clientTopic(route + "/"),
                 teardown: function (topic) {
                     // TODO Add end method, bug #54.
-                    // topic.client.end();
+                    topic.client.end();
                 },
                 "a browser for testing": {
                     topic: hub.phantomTopic(),