forked from mroderick/PubSubJS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pubsub.js
176 lines (148 loc) · 6.33 KB
/
pubsub.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/*
Copyright (c) 2010 Morgan Roderick http://roderick.dk
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*jslint evil: false, strict: false, undef: true, white: false, onevar:false, plusplus:false */
/*global setTimeout:true */
/** section: PubSub
* PubSubJS is a dependency free library for doing ['publish/subscribe'](http://en.wikipedia.org/wiki/Publish/subscribe)
* messaging in JavaScript.
*
* In order to not have surprising behaviour where the execution chain generates more than one message,
* publication of messages with PubSub are done asyncronously (this also helps keep your code responsive, by
* dividing work into smaller chunkcs, allowing the event loop to do it's business).
*
* If you're feeling adventurous, you can also use syncronous message publication, which can lead to some very
* confusing conditions, when one message triggers publication of another message in the same execution chain.
* Don't say I didn't warn you.
*
* ##### Examples
*
* // create a function to receive the message
* var mySubscriber = function( msg, data ){
* console.log( msg, data );
* };
*
* // add the function to the list of subscribers to a particular message
* // we're keeping the returned token, in order to be able to unsubscribe from the message later on
* var token = PubSub.subscribe( 'MY MESSAGE', mySubscriber );
*
* // publish a message asyncronously
* PubSub.publish( 'MY MESSAGE', 'hello world!' );
*
* // publish a message syncronously, which is faster by orders of magnitude, but will get confusing
* // when one message triggers new messages in the same execution chain
* // USE WITH CATTION, HERE BE DRAGONS!!!
* PubSub.publishSync( 'MY MESSAGE', 'hello world!' );
*
* // unsubscribe from further messages, using setTimeout to allow for easy pasting of this code into an example :-)
* setTimeout(function(){
* PubSub.unsubscribe( token );
* }, 0)
**/
var PubSub = {};
(function(p){
"use strict";
var messages = {};
var lastUid = -1;
var publish = function( message, sender, data){
// if there are no subscribers to this message, just return here
if ( !messages.hasOwnProperty( message ) ){
return false;
}
var deliverMessage = function(){
var subscribers = messages[message];
var throwException = function(e){
return function(){
throw e;
};
};
for ( var i = 0, j = subscribers.length; i < j; i++ ){
if (subscribers[i].sender != undefined && subscribers[i].sender != sender )
continue;
if(subscribers[i].sync){
try {
subscribers[i].func( data, sender );
} catch( e ){
setTimeout( throwException(e), 0);
}
}
else {
try {
var subscriber = subscribers[i];
var timedOutFunction = function(){subscriber.func( data, sender );}
setTimeout(timedOutFunction, 4000);
} catch( e ){
setTimeout( throwException(e), 0);
}
}
}
};
deliverMessage();
return true;
};
p.version = '0.1';
/**
* PubSub.publish( message[, data] ) -> Boolean
* - message (String): The message to publish
* - data: The data to pass to subscribers
*
* Publishes the the message, passing the data to it's subscribers
**/
p.publish = function( message, sender, data ){
return publish( message, sender, data);
};
var subscribe = function( message, func, sender, sync ){
if (sync == undefined)
sync = false;
// message is not registered yet
if ( !messages.hasOwnProperty( message ) ){
messages[message] = [];
}
// forcing token as String, to allow for future expansions without breaking usage
// and allow for easy use as key names for the 'messages' object
var token = (++lastUid).toString();
messages[message].push( { token : token, func : func, sender : sender, sync : sync } );
// return token for unsubscribing
return token;
};
p.subscribeSync = function( message, func, sender ){
return subscribe(message, func, sender, true);
}
p.subscribeAsync = function( message, func, sender ){
return subscribe(message, func, sender, false);
}
/**
* PubSub.unsubscribe( token ) -> String | Boolean
* - token (String): The token of the function to unsubscribe
* Unsubscribes a specific subscriber from a specific message using the unique token
**/
p.unsubscribe = function( token ){
for ( var m in messages ){
if ( messages.hasOwnProperty( m ) ){
for ( var i = 0, j = messages[m].length; i < j; i++ ){
if ( messages[m][i].token === token ){
messages[m].splice( i, 1 );
return token;
}
}
}
}
return false;
};
}(PubSub));