Document messager methods

This commit is contained in:
David Cormier 2013-10-27 12:26:16 -04:00
parent 75e8c87f09
commit 51abcc6953

View file

@ -196,7 +196,11 @@ weechat.factory('connection', ['$q', '$rootScope', '$log', '$store', 'handlers',
var callbacks = {} var callbacks = {}
var currentCallBackId = 0; var currentCallBackId = 0;
var createCallback = function(message) { /*
* Create a callback, adds it to the callback list
* and return it.
*/
var createCallback = function() {
var defer = $q.defer(); var defer = $q.defer();
callbacks[++currentCallBackId] = { callbacks[++currentCallBackId] = {
time: new Date, time: new Date,
@ -209,6 +213,7 @@ weechat.factory('connection', ['$q', '$rootScope', '$log', '$store', 'handlers',
/* /*
* Fails every currently subscribed callback for the * Fails every currently subscribed callback for the
* given reason * given reason
*
* @param reason reason for failure * @param reason reason for failure
*/ */
failCallbacks = function(reason) { failCallbacks = function(reason) {
@ -218,6 +223,12 @@ weechat.factory('connection', ['$q', '$rootScope', '$log', '$store', 'handlers',
} }
/* Send a message to the websocket and returns a promise.
* See: http://docs.angularjs.org/api/ng.$q
*
* @param message message to send
* @returns a promise
*/
var send = function(message) { var send = function(message) {
message.replace(/[\r\n]+$/g, "").split("\n"); message.replace(/[\r\n]+$/g, "").split("\n");
var cb = createCallback(message); var cb = createCallback(message);