From c9225f116a3d0c6ea4b08c6841586d7477f468c4 Mon Sep 17 00:00:00 2001 From: Evan Tahler Date: Sat, 30 Sep 2017 16:54:53 -0700 Subject: [PATCH] rename ActionheroClient to ActionheroWebsocketClient --- .gitignore | 4 +- bin/templates/package.json | 2 +- ...Client.js => actionheroWebsocketClient.js} | 42 +++++++------- ....jsdoc => actionheroWebsocketClient.jsdoc} | 46 +++++++-------- config/servers/websocket.js | 2 +- docs/ActionHero.Action.html | 2 +- ...ActionHero.ActionheroWebsocketClient.html} | 56 +++++++++---------- docs/ActionHero.CLI.html | 2 +- docs/ActionHero.Connection.html | 2 +- docs/ActionHero.Initializer.html | 2 +- docs/ActionHero.Server.html | 2 +- docs/ActionHero.Task.html | 2 +- docs/ActionHero.html | 4 +- docs/api.actions.html | 2 +- docs/api.cache.html | 2 +- docs/api.chatRoom.html | 2 +- docs/api.config.html | 2 +- docs/api.connections.html | 2 +- docs/api.documentation.html | 2 +- docs/api.exceptions.html | 2 +- docs/api.html | 2 +- docs/api.i18n.html | 2 +- docs/api.id.html | 2 +- docs/api.params.html | 2 +- docs/api.pids.html | 2 +- docs/api.redis.html | 2 +- docs/api.resque.html | 2 +- docs/api.routes.html | 2 +- docs/api.servers.html | 2 +- docs/api.specHelper.Connection.html | 2 +- docs/api.specHelper.html | 2 +- docs/api.staticFile.html | 2 +- docs/api.tasks.html | 2 +- docs/api.utils.html | 2 +- docs/classes_action.js.html | 2 +- docs/classes_cli.js.html | 2 +- docs/classes_connection.js.html | 2 +- docs/classes_initializer.js.html | 2 +- docs/classes_server.js.html | 2 +- docs/classes_task.js.html | 2 +- ...ient_ActionheroWebsocketClient.jsdoc.html} | 52 ++++++++--------- docs/index.html | 2 +- docs/index.js.html | 2 +- docs/initializers_actions.js.html | 2 +- docs/initializers_cache.js.html | 2 +- docs/initializers_chatRoom.js.html | 2 +- docs/initializers_config.js.html | 2 +- docs/initializers_connections.js.html | 2 +- docs/initializers_documentation.js.html | 2 +- docs/initializers_exceptions.js.html | 2 +- docs/initializers_i18n.js.html | 2 +- docs/initializers_id.js.html | 2 +- docs/initializers_logger.js.html | 2 +- docs/initializers_params.js.html | 2 +- docs/initializers_pids.js.html | 2 +- docs/initializers_redis.js.html | 2 +- docs/initializers_resque.js.html | 2 +- docs/initializers_routes.js.html | 2 +- docs/initializers_servers.js.html | 2 +- docs/initializers_specHelper.js.html | 2 +- docs/initializers_staticFile.js.html | 2 +- docs/initializers_tasks.js.html | 2 +- docs/initializers_utils.js.html | 2 +- docs/tutorial-actionhero-cluster.html | 2 +- docs/tutorial-actions.html | 2 +- docs/tutorial-chat.html | 2 +- docs/tutorial-cli.html | 2 +- docs/tutorial-config.html | 2 +- docs/tutorial-development-mode.html | 2 +- docs/tutorial-file-server.html | 2 +- docs/tutorial-initializers.html | 2 +- docs/tutorial-localization.html | 2 +- docs/tutorial-logging.html | 2 +- docs/tutorial-middleware.html | 2 +- docs/tutorial-plugins.html | 2 +- docs/tutorial-production-notes.html | 2 +- docs/tutorial-running-actionhero.html | 2 +- docs/tutorial-servers.html | 2 +- docs/tutorial-socket.html | 8 +-- docs/tutorial-tasks.html | 2 +- docs/tutorial-testing.html | 2 +- docs/tutorial-upgrade-path.html | 2 +- docs/tutorial-web.html | 8 +-- docs/tutorial-websocket.html | 12 ++-- jsdoc-conf.json | 2 +- public/chat.html | 4 +- public/index.html | 4 +- public/linkedSession.html | 6 +- public/websocketLoadTest.html | 4 +- servers/websocket.js | 10 ++-- test/integration/sharedFingerprint.js | 6 +- test/servers/websocket.js | 10 ++-- tutorials/socket.md | 6 +- tutorials/web.md | 6 +- tutorials/websocket.md | 10 ++-- 95 files changed, 225 insertions(+), 225 deletions(-) rename client/{actionheroClient.js => actionheroWebsocketClient.js} (79%) rename client/{actionheroClient.jsdoc => actionheroWebsocketClient.jsdoc} (83%) rename docs/{ActionHero.ActionHeroClient.html => ActionHero.ActionheroWebsocketClient.html} (78%) rename docs/{client_actionheroClient.jsdoc.html => client_ActionheroWebsocketClient.jsdoc.html} (66%) diff --git a/.gitignore b/.gitignore index 22c151e3a..cace0419d 100644 --- a/.gitignore +++ b/.gitignore @@ -7,8 +7,8 @@ cache/* coverage/* node_modules/* locales/test-env-* -public/javascript/actionheroClient.js -public/javascript/actionheroClient.min.js +public/javascript/ActionheroWebsocketClient.js +public/javascript/ActionheroWebsocketClient.min.js #JSDoc docs/out diff --git a/bin/templates/package.json b/bin/templates/package.json index 61ca9120f..8abb7ee54 100644 --- a/bin/templates/package.json +++ b/bin/templates/package.json @@ -27,7 +27,7 @@ }, "standard": { "ignore": [ - "public/javascript/actionheroClient.*" + "public/javascript/ActionheroWebsocketClient.*" ], "globals": [ "describe", diff --git a/client/actionheroClient.js b/client/actionheroWebsocketClient.js similarity index 79% rename from client/actionheroClient.js rename to client/actionheroWebsocketClient.js index ebf2519ed..64a482e90 100644 --- a/client/actionheroClient.js +++ b/client/actionheroWebsocketClient.js @@ -1,4 +1,4 @@ -var ActionheroClient = function (options, client) { +var ActionheroWebsocketClient = function (options, client) { var self = this self.callbacks = {} @@ -21,12 +21,12 @@ var ActionheroClient = function (options, client) { if (typeof Primus === 'undefined') { var util = require('util') var EventEmitter = require('events').EventEmitter - util.inherits(ActionheroClient, EventEmitter) + util.inherits(ActionheroWebsocketClient, EventEmitter) } else { - ActionheroClient.prototype = new Primus.EventEmitter() + ActionheroWebsocketClient.prototype = new Primus.EventEmitter() } -ActionheroClient.prototype.defaults = function () { +ActionheroWebsocketClient.prototype.defaults = function () { %%DEFAULTS%% } @@ -34,7 +34,7 @@ ActionheroClient.prototype.defaults = function () { // CONNECTION // // ////////////// -ActionheroClient.prototype.connect = function (callback) { +ActionheroWebsocketClient.prototype.connect = function (callback) { var self = this self.messageCount = 0 @@ -103,7 +103,7 @@ ActionheroClient.prototype.connect = function (callback) { }) } -ActionheroClient.prototype.configure = function (callback) { +ActionheroWebsocketClient.prototype.configure = function (callback) { var self = this self.rooms.forEach(function (room) { @@ -122,7 +122,7 @@ ActionheroClient.prototype.configure = function (callback) { // MESSAGING // // ///////////// -ActionheroClient.prototype.send = function (args, callback) { +ActionheroWebsocketClient.prototype.send = function (args, callback) { // primus will buffer messages when not connected var self = this self.messageCount++ @@ -132,7 +132,7 @@ ActionheroClient.prototype.send = function (args, callback) { self.client.write(args) } -ActionheroClient.prototype.handleMessage = function (message) { +ActionheroWebsocketClient.prototype.handleMessage = function (message) { var self = this self.emit('message', message) if (message.context === 'response') { @@ -156,7 +156,7 @@ ActionheroClient.prototype.handleMessage = function (message) { // ACTIONS // // /////////// -ActionheroClient.prototype.action = function (action, params, callback) { +ActionheroWebsocketClient.prototype.action = function (action, params, callback) { if (!callback && typeof params === 'function') { callback = params params = null @@ -171,7 +171,7 @@ ActionheroClient.prototype.action = function (action, params, callback) { } } -ActionheroClient.prototype.actionWeb = function (params, callback) { +ActionheroWebsocketClient.prototype.actionWeb = function (params, callback) { var xmlhttp = new XMLHttpRequest() xmlhttp.onreadystatechange = function () { var response @@ -204,7 +204,7 @@ ActionheroClient.prototype.actionWeb = function (params, callback) { xmlhttp.send(JSON.stringify(params)) } -ActionheroClient.prototype.actionWebSocket = function (params, callback) { +ActionheroWebsocketClient.prototype.actionWebSocket = function (params, callback) { this.send({event: 'action', params: params}, callback) } @@ -212,23 +212,23 @@ ActionheroClient.prototype.actionWebSocket = function (params, callback) { // COMMANDS // // //////////// -ActionheroClient.prototype.say = function (room, message, callback) { +ActionheroWebsocketClient.prototype.say = function (room, message, callback) { this.send({event: 'say', room: room, message: message}, callback) } -ActionheroClient.prototype.file = function (file, callback) { +ActionheroWebsocketClient.prototype.file = function (file, callback) { this.send({event: 'file', file: file}, callback) } -ActionheroClient.prototype.detailsView = function (callback) { +ActionheroWebsocketClient.prototype.detailsView = function (callback) { this.send({event: 'detailsView'}, callback) } -ActionheroClient.prototype.roomView = function (room, callback) { +ActionheroWebsocketClient.prototype.roomView = function (room, callback) { this.send({event: 'roomView', room: room}, callback) } -ActionheroClient.prototype.roomAdd = function (room, callback) { +ActionheroWebsocketClient.prototype.roomAdd = function (room, callback) { var self = this self.send({event: 'roomAdd', room: room}, function (data) { self.configure(function () { @@ -237,7 +237,7 @@ ActionheroClient.prototype.roomAdd = function (room, callback) { }) } -ActionheroClient.prototype.roomLeave = function (room, callback) { +ActionheroWebsocketClient.prototype.roomLeave = function (room, callback) { var self = this var index = self.rooms.indexOf(room) if (index > -1) { self.rooms.splice(index, 1) } @@ -248,16 +248,16 @@ ActionheroClient.prototype.roomLeave = function (room, callback) { }) } -ActionheroClient.prototype.documentation = function (callback) { +ActionheroWebsocketClient.prototype.documentation = function (callback) { this.send({event: 'documentation'}, callback) } -ActionheroClient.prototype.disconnect = function () { +ActionheroWebsocketClient.prototype.disconnect = function () { this.state = 'disconnected' this.client.end() this.emit('disconnected') } // depricated lowercase name -var actionheroClient = ActionheroClient; -actionheroClient; +var ActionheroWebsocketClient = ActionheroWebsocketClient; +ActionheroWebsocketClient; diff --git a/client/actionheroClient.jsdoc b/client/actionheroWebsocketClient.jsdoc similarity index 83% rename from client/actionheroClient.jsdoc rename to client/actionheroWebsocketClient.jsdoc index 1a79e1456..81b93f89d 100644 --- a/client/actionheroClient.jsdoc +++ b/client/actionheroWebsocketClient.jsdoc @@ -5,13 +5,13 @@ * Note that this class is not written using ES6 convestions so that it will function properly in the browser. * Defaults will be built from the options you set in `api.config.servers.websocket` * - * @class ActionHero.ActionHeroClient + * @class ActionHero.ActionheroWebsocketClient * * @tutorial websocket * @example -// +// -var client = new ActionheroClient(); +var client = new ActionheroWebsocketClient(); client.on('connected', function(){ console.log('connected!') }) client.on('disconnected', function(){ console.log('disconnected :(') }) @@ -34,25 +34,25 @@ client.connect(function(error, details){ /** * @function connect - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback When the connection is connected, will reurn (`error`, `details`), where details is the same as calling `client.detailsView()`. * @description Connect to the ActionHero server. Will emit `welcome` when connected, and return the callback. Will aslo set `this.state`, `this.rooms`, `this.fingerprint`, and `this.id`. Clients will automatically try to reconect, unless prevented with `client.disconnect()` - * @see ActionHero.ActionHeroClient.detailsView - * @see ActionHero.ActionHeroClient.disconnect + * @see ActionHero.ActionheroWebsocketClient.detailsView + * @see ActionHero.ActionheroWebsocketClient.disconnect */ /** * @function configure - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`error`, `details`), where details is the same as calling `client.detailsView()`. * @description Will set `this.state`, `this.rooms`, `this.fingerprint`, and `this.id`. You should only need this method if you are having connection errors. - * @see ActionHero.ActionHeroClient.detailsView + * @see ActionHero.ActionheroWebsocketClient.detailsView */ /** * @function action - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} action The name of the action to run. * @param {Object} params (optional) (default: {}). Any params to pass to the action. * @param {Function} callback Will reurn (`data`) (no error!). The client will emit `error` if there is a connection error, otherwise any errors from the action will be contained within `data.error`. @@ -73,17 +73,17 @@ client.action('cacheTest', {key: 'key', value: 'value'}, function (data) { /** * @function say - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to chat in. Client must be a member of room already via `client.roomAdd()` * @param {Object|string} message The message to send. Can be a string, Object, or Array. * @param {Function} callback Will reurn (`data`), where `data.OK` will exist. * @description Say a message to a chatRoom the connection is a member of. - * @see ActionHero.ActionHeroClient.roomAdd + * @see ActionHero.ActionheroWebsocketClient.roomAdd */ /** * @function file - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} file The file requeted. The file should look like a the path from a browser, ie: `/public/name/of/file.jpg` * @param {Function} callback Will reurn (`data`), where the file's contents and medadata will be included. Likley a large payload. * @description Request a public file from the server. @@ -102,50 +102,50 @@ client.file('/public/simple.html', function(data) { /** * @function detailsView - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`data`), where data contains the connections details (fingerprint, connection time, etc) * @description View the server's details about this connection. */ /** * @function documentation - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`data`), where data conatins the results of `api.documentation.documentation`, details of all documented actions on the server. * @description View details of this server's actions. */ /** * @function disconnect - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback * @description Close the client connection. Will prevent any re-connects from attempting. - * @see ActionHero.ActionHeroClient.connect + * @see ActionHero.ActionheroWebsocketClient.connect */ /** * @function roomView - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to inspect. Client must be a member of room already via `client.roomAdd()` * @param {Function} callback Will reurn (`data`), where data contains a list of other members in the room. * @description View the other members of a room. - * @see ActionHero.ActionHeroClient.roomAdd - * @see ActionHero.ActionHeroClient.roomLeave + * @see ActionHero.ActionheroWebsocketClient.roomAdd + * @see ActionHero.ActionheroWebsocketClient.roomLeave */ /** * @function roomAdd - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to join. * @param {Function} callback Will reurn (`data`), where data contains errors and success. * @description Join an existing chat room. You may not be able to join this room (based on connection properties or other configuration on the server, so check for `data.error`). Once in the room, you will recive all say messages from the room as events. - * @see ActionHero.ActionHeroClient.roomLeave + * @see ActionHero.ActionheroWebsocketClient.roomLeave */ /** * @function roomLeave - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to leave. * @param {Function} callback Will reurn (`data`), where data contains errors and success. * @description LEave a chat room you are already a member of. You may not be able to leave this room (based on connection properties or other configuration on the server, so check for `data.error`) - * @see ActionHero.ActionHeroClient.roomAddd + * @see ActionHero.ActionheroWebsocketClient.roomAddd */ diff --git a/config/servers/websocket.js b/config/servers/websocket.js index 118c79b46..f72c09756 100644 --- a/config/servers/websocket.js +++ b/config/servers/websocket.js @@ -15,7 +15,7 @@ exports['default'] = { // the name of the client-side JS file to render. Both `.js` and `.min.js` versions will be created // do not include the file exension // set to `undefined` to not render the client-side JS on boot - clientJsName: 'actionheroClient', + clientJsName: 'ActionheroWebsocketClient', // should the server signal clients to not reconnect when the server is shutdown/reboot destroyClientsOnShutdown: false, diff --git a/docs/ActionHero.Action.html b/docs/ActionHero.Action.html index 7dc9b5acf..dbf228919 100644 --- a/docs/ActionHero.Action.html +++ b/docs/ActionHero.Action.html @@ -28,7 +28,7 @@ -

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.ActionHeroClient.html b/docs/ActionHero.ActionheroWebsocketClient.html similarity index 78% rename from docs/ActionHero.ActionHeroClient.html rename to docs/ActionHero.ActionheroWebsocketClient.html index 0e03145a1..ad9f4542a 100644 --- a/docs/ActionHero.ActionHeroClient.html +++ b/docs/ActionHero.ActionheroWebsocketClient.html @@ -2,7 +2,7 @@ - ActionHeroClient - Documentation + ActionheroWebsocketClient - Documentation @@ -28,12 +28,12 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

-

ActionHeroClient

+

ActionheroWebsocketClient

@@ -48,7 +48,7 @@

ActionHeroClient

ActionHero. - ActionHeroClient + ActionheroWebsocketClient

@@ -61,7 +61,7 @@

-

new ActionHeroClient()

+

new ActionheroWebsocketClient()

@@ -73,7 +73,7 @@

new A
Source:
@@ -137,9 +137,9 @@

new A

Example
- 
// <script type="text/javascript" src="/public/javascript/actionheroClient.min.js"></script>
+    
// <script type="text/javascript" src="/public/javascript/ActionheroWebsocketClient.min.js"></script>
 
-var client = new ActionheroClient();
+var client = new ActionheroWebsocketClient();
 
 client.on('connected',    function(){ console.log('connected!') })
 client.on('disconnected', function(){ console.log('disconnected :(') })
@@ -210,7 +210,7 @@ 
(static) actio
     
     
Source:

     

     
 
@@ -404,7 +404,7 @@ 
(static) co
     
     
Source:

     

     
 
@@ -438,7 +438,7 @@ 
(static) co
     
See:

     

         
     

     
@@ -544,7 +544,7 @@ 
(static) conn
     
     
Source:

     

     
 
@@ -578,9 +578,9 @@ 
(static) conn
     
See:

     

         
     

     
@@ -686,7 +686,7 @@ 
(static) 
     
     
Source:

     

     
 
@@ -819,7 +819,7 @@ 
(static) d
     
     
Source:

     

     
 
@@ -853,7 +853,7 @@ 
(static) d
     
See:

     

         
     

     
@@ -959,7 +959,7 @@ 
(static) Source:
     

     
 
@@ -1092,7 +1092,7 @@ 
(static) fileSource:
     

     
 
@@ -1262,7 +1262,7 @@ 
(static) room
     
     
Source:

     

     
 
@@ -1296,7 +1296,7 @@ 
(static) room
     
See:

     

         
     

     
@@ -1425,7 +1425,7 @@ 
(static) ro
     
     
Source:

     

     
 
@@ -1459,7 +1459,7 @@ 
(static) ro
     
See:

     

         
    
-            
  • ActionHero.ActionHeroClient.roomAddd
    • 
+            
  • ActionHero.ActionheroWebsocketClient.roomAddd
    • 
         

     

     
@@ -1588,7 +1588,7 @@ 
(static) roo
     
     
Source:

     

     
 
@@ -1622,9 +1622,9 @@ 
(static) roo
     
See:

     

         
     

     
@@ -1753,7 +1753,7 @@ 
(static) saySource:
     

     
 
@@ -1787,7 +1787,7 @@ 
(static) saySee:
     

         
     

     
diff --git a/docs/ActionHero.CLI.html b/docs/ActionHero.CLI.html
index 53a3f42e5..c5a4075eb 100644
--- a/docs/ActionHero.CLI.html
+++ b/docs/ActionHero.CLI.html
@@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.Connection.html b/docs/ActionHero.Connection.html index fd17a49c2..b7d665729 100644 --- a/docs/ActionHero.Connection.html +++ b/docs/ActionHero.Connection.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.Initializer.html b/docs/ActionHero.Initializer.html index 8e0b481b9..1fbb690ec 100644 --- a/docs/ActionHero.Initializer.html +++ b/docs/ActionHero.Initializer.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.Server.html b/docs/ActionHero.Server.html index c3986b468..50aade2d1 100644 --- a/docs/ActionHero.Server.html +++ b/docs/ActionHero.Server.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.Task.html b/docs/ActionHero.Task.html index f812b4e1a..20620df78 100644 --- a/docs/ActionHero.Task.html +++ b/docs/ActionHero.Task.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/ActionHero.html b/docs/ActionHero.html index f92f9a148..2ad2d2689 100644 --- a/docs/ActionHero.html +++ b/docs/ActionHero.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

@@ -152,7 +152,7 @@

Classes

Action
-
ActionHeroClient
+
ActionheroWebsocketClient
CLI
diff --git a/docs/api.actions.html b/docs/api.actions.html index f1d5ac876..e0ea84247 100644 --- a/docs/api.actions.html +++ b/docs/api.actions.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.cache.html b/docs/api.cache.html index cc33aae06..f198e9900 100644 --- a/docs/api.cache.html +++ b/docs/api.cache.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.chatRoom.html b/docs/api.chatRoom.html index a5151e72b..d9737c4d2 100644 --- a/docs/api.chatRoom.html +++ b/docs/api.chatRoom.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.config.html b/docs/api.config.html index bb919b809..a317bf3ab 100644 --- a/docs/api.config.html +++ b/docs/api.config.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.connections.html b/docs/api.connections.html index 7ddd63d7c..02238ef2e 100644 --- a/docs/api.connections.html +++ b/docs/api.connections.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.documentation.html b/docs/api.documentation.html index a959d627c..bcf7cf9ef 100644 --- a/docs/api.documentation.html +++ b/docs/api.documentation.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.exceptions.html b/docs/api.exceptions.html index 089c7f273..ccd24514a 100644 --- a/docs/api.exceptions.html +++ b/docs/api.exceptions.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.html b/docs/api.html index 7df76b625..403ec0819 100644 --- a/docs/api.html +++ b/docs/api.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.i18n.html b/docs/api.i18n.html index d242059cb..e8a3d9c00 100644 --- a/docs/api.i18n.html +++ b/docs/api.i18n.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.id.html b/docs/api.id.html index 1cf7f316b..0f9cfa891 100644 --- a/docs/api.id.html +++ b/docs/api.id.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.params.html b/docs/api.params.html index b37ef7b63..c1f8e3771 100644 --- a/docs/api.params.html +++ b/docs/api.params.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.pids.html b/docs/api.pids.html index 3c69836ef..ab127ebad 100644 --- a/docs/api.pids.html +++ b/docs/api.pids.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.redis.html b/docs/api.redis.html index aa5f51e57..78620288f 100644 --- a/docs/api.redis.html +++ b/docs/api.redis.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.resque.html b/docs/api.resque.html index afa3f4275..9e50c18c3 100644 --- a/docs/api.resque.html +++ b/docs/api.resque.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.routes.html b/docs/api.routes.html index 8401a75d1..d9fa57e56 100644 --- a/docs/api.routes.html +++ b/docs/api.routes.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.servers.html b/docs/api.servers.html index d431ca0d8..b5e849013 100644 --- a/docs/api.servers.html +++ b/docs/api.servers.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.specHelper.Connection.html b/docs/api.specHelper.Connection.html index 6b4dd5566..e4138bbf3 100644 --- a/docs/api.specHelper.Connection.html +++ b/docs/api.specHelper.Connection.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.specHelper.html b/docs/api.specHelper.html index 519b2f6a6..44c1926cb 100644 --- a/docs/api.specHelper.html +++ b/docs/api.specHelper.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.staticFile.html b/docs/api.staticFile.html index 0e5695cc1..aa31a48b5 100644 --- a/docs/api.staticFile.html +++ b/docs/api.staticFile.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.tasks.html b/docs/api.tasks.html index e72a276d5..79fdf4e2e 100644 --- a/docs/api.tasks.html +++ b/docs/api.tasks.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/api.utils.html b/docs/api.utils.html index a67e8a2ce..91b097eb7 100644 --- a/docs/api.utils.html +++ b/docs/api.utils.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_action.js.html b/docs/classes_action.js.html index 2d4b7aa1c..cb5a1b62a 100644 --- a/docs/classes_action.js.html +++ b/docs/classes_action.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_cli.js.html b/docs/classes_cli.js.html index bafd794c9..c6ce771c2 100644 --- a/docs/classes_cli.js.html +++ b/docs/classes_cli.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_connection.js.html b/docs/classes_connection.js.html index 731a4c08e..7a3b4fe31 100644 --- a/docs/classes_connection.js.html +++ b/docs/classes_connection.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_initializer.js.html b/docs/classes_initializer.js.html index 0244b3dbb..e41fc93e3 100644 --- a/docs/classes_initializer.js.html +++ b/docs/classes_initializer.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_server.js.html b/docs/classes_server.js.html index d29924599..0e4b5acbe 100644 --- a/docs/classes_server.js.html +++ b/docs/classes_server.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/classes_task.js.html b/docs/classes_task.js.html index 82e2daf16..9f139d7b1 100644 --- a/docs/classes_task.js.html +++ b/docs/classes_task.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/client_actionheroClient.jsdoc.html b/docs/client_ActionheroWebsocketClient.jsdoc.html similarity index 66% rename from docs/client_actionheroClient.jsdoc.html rename to docs/client_ActionheroWebsocketClient.jsdoc.html index ffdca29e0..24f4bb53a 100644 --- a/docs/client_actionheroClient.jsdoc.html +++ b/docs/client_ActionheroWebsocketClient.jsdoc.html @@ -2,7 +2,7 @@ - client/actionheroClient.jsdoc - Documentation + client/ActionheroWebsocketClient.jsdoc - Documentation @@ -28,12 +28,12 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

-

client/actionheroClient.jsdoc

+

client/ActionheroWebsocketClient.jsdoc

@@ -50,13 +50,13 @@

client/actionheroClient.jsdoc

* Note that this class is not written using ES6 convestions so that it will function properly in the browser. * Defaults will be built from the options you set in `api.config.servers.websocket` * - * @class ActionHero.ActionHeroClient + * @class ActionHero.ActionheroWebsocketClient * * @tutorial websocket * @example -// <script type="text/javascript" src="/public/javascript/actionheroClient.min.js"></script> +// <script type="text/javascript" src="/public/javascript/ActionheroWebsocketClient.min.js"></script> -var client = new ActionheroClient(); +var client = new ActionheroWebsocketClient(); client.on('connected', function(){ console.log('connected!') }) client.on('disconnected', function(){ console.log('disconnected :(') }) @@ -79,25 +79,25 @@

client/actionheroClient.jsdoc

/** * @function connect - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback When the connection is connected, will reurn (`error`, `details`), where details is the same as calling `client.detailsView()`. * @description Connect to the ActionHero server. Will emit `welcome` when connected, and return the callback. Will aslo set `this.state`, `this.rooms`, `this.fingerprint`, and `this.id`. Clients will automatically try to reconect, unless prevented with `client.disconnect()` - * @see ActionHero.ActionHeroClient.detailsView - * @see ActionHero.ActionHeroClient.disconnect + * @see ActionHero.ActionheroWebsocketClient.detailsView + * @see ActionHero.ActionheroWebsocketClient.disconnect */ /** * @function configure - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`error`, `details`), where details is the same as calling `client.detailsView()`. * @description Will set `this.state`, `this.rooms`, `this.fingerprint`, and `this.id`. You should only need this method if you are having connection errors. - * @see ActionHero.ActionHeroClient.detailsView + * @see ActionHero.ActionheroWebsocketClient.detailsView */ /** * @function action - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} action The name of the action to run. * @param {Object} params (optional) (default: {}). Any params to pass to the action. * @param {Function} callback Will reurn (`data`) (no error!). The client will emit `error` if there is a connection error, otherwise any errors from the action will be contained within `data.error`. @@ -118,17 +118,17 @@

client/actionheroClient.jsdoc

/** * @function say - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to chat in. Client must be a member of room already via `client.roomAdd()` * @param {Object|string} message The message to send. Can be a string, Object, or Array. * @param {Function} callback Will reurn (`data`), where `data.OK` will exist. * @description Say a message to a chatRoom the connection is a member of. - * @see ActionHero.ActionHeroClient.roomAdd + * @see ActionHero.ActionheroWebsocketClient.roomAdd */ /** * @function file - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} file The file requeted. The file should look like a the path from a browser, ie: `/public/name/of/file.jpg` * @param {Function} callback Will reurn (`data`), where the file's contents and medadata will be included. Likley a large payload. * @description Request a public file from the server. @@ -147,52 +147,52 @@

client/actionheroClient.jsdoc

/** * @function detailsView - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`data`), where data contains the connections details (fingerprint, connection time, etc) * @description View the server's details about this connection. */ /** * @function documentation - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback Will reurn (`data`), where data conatins the results of `api.documentation.documentation`, details of all documented actions on the server. * @description View details of this server's actions. */ /** * @function disconnect - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {Function} callback * @description Close the client connection. Will prevent any re-connects from attempting. - * @see ActionHero.ActionHeroClient.connect + * @see ActionHero.ActionheroWebsocketClient.connect */ /** * @function roomView - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to inspect. Client must be a member of room already via `client.roomAdd()` * @param {Function} callback Will reurn (`data`), where data contains a list of other members in the room. * @description View the other members of a room. - * @see ActionHero.ActionHeroClient.roomAdd - * @see ActionHero.ActionHeroClient.roomLeave + * @see ActionHero.ActionheroWebsocketClient.roomAdd + * @see ActionHero.ActionheroWebsocketClient.roomLeave */ /** * @function roomAdd - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to join. * @param {Function} callback Will reurn (`data`), where data contains errors and success. * @description Join an existing chat room. You may not be able to join this room (based on connection properties or other configuration on the server, so check for `data.error`). Once in the room, you will recive all say messages from the room as events. - * @see ActionHero.ActionHeroClient.roomLeave + * @see ActionHero.ActionheroWebsocketClient.roomLeave */ /** * @function roomLeave - * @memberof ActionHero.ActionHeroClient + * @memberof ActionHero.ActionheroWebsocketClient * @param {string} room The room to leave. * @param {Function} callback Will reurn (`data`), where data contains errors and success. * @description LEave a chat room you are already a member of. You may not be able to leave this room (based on connection properties or other configuration on the server, so check for `data.error`) - * @see ActionHero.ActionHeroClient.roomAddd + * @see ActionHero.ActionheroWebsocketClient.roomAddd */ diff --git a/docs/index.html b/docs/index.html index ee9165433..e4b83367b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/index.js.html b/docs/index.js.html index 0fe5ab538..17dfad6e3 100644 --- a/docs/index.js.html +++ b/docs/index.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_actions.js.html b/docs/initializers_actions.js.html index 992270236..1b8bef231 100644 --- a/docs/initializers_actions.js.html +++ b/docs/initializers_actions.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_cache.js.html b/docs/initializers_cache.js.html index a14397664..f10cd10e3 100644 --- a/docs/initializers_cache.js.html +++ b/docs/initializers_cache.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_chatRoom.js.html b/docs/initializers_chatRoom.js.html index e7308e6b9..bd8865f87 100644 --- a/docs/initializers_chatRoom.js.html +++ b/docs/initializers_chatRoom.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_config.js.html b/docs/initializers_config.js.html index 66e74eda1..48ccf42cf 100644 --- a/docs/initializers_config.js.html +++ b/docs/initializers_config.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_connections.js.html b/docs/initializers_connections.js.html index 51bf22a87..d67e4cf21 100644 --- a/docs/initializers_connections.js.html +++ b/docs/initializers_connections.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_documentation.js.html b/docs/initializers_documentation.js.html index 9f9eb7654..3bfe58d8f 100644 --- a/docs/initializers_documentation.js.html +++ b/docs/initializers_documentation.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_exceptions.js.html b/docs/initializers_exceptions.js.html index b6f9c8d4d..4c9c34a0f 100644 --- a/docs/initializers_exceptions.js.html +++ b/docs/initializers_exceptions.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_i18n.js.html b/docs/initializers_i18n.js.html index 7120a57c6..d941dc0c1 100644 --- a/docs/initializers_i18n.js.html +++ b/docs/initializers_i18n.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_id.js.html b/docs/initializers_id.js.html index 3b6a141d4..8bc5ebd29 100644 --- a/docs/initializers_id.js.html +++ b/docs/initializers_id.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_logger.js.html b/docs/initializers_logger.js.html index 30a70b8fc..aec6e12f1 100644 --- a/docs/initializers_logger.js.html +++ b/docs/initializers_logger.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_params.js.html b/docs/initializers_params.js.html index 4c83ac7fb..1db99fdaf 100644 --- a/docs/initializers_params.js.html +++ b/docs/initializers_params.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_pids.js.html b/docs/initializers_pids.js.html index 29f5dc3c3..1a3b4bb24 100644 --- a/docs/initializers_pids.js.html +++ b/docs/initializers_pids.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_redis.js.html b/docs/initializers_redis.js.html index f70ed62ba..5e23c86be 100644 --- a/docs/initializers_redis.js.html +++ b/docs/initializers_redis.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_resque.js.html b/docs/initializers_resque.js.html index 5244cdaba..7a76781fb 100644 --- a/docs/initializers_resque.js.html +++ b/docs/initializers_resque.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_routes.js.html b/docs/initializers_routes.js.html index 528a0e365..e41fb5153 100644 --- a/docs/initializers_routes.js.html +++ b/docs/initializers_routes.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_servers.js.html b/docs/initializers_servers.js.html index 6eedeea63..1faa69d04 100644 --- a/docs/initializers_servers.js.html +++ b/docs/initializers_servers.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_specHelper.js.html b/docs/initializers_specHelper.js.html index a0bbcbe35..b40a08033 100644 --- a/docs/initializers_specHelper.js.html +++ b/docs/initializers_specHelper.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_staticFile.js.html b/docs/initializers_staticFile.js.html index 2b3de875b..9d26e2b9e 100644 --- a/docs/initializers_staticFile.js.html +++ b/docs/initializers_staticFile.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_tasks.js.html b/docs/initializers_tasks.js.html index 65e5c05c9..c9f48f0ab 100644 --- a/docs/initializers_tasks.js.html +++ b/docs/initializers_tasks.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/initializers_utils.js.html b/docs/initializers_utils.js.html index 5e55111c8..57d8ad74d 100644 --- a/docs/initializers_utils.js.html +++ b/docs/initializers_utils.js.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-actionhero-cluster.html b/docs/tutorial-actionhero-cluster.html index b560198cd..697d4c854 100644 --- a/docs/tutorial-actionhero-cluster.html +++ b/docs/tutorial-actionhero-cluster.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-actions.html b/docs/tutorial-actions.html index 70e1a1637..c0a33b1f4 100644 --- a/docs/tutorial-actions.html +++ b/docs/tutorial-actions.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-chat.html b/docs/tutorial-chat.html index bdadd3ca9..8e61e95b3 100644 --- a/docs/tutorial-chat.html +++ b/docs/tutorial-chat.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-cli.html b/docs/tutorial-cli.html index 2e86b9489..878b95831 100644 --- a/docs/tutorial-cli.html +++ b/docs/tutorial-cli.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-config.html b/docs/tutorial-config.html index 85a95c4ae..850241521 100644 --- a/docs/tutorial-config.html +++ b/docs/tutorial-config.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-development-mode.html b/docs/tutorial-development-mode.html index d89701457..49776effe 100644 --- a/docs/tutorial-development-mode.html +++ b/docs/tutorial-development-mode.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-file-server.html b/docs/tutorial-file-server.html index d58000c43..4042345d1 100644 --- a/docs/tutorial-file-server.html +++ b/docs/tutorial-file-server.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-initializers.html b/docs/tutorial-initializers.html index 6b4b4292e..f83b8a005 100644 --- a/docs/tutorial-initializers.html +++ b/docs/tutorial-initializers.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-localization.html b/docs/tutorial-localization.html index 899c5cad6..b73bc53c7 100644 --- a/docs/tutorial-localization.html +++ b/docs/tutorial-localization.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-logging.html b/docs/tutorial-logging.html index 39aacb9f8..6ef311986 100644 --- a/docs/tutorial-logging.html +++ b/docs/tutorial-logging.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-middleware.html b/docs/tutorial-middleware.html index 984dc1ef6..604cee553 100644 --- a/docs/tutorial-middleware.html +++ b/docs/tutorial-middleware.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-plugins.html b/docs/tutorial-plugins.html index 427a6f08a..eed8afde4 100644 --- a/docs/tutorial-plugins.html +++ b/docs/tutorial-plugins.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-production-notes.html b/docs/tutorial-production-notes.html index 4a11db456..f71392259 100644 --- a/docs/tutorial-production-notes.html +++ b/docs/tutorial-production-notes.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-running-actionhero.html b/docs/tutorial-running-actionhero.html index 1124ab324..a7daf223a 100644 --- a/docs/tutorial-running-actionhero.html +++ b/docs/tutorial-running-actionhero.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-servers.html b/docs/tutorial-servers.html index ee89e76fe..f3f1fade1 100644 --- a/docs/tutorial-servers.html +++ b/docs/tutorial-servers.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-socket.html b/docs/tutorial-socket.html index 84bfff474..d9505d4f9 100644 --- a/docs/tutorial-socket.html +++ b/docs/tutorial-socket.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

@@ -145,8 +145,8 @@

JSON Parameters

The default method of using actions for TCP clients i

  • {{"action": "myAction", "params": {"key": "value"}}} is also a valid request over TCP
-

Client Suggestions

var actionheroClient = require("actionhero-client");
-var client = new actionheroClient();
+
Client Suggestions
var ActionheroWebsocketClient = require("actionhero-client");
+var client = new ActionheroWebsocketClient();
 
 client.on("say", function(msgBlock){
   console.log(" > SAY: " + msgBlock.message + " | from: " + msgBlock.from);
@@ -185,7 +185,7 @@ 
Client Suggestions
var act
 
   // join a chat room and talk
   client.roomAdd("defaultRoom", function(error){
-    client.say("defaultRoom", "Hello from the actionheroClient");
+    client.say("defaultRoom", "Hello from the ActionheroWebsocketClient");
     client.roomLeave("defaultRoom");
   });
 
diff --git a/docs/tutorial-tasks.html b/docs/tutorial-tasks.html
index ceaf18ae0..808c0c8b2 100644
--- a/docs/tutorial-tasks.html
+++ b/docs/tutorial-tasks.html
@@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-testing.html b/docs/tutorial-testing.html index 85b1a512d..cb198cdac 100644 --- a/docs/tutorial-testing.html +++ b/docs/tutorial-testing.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-upgrade-path.html b/docs/tutorial-upgrade-path.html index 0417a6c71..eea7e42f2 100644 --- a/docs/tutorial-upgrade-path.html +++ b/docs/tutorial-upgrade-path.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

diff --git a/docs/tutorial-web.html b/docs/tutorial-web.html index 4c4d9c605..a1c13b0b8 100644 --- a/docs/tutorial-web.html +++ b/docs/tutorial-web.html @@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

@@ -461,11 +461,11 @@

Parameters

Params provided by the user (GET, POST, etc for http and h { ... }, key1: '123', key2: '456', - }

Client Library

Although the actionheroClient client-side library is mostly for websockets, it can now be used to make http actions when not connected (and websocket clients will fall back to http actions when disconnected)

-
<script src="/public/javascript/actionheroClient.js"></script>
+ }

Client Library

Although the ActionheroWebsocketClient client-side library is mostly for websockets, it can now be used to make http actions when not connected (and websocket clients will fall back to http actions when disconnected)

+
<script src="/public/javascript/ActionheroWebsocketClient.js"></script>
 
 <script>
-  var client = new ActionheroClient();
+  var client = new ActionheroWebsocketClient();
   client.action('cacheTest', {key: 'k', value: 'v'}, function(error, data){
      // do stuff
   });
diff --git a/docs/tutorial-websocket.html b/docs/tutorial-websocket.html
index 2301e6a56..61a701ce5 100644
--- a/docs/tutorial-websocket.html
+++ b/docs/tutorial-websocket.html
@@ -28,7 +28,7 @@
-

Classes

Namespaces

Tutorials

+

Classes

Namespaces

Tutorials

@@ -44,13 +44,13 @@

Tutorial: websocket

Overview

ActionHero uses Primus for web socket connections. The Primus project allows you to choose from many websocket backends, including ws, engine.io, socket.io, and more. Within ActionHero, web sockets are bound to the web server (either http or https).

-

ActionHero will generate the client-side javascript needed for you (based on the actionheroClient library, primus, and the underlying ws transport). This file is regenerated each time you boot the application.

+

ActionHero will generate the client-side javascript needed for you (based on the ActionheroWebsocketClient library, primus, and the underlying ws transport). This file is regenerated each time you boot the application.

Connection Details

// In the Browser...
-<script src="/public/javascript/actionheroClient.js"></script>
+<script src="/public/javascript/ActionheroWebsocketClient.js"></script>
 
 <script>
 
-  client = new ActionheroClient;
+  client = new ActionheroWebsocketClient;
 
   client.on('connected',    function(){ console.log('connected!') })
   client.on('disconnected', function(){ console.log('disconnected :(') })
@@ -84,7 +84,7 @@ 
Connection Details
// In
 
An example web socket session might be the following:

 
You can also inspect client.state (‘connected', ‘disconnected', etc). The websocket client will attempt to re-connect automatically.

 
If you want to communicate with a websocket client outside of an action, you can call connection.send(message) on the server. In the client lib, the event message will be fired. So, {client.on('message, function(m){ ... })}. Be sure to add some descriptive content to the message you send from the sever (like perhaps {{"type": 'message type'}}) so you can route message types on the client.

-
Client Methods
The clent API can be viewed here: WebSocket Client API

+
Client Methods
The clent API can be viewed here: WebSocket Client API

 
Linking WebSockets to Web Clients
ActionHero provides connection.fingerprint where available to help you link websocket connections to related web connections. While every connection will always have a unique connection.id, we attempt to build connection.fingerprint by checking the headers the websocket connection began with. If the cookie defined by api.config.servers.web.fingerprint.cookieKey is present, we will store its value on the websocket connection.

 
You can read more about using a value like connection.fingerprint in an authentication middleware or using it as a key for session information.

 
Config Options
exports['default'] = {
@@ -100,7 +100,7 @@ 
Config Options
exports['de
         // the name of the client-side JS file to render.  Both \`.js\` and \`.min.js\` versions will be created
         // do not include the file exension
         // set to \`undefined\` to not render the client-side JS on boot
-        clientJsName: 'actionheroClient',
+        clientJsName: 'ActionheroWebsocketClient',
         // should the server signal clients to not reconnect when the server is shutdown/reboot
         destroyClientsOnShutdown: false,
 
diff --git a/jsdoc-conf.json b/jsdoc-conf.json
index 1f332c020..7084c243c 100644
--- a/jsdoc-conf.json
+++ b/jsdoc-conf.json
@@ -4,7 +4,7 @@
       "index.js",
       "initializers",
       "classes",
-      "client/actionheroClient.jsdoc",
+      "client/ActionheroWebsocketClient.jsdoc",
       "bin",
       "config"
     ],
diff --git a/public/chat.html b/public/chat.html
index 4a96096e1..2764f6cde 100644
--- a/public/chat.html
+++ b/public/chat.html
@@ -7,13 +7,13 @@
     
     actionhero.js
 
-    
+    
 
     
+    
   
 
   
@@ -111,7 +111,7 @@ 
Actions on This Server:

         }
       }
 
-      var client = new ActionheroClient();
+      var client = new ActionheroWebsocketClient();
       client.action('showDocumentation', function(data){
         if(data.error){ window.alert(data.error); }
         populateDocumentation(data)
diff --git a/public/linkedSession.html b/public/linkedSession.html
index 0fdb9e359..aed0e3e8a 100644
--- a/public/linkedSession.html
+++ b/public/linkedSession.html
@@ -1,6 +1,6 @@
 
   
-    
+    
     
+