-
Notifications
You must be signed in to change notification settings - Fork 12
/
readme.html
711 lines (668 loc) · 22.3 KB
/
readme.html
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>readme</title>
<!-- 2016-05-07 Sat 19:03 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; }
.left { margin-left: 0px; margin-right: auto; text-align: left; }
.center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 10px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
pre.src-sh:before { content: 'sh'; }
pre.src-bash:before { content: 'sh'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-R:before { content: 'R'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-java:before { content: 'Java'; }
pre.src-sql:before { content: 'SQL'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; }
.footpara { display: block; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
/*]]>*/-->
</style>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2013 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">readme</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#sec-1">1. Flyer.js</a></li>
<li><a href="#sec-2">2. Including flyer in your clojurescript project</a>
<ul>
<li><a href="#sec-2-1">2.1. Leiningen</a></li>
<li><a href="#sec-2-2">2.2. Gradle</a></li>
<li><a href="#sec-2-3">2.3. Maven</a></li>
</ul>
</li>
<li><a href="#sec-3">3. Features and Operation</a></li>
<li><a href="#sec-4">4. Javascript Configuration</a></li>
<li><a href="#sec-5">5. Download</a></li>
<li><a href="#sec-6">6. Javascript API</a>
<ul>
<li><a href="#sec-6-1">6.1. flyer.broadcast([Options])</a>
<ul>
<li><a href="#sec-6-1-1">6.1.1. Options</a></li>
<li><a href="#sec-6-1-2">6.1.2. Examples</a></li>
</ul>
</li>
<li><a href="#sec-6-2">6.2. flyer.subscribe([Options])</a>
<ul>
<li><a href="#sec-6-2-1">6.2.1. Options</a></li>
<li><a href="#sec-6-2-2">6.2.2. Examples</a></li>
</ul>
</li>
<li><a href="#sec-6-3">6.3. flyer.window.open(url, name, [Options])</a></li>
</ul>
</li>
<li><a href="#sec-7">7. Clojurescript API (untested)</a>
<ul>
<li><a href="#sec-7-1">7.1. flyer.messaging/broadcast</a>
<ul>
<li><a href="#sec-7-1-1">7.1.1. (broadcast & options)</a></li>
<li><a href="#sec-7-1-2">7.1.2. Options</a></li>
<li><a href="#sec-7-1-3">7.1.3. Example</a></li>
</ul>
</li>
<li><a href="#sec-7-2">7.2. flyer.messaging/subscribe</a>
<ul>
<li><a href="#sec-7-2-1">7.2.1. (subscribe & options)</a></li>
<li><a href="#sec-7-2-2">7.2.2. Options</a></li>
<li><a href="#sec-7-2-3">7.2.3. Example</a></li>
</ul>
</li>
<li><a href="#sec-7-3">7.3. flyer.window/open</a>
<ul>
<li><a href="#sec-7-3-1">7.3.1. (open url name & options)</a></li>
<li><a href="#sec-7-3-2">7.3.2. url parameter</a></li>
<li><a href="#sec-7-3-3">7.3.3. name parameter</a></li>
<li><a href="#sec-7-3-4">7.3.4. Options</a></li>
<li><a href="#sec-7-3-5">7.3.5. Example</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#sec-8">8. Example</a></li>
<li><a href="#sec-9">9. Project Compilation</a></li>
<li><a href="#sec-10">10. Issues</a></li>
<li><a href="#sec-11">11. Technical Details</a>
<ul>
<li><a href="#sec-11-1">11.1. How it works</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Flyer.js</h2>
<div class="outline-text-2" id="text-1">
<div class="figure">
<p><img src="./doc/intro.png" alt="intro.png" />
</p>
</div>
<p>
<b>flyer.js</b> is a lightweight messaging library written for
clojurescript & javascript.
</p>
<p>
It provides broadcast messaging between frames, iframes, and
windows.
</p>
<p>
Here is a <a href="http://benzap.github.com/flyer.js">demo page</a>, which is in the works.
</p>
<div class="figure">
<p><img src="https://img.shields.io/clojars/v/flyer.svg" alt="flyer.svg" />
</p>
</div>
</div>
</div>
<div id="outline-container-sec-2" class="outline-2">
<h2 id="sec-2"><span class="section-number-2">2</span> Including flyer in your clojurescript project</h2>
<div class="outline-text-2" id="text-2">
</div><div id="outline-container-sec-2-1" class="outline-3">
<h3 id="sec-2-1"><span class="section-number-3">2.1</span> Leiningen</h3>
<div class="outline-text-3" id="text-2-1">
<div class="org-src-container">
<pre class="src src-clojure">[flyer "1.1.0-SNAPSHOT"]
</pre>
</div>
</div>
</div>
<div id="outline-container-sec-2-2" class="outline-3">
<h3 id="sec-2-2"><span class="section-number-3">2.2</span> Gradle</h3>
<div class="outline-text-3" id="text-2-2">
<div class="org-src-container">
<pre class="src src-sh">compile "flyer:flyer:1.1.0-SNAPSHOT"
</pre>
</div>
</div>
</div>
<div id="outline-container-sec-2-3" class="outline-3">
<h3 id="sec-2-3"><span class="section-number-3">2.3</span> Maven</h3>
<div class="outline-text-3" id="text-2-3">
<div class="org-src-container">
<pre class="src src-xml"><dependency>
<groupId>flyer</groupId>
<artifactId>flyer</artifactId>
<version>1.1.0</version>
</dependency>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-3" class="outline-2">
<h2 id="sec-3"><span class="section-number-2">3</span> Features and Operation</h2>
<div class="outline-text-2" id="text-3">
<ul class="org-ul">
<li>Simple API, from which you can build more elaborate messaging
systems.
</li>
<li>Messages are broadcasted to all frames and registered windows,
regardless of whether or not they want them (hence, the name)
</li>
<li>Frames can subscribe to specific channels, and can regex-match
to broader topics being sent on that channel
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-4" class="outline-2">
<h2 id="sec-4"><span class="section-number-2">4</span> Javascript Configuration</h2>
<div class="outline-text-2" id="text-4">
<ul class="org-ul">
<li>Include <i>flyer.js</i> at the end of your page body
<div class="org-src-container">
<pre class="src src-html"><script type="text/javascript" src="./js/flyer.js"></script>
</pre>
</div>
</li>
<li>In situations where you would use <b>window.open</b>, use
<b>flyer.window.open</b> instead. This is required in order to track
window references.
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-5" class="outline-2">
<h2 id="sec-5"><span class="section-number-2">5</span> Download</h2>
<div class="outline-text-2" id="text-5">
<ul class="org-ul">
<li><a href="https://github.com/benzap/flyer.js/releases/tag/v1.1.0">Version 1.1.0</a>
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-6" class="outline-2">
<h2 id="sec-6"><span class="section-number-2">6</span> Javascript API</h2>
<div class="outline-text-2" id="text-6">
</div><div id="outline-container-sec-6-1" class="outline-3">
<h3 id="sec-6-1"><span class="section-number-3">6.1</span> flyer.broadcast([Options])</h3>
<div class="outline-text-3" id="text-6-1">
</div><div id="outline-container-sec-6-1-1" class="outline-4">
<h4 id="sec-6-1-1"><span class="section-number-4">6.1.1</span> Options</h4>
<div class="outline-text-4" id="text-6-1-1">
<dl class="org-dl">
<dt> channel </dt><dd>the channel you wish to broadcast on. default is "*",
which stands for <b>all channels</b>
</dd>
<dt> topic </dt><dd>the topic of your broadcast message. default is "*",
which stands for <b>all topics</b>
</dd>
<dt> data </dt><dd>any JSON serializable object
</dd>
<dt> target </dt><dd>determines what type of target domain is expected to
receive this message. By default, the target is
"all", but it can be set to "local", or a target
domain of your choosing.
</dd>
</dl>
</div>
</div>
<div id="outline-container-sec-6-1-2" class="outline-4">
<h4 id="sec-6-1-2"><span class="section-number-4">6.1.2</span> Examples</h4>
<div class="outline-text-4" id="text-6-1-2">
<div class="org-src-container">
<pre class="src src-js">flyer.broadcast({
channel: "default",
topic: "person.insert",
data: {id: 1, name: "Ben"}
});
flyer.broadcast({
channel: "default",
topic: "person.delete",
data: {id: 1}
});
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-6-2" class="outline-3">
<h3 id="sec-6-2"><span class="section-number-3">6.2</span> flyer.subscribe([Options])</h3>
<div class="outline-text-3" id="text-6-2">
</div><div id="outline-container-sec-6-2-1" class="outline-4">
<h4 id="sec-6-2-1"><span class="section-number-4">6.2.1</span> Options</h4>
<div class="outline-text-4" id="text-6-2-1">
<dl class="org-dl">
<dt> channel </dt><dd>the channel you wish to subscribe to. default is "*",
which stands for <b>all channels</b>
</dd>
<dt> topic </dt><dd>the topic you wish to subscribe to. default is "*",
which stands for <b>all topics</b>. Note that this can
also be a string representation of a regex expression.
</dd>
<dt> callback </dt><dd>callback function of the form <b>function(data,
[topic], [channel] [origin])</b> that you wish to call when the
subscription is made.
</dd>
<dt> origin </dt><dd>refers to the origin, or domain from which the
messages will be received. The default is <b>all</b>, but
it can be set to <b>local</b>, or to another origin
</dd>
</dl>
</div>
</div>
<div id="outline-container-sec-6-2-2" class="outline-4">
<h4 id="sec-6-2-2"><span class="section-number-4">6.2.2</span> Examples</h4>
<div class="outline-text-4" id="text-6-2-2">
<div class="org-src-container">
<pre class="src src-js">flyer.subscribe({
channel: "default",
topic: "person.*",
callback: function(data, topic, channel) {
if (topic == "person.insert") {
console.log("Inserted Person! - " + data.name);
}
else if (topic == "person.delete") {
console.log("Removed Person with id - " + data.id);
}
}
});
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-6-3" class="outline-3">
<h3 id="sec-6-3"><span class="section-number-3">6.3</span> flyer.window.open(url, name, [Options])</h3>
<div class="outline-text-3" id="text-6-3">
<p>
<i>follows the same API as window.open</i>
</p>
<p>
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window.open">Mozilla API Page</a>
</p>
</div>
</div>
</div>
<div id="outline-container-sec-7" class="outline-2">
<h2 id="sec-7"><span class="section-number-2">7</span> Clojurescript API (untested)</h2>
<div class="outline-text-2" id="text-7">
</div><div id="outline-container-sec-7-1" class="outline-3">
<h3 id="sec-7-1"><span class="section-number-3">7.1</span> flyer.messaging/broadcast</h3>
<div class="outline-text-3" id="text-7-1">
</div><div id="outline-container-sec-7-1-1" class="outline-4">
<h4 id="sec-7-1-1"><span class="section-number-4">7.1.1</span> (broadcast & options)</h4>
</div>
<div id="outline-container-sec-7-1-2" class="outline-4">
<h4 id="sec-7-1-2"><span class="section-number-4">7.1.2</span> Options</h4>
<div class="outline-text-4" id="text-7-1-2">
<dl class="org-dl">
<dt> channel </dt><dd>the channel you wish to broadcast on. default is "*",
which stands for <b>all channels</b>
</dd>
<dt> topic </dt><dd>the topic of your broadcast message. default is "*",
which stands for <b>all topics</b>
</dd>
<dt> data </dt><dd>any JSON serializable object
</dd>
<dt> target </dt><dd>refers to the target origin, or domain in which to
post the message. The default is <b>:all</b>, but it can
also be <b>:local</b>, or a target origin of your choosing
</dd>
</dl>
</div>
</div>
<div id="outline-container-sec-7-1-3" class="outline-4">
<h4 id="sec-7-1-3"><span class="section-number-4">7.1.3</span> Example</h4>
<div class="outline-text-4" id="text-7-1-3">
<div class="org-src-container">
<pre class="src src-clojurescript">(broadcast :channel "default"
:topic "person.insert"
:data {:id 1 :name "Ben"}
:origin :all)
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-7-2" class="outline-3">
<h3 id="sec-7-2"><span class="section-number-3">7.2</span> flyer.messaging/subscribe</h3>
<div class="outline-text-3" id="text-7-2">
</div><div id="outline-container-sec-7-2-1" class="outline-4">
<h4 id="sec-7-2-1"><span class="section-number-4">7.2.1</span> (subscribe & options)</h4>
</div>
<div id="outline-container-sec-7-2-2" class="outline-4">
<h4 id="sec-7-2-2"><span class="section-number-4">7.2.2</span> Options</h4>
<div class="outline-text-4" id="text-7-2-2">
<dl class="org-dl">
<dt> channel </dt><dd>the channel you wish to subscribe to. default is "*",
which stands for <b>all channels</b>
</dd>
<dt> topic </dt><dd>the topic you wish to subscribe to. default is "*",
which stands for <b>all topics</b>. Note that this can
also be a string representation of a regex expression.
</dd>
<dt> callback </dt><dd>callback function of the form <b>(fn [data] [topic]
[channel] [origin])</b> that you wish to call when the
subscription is made.
</dd>
<dt> origin </dt><dd>the origin you wish to subscribe to. This is decides
on the domain that messages can be received. The
default is <b>:all</b>, but it can also be <b>:local</b>, or an
origin of your choice
</dd>
</dl>
</div>
</div>
<div id="outline-container-sec-7-2-3" class="outline-4">
<h4 id="sec-7-2-3"><span class="section-number-4">7.2.3</span> Example</h4>
<div class="outline-text-4" id="text-7-2-3">
<div class="org-src-container">
<pre class="src src-clojurescript">(subscribe :channel "default"
:origin :local
:topic "person.*"
:callback
(fn [data topic channel]
(condp = topic
"person.insert"
(.log js/console "Inserting person! - " (.-name data))
"person.delete"
(.log js/console "Deleting person! - #" (.-id data)))))
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-7-3" class="outline-3">
<h3 id="sec-7-3"><span class="section-number-3">7.3</span> flyer.window/open</h3>
<div class="outline-text-3" id="text-7-3">
</div><div id="outline-container-sec-7-3-1" class="outline-4">
<h4 id="sec-7-3-1"><span class="section-number-4">7.3.1</span> (open url name & options)</h4>
</div>
<div id="outline-container-sec-7-3-2" class="outline-4">
<h4 id="sec-7-3-2"><span class="section-number-4">7.3.2</span> url parameter</h4>
<div class="outline-text-4" id="text-7-3-2">
<p>
The window URL
</p>
</div>
</div>
<div id="outline-container-sec-7-3-3" class="outline-4">
<h4 id="sec-7-3-3"><span class="section-number-4">7.3.3</span> name parameter</h4>
<div class="outline-text-4" id="text-7-3-3">
<p>
The unique name you wish to give the window
</p>
</div>
</div>
<div id="outline-container-sec-7-3-4" class="outline-4">
<h4 id="sec-7-3-4"><span class="section-number-4">7.3.4</span> Options</h4>
<div class="outline-text-4" id="text-7-3-4">
<p>
key / value pairs of options equivalent to window.open options
</p>
</div>
</div>
<div id="outline-container-sec-7-3-5" class="outline-4">
<h4 id="sec-7-3-5"><span class="section-number-4">7.3.5</span> Example</h4>
<div class="outline-text-4" id="text-7-3-5">
<div class="org-src-container">
<pre class="src src-clojurescript">(open "frame_login.html" "login-page" :width 400 :height 600)
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="outline-container-sec-8" class="outline-2">
<h2 id="sec-8"><span class="section-number-2">8</span> Example</h2>
<div class="outline-text-2" id="text-8">
<p>
<a href="http://benzap.github.io/flyer.js">Demo Page</a>
</p>
</div>
</div>
<div id="outline-container-sec-9" class="outline-2">
<h2 id="sec-9"><span class="section-number-2">9</span> Project Compilation</h2>
<div class="outline-text-2" id="text-9">
<ol class="org-ol">
<li>Clone this Repository
</li>
<li>Install <a href="http://leiningen.org/">Leiningen</a>
</li>
<li>cd into flyer.js directory
</li>
<li>type <b>lein deps</b>
</li>
<li>type <b>lein cljsbuild once</b>
</li>
<li>resulting <b>flyer.js</b> should now be present in
./resources/public/js/
</li>
</ol>
</div>
</div>
<div id="outline-container-sec-10" class="outline-2">
<h2 id="sec-10"><span class="section-number-2">10</span> Issues</h2>
<div class="outline-text-2" id="text-10">
<ul class="org-ul">
<li>In order to communicate with frames and windows that are within an
external window, you need to replace <b>window.open</b> with
<b>flyer.window.open</b>
</li>
<li>The size of <b>flyer.js</b> is quite big, at a whopping 1mb. This is
due to the nature of compilation. Use flyer.min.js to bring this
down to 100kb
</li>
<li>Refreshing the parent window of an opened window will break any
messages from being broadcasted throughout the application. This
is due to the external window frame losing its parent
(window.opener).
</li>
<li>external windows can be refreshed without losing communications,
however, it requires that flyer.js be included within that html
page
</li>
</ul>
</div>
</div>
<div id="outline-container-sec-11" class="outline-2">
<h2 id="sec-11"><span class="section-number-2">11</span> Technical Details</h2>
<div class="outline-text-2" id="text-11">
</div><div id="outline-container-sec-11-1" class="outline-3">
<h3 id="sec-11-1"><span class="section-number-3">11.1</span> How it works</h3>
<div class="outline-text-3" id="text-11-1">
<p>
flyer.js works by hijacking window.postMessage, and the event
generated, which can be attached to through the "message" event
</p>
<p>
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage">Mozilla API Page</a>
</p>
<div class="org-src-container">
<pre class="src src-js">//attaching a listener to frame[0]
window.frame[0].addEventListener("message",
function(event) {
console.log(event.data, event.origin)
});
//posting a message to frame[0]
window.frame[0].postMessage("some message", "*")
</pre>
</div>
<p>
It also does a few other things:
</p>
<ul class="org-ul">
<li>generates a list of frames, by performing a traversal through all
of the frames and external windows.
</li>
<li>wraps the functionality into two sane functions.
</li>
</ul>
<p>
The full set of steps when performing a broadcast:
</p>
<ol class="org-ol">
<li>Generate list of frames and external window frames (flyer.traversal)
</li>
<li>Generate a message, by stringifying a defined message object
{channel:…, topic:…, data:…} (flyer.messaging)
</li>
<li>For each frame, f, perform f.postMessage(msg, target)
</li>
</ol>
<p>
The full steps when performing a subscribe:
</p>
<ol class="org-ol">
<li>Grab the callback function, and add a "message" event listener
decorated with a set of rules
<ul class="org-ul">
<li>Does it have the same channel?
</li>
<li>Does it have the same topic?
</li>
<li>If it isn't the same topic, does the provided callback topic regex
match the broadcasted topic?
</li>
<li>Does it have a lax origin, or is it accepting all origins?
</li>
</ul>
</li>
<li>If it passes the conditions in step 1, the main callback is
called with the results of the broadcast. Further conditions can
be provided at the developers discretion.
</li>
</ol>
</div>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="date">Created: 2016-05-07 Sat 19:03</p>
<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.5.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>