browserchannel 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +202 -0
- data/README.md +71 -0
- data/lib/browser_channel.rb +261 -0
- data/lib/browser_test_channel.rb +80 -0
- metadata +62 -0
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
#!text
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
#BrowserChannel Ruby Server
|
2
|
+
Copyright 2011 David Turnbull. Licensed under the Apache License, Version 2.0.
|
3
|
+
|
4
|
+
An event-driven server for Google Closure Library's goog.BrowserChannel class.
|
5
|
+
|
6
|
+
##Getting Started
|
7
|
+
|
8
|
+
### Step 1
|
9
|
+
Ensure you have a modern Ruby and RubyGems.
|
10
|
+
Version 1.8.6 and higher should work. Run:
|
11
|
+
|
12
|
+
gem install thin closure json
|
13
|
+
thin start
|
14
|
+
|
15
|
+
### Step 2
|
16
|
+
Open your web browser and continue from there.
|
17
|
+
Check the thin log for the proper port.
|
18
|
+
It's most likely:
|
19
|
+
|
20
|
+
http://localhost:3000/
|
21
|
+
|
22
|
+
##Getting to Production
|
23
|
+
|
24
|
+
The browser is started by attaching a handler to a channel. The channel
|
25
|
+
then connects with a server. The handler is your implementation.
|
26
|
+
|
27
|
+
var handler = new goog.net.BrowserChannel.Handler();
|
28
|
+
handler.channelOpened = function(channel) {
|
29
|
+
// fire off a message immediately after connect
|
30
|
+
channel.sendMap({message:'data'});
|
31
|
+
};
|
32
|
+
handler.channelHandleArray = function(x, data) {
|
33
|
+
// messages from the server arrive here
|
34
|
+
alert(data[0].message);
|
35
|
+
};
|
36
|
+
|
37
|
+
channel = new goog.net.BrowserChannel();
|
38
|
+
channel.setHandler(handler);
|
39
|
+
channel.connect('demo.test', 'demo.channel');
|
40
|
+
|
41
|
+
The server is a Rack application for the `thin` server. Other Rack servers do
|
42
|
+
not support event-driven multi chunk responses. Thin also enables use of the
|
43
|
+
epoll/kqueue interface which allows for tens of thousands of open connections.
|
44
|
+
Expect 500-1000 requests per second on a single core of modern hardware.
|
45
|
+
|
46
|
+
# for config.ru
|
47
|
+
require 'browser_channel'
|
48
|
+
require 'browser_test_channel'
|
49
|
+
map '/demo.channel' do
|
50
|
+
run BrowserChannel::Server.new, :handler => MyHandler
|
51
|
+
end
|
52
|
+
map '/demo.test' do
|
53
|
+
run BrowserTestChannel::Server.new
|
54
|
+
end
|
55
|
+
|
56
|
+
Just like the browser side, there's a handler for your implementation.
|
57
|
+
|
58
|
+
class MyHandler < BrowserChanner::Handler
|
59
|
+
# this is an echo server
|
60
|
+
def call post_data
|
61
|
+
requests = decode_post_data post_data
|
62
|
+
requests.each { |r| @session << [r] }
|
63
|
+
end
|
64
|
+
# called when channel session is final
|
65
|
+
def terminate
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
Be sure not to deploy the Closure Script build tool or debug tools like
|
70
|
+
Rack::Reloader. These will severely affect performance and security.
|
71
|
+
Check your middleware if you're not seeing the benchmarks you expect.
|
@@ -0,0 +1,261 @@
|
|
1
|
+
# Copyright 2011 David Turnbull
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'json'
|
16
|
+
require 'thin'
|
17
|
+
|
18
|
+
class BrowserChannel
|
19
|
+
|
20
|
+
class Server
|
21
|
+
def initialize options={}
|
22
|
+
@options = {
|
23
|
+
# Subclass this echo Handler or create your own.
|
24
|
+
:handler => Handler,
|
25
|
+
# Ensure a chunk is sent within these first few seconds because
|
26
|
+
# waiting an entire interval looks too much like a broken server.
|
27
|
+
:keep_alive_first => 10,
|
28
|
+
# Send a noop chunk every so many seconds to prevent timeouts.
|
29
|
+
:keep_alive_interval => 30,
|
30
|
+
# Alternate host prefix for clients with connection pool limits.
|
31
|
+
:host_prefix => nil,
|
32
|
+
# Number of seconds a session must be unbound before freed.
|
33
|
+
:gc_max_age => 120,
|
34
|
+
# Minimum number of seconds to wait between garbage collections.
|
35
|
+
:gc_frequency => 10,
|
36
|
+
}.merge! options
|
37
|
+
errors = []
|
38
|
+
unless @options[:gc_max_age] > (@options[:keep_alive_interval] - @options[:keep_alive_first])
|
39
|
+
# in this condition, connections look expired on creation
|
40
|
+
errors << 'gc_max_age is too small'
|
41
|
+
end
|
42
|
+
if @options[:keep_alive_interval] < @options[:keep_alive_first]
|
43
|
+
errors << 'keep_alive_first must be same or smaller than keep_alive_interval'
|
44
|
+
end
|
45
|
+
raise "Options Fail: #{errors.join(', ')}." unless errors.empty?
|
46
|
+
end
|
47
|
+
def call env
|
48
|
+
BrowserChannel.new @options, env
|
49
|
+
Thin::Connection::AsyncResponse
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
# Example Handler that echos data.
|
54
|
+
class Handler
|
55
|
+
REQ_REGEXP = /^req(\d*)_(.*)$/
|
56
|
+
def initialize session
|
57
|
+
@session = session
|
58
|
+
end
|
59
|
+
def terminate
|
60
|
+
end
|
61
|
+
def call post_data
|
62
|
+
requests = decode_post_data post_data
|
63
|
+
requests.each { |r| @session << [r] }
|
64
|
+
end
|
65
|
+
private
|
66
|
+
def decode_post_data post_data
|
67
|
+
count = [0,post_data['count'].to_i].max
|
68
|
+
requests = Array.new(count){Hash.new}
|
69
|
+
post_data.each do |key, value|
|
70
|
+
next unless match = REQ_REGEXP.match(key)
|
71
|
+
index = match[1].to_i
|
72
|
+
next if index < 0 or index >= count
|
73
|
+
requests[index][match[2]] = value
|
74
|
+
end
|
75
|
+
requests
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
# A Session manages two arrays of responses. One is maintained in case the
|
80
|
+
# connection is dropped so that we don't lose messages. This gets truncated
|
81
|
+
# as we receive 'AID' information from the client indicating the data was
|
82
|
+
# received. The other array collects outgoing data for the currently bound
|
83
|
+
# channel so it can be sent in a single chunk with other data in the next tick.
|
84
|
+
|
85
|
+
class Session
|
86
|
+
|
87
|
+
@@sessions ||= {}
|
88
|
+
@@sessions_gc ||= Time.now
|
89
|
+
|
90
|
+
ID_CHARACTERS = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a).freeze
|
91
|
+
|
92
|
+
def self.new options, id, array_id
|
93
|
+
if Time.now > @@sessions_gc
|
94
|
+
to_terminate = []
|
95
|
+
@@sessions.each do |key, session|
|
96
|
+
next unless session.unbound_at
|
97
|
+
next if Time.now - session.unbound_at < options[:gc_max_age]
|
98
|
+
to_terminate << key
|
99
|
+
end
|
100
|
+
to_terminate.each do |key|
|
101
|
+
@@sessions[key].terminate
|
102
|
+
end
|
103
|
+
@@sessions_gc = Time.now + options[:gc_frequency]
|
104
|
+
end
|
105
|
+
if id
|
106
|
+
session = @@sessions[id]
|
107
|
+
if session and array_id and !array_id.empty?
|
108
|
+
array_id = array_id.to_i
|
109
|
+
messages = session.messages
|
110
|
+
messages.shift until messages.empty? or messages.first[0] > array_id
|
111
|
+
end
|
112
|
+
return session
|
113
|
+
end
|
114
|
+
while !id or @@sessions.has_key? id
|
115
|
+
id = (0..32).map{ID_CHARACTERS[rand(ID_CHARACTERS.size)]}.join
|
116
|
+
end
|
117
|
+
allocate.instance_eval do
|
118
|
+
@handler = options[:handler].new self
|
119
|
+
initialize id
|
120
|
+
@@sessions[id] = self
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
attr_accessor :id, :array_id, :messages, :unbound_at
|
125
|
+
|
126
|
+
def initialize id
|
127
|
+
@id = id
|
128
|
+
@array_id = -1
|
129
|
+
@messages = []
|
130
|
+
unbind(@channel = nil) # trick into init
|
131
|
+
end
|
132
|
+
|
133
|
+
def bind channel
|
134
|
+
@channel = channel
|
135
|
+
@channel_queue = []
|
136
|
+
@unbound_at = nil
|
137
|
+
end
|
138
|
+
|
139
|
+
# A channel will request to unbind itself after the connection completes.
|
140
|
+
# It's possible another connection has taken over so abort if it looks so.
|
141
|
+
def unbind channel
|
142
|
+
return if @channel != channel
|
143
|
+
@channel = channel
|
144
|
+
@unbound_at = Time.now
|
145
|
+
end
|
146
|
+
|
147
|
+
def terminate
|
148
|
+
@handler.terminate if @handler.respond_to? :terminate
|
149
|
+
@@sessions.delete @id
|
150
|
+
end
|
151
|
+
|
152
|
+
# Data from the browser arrives here.
|
153
|
+
def call post_data
|
154
|
+
session_bound = @channel ? 1 : 0
|
155
|
+
pending_bytes = @messages.empty? ? 0 : @session.to_json.bytesize
|
156
|
+
response = [session_bound, @array_id, pending_bytes]
|
157
|
+
@handler.call post_data
|
158
|
+
response
|
159
|
+
end
|
160
|
+
|
161
|
+
# Adds a new message and schedules it to be sent.
|
162
|
+
# Magic ['stop'] will tell the browser server is going down.
|
163
|
+
def push array
|
164
|
+
message = [@array_id += 1, array]
|
165
|
+
@messages << message
|
166
|
+
return unless @channel
|
167
|
+
if @channel_queue.empty?
|
168
|
+
EventMachine.next_tick do
|
169
|
+
if @channel
|
170
|
+
@channel.send_data @channel_queue
|
171
|
+
@channel_queue = []
|
172
|
+
end
|
173
|
+
end
|
174
|
+
end
|
175
|
+
@channel_queue << message
|
176
|
+
end
|
177
|
+
alias :<< :push
|
178
|
+
|
179
|
+
end
|
180
|
+
|
181
|
+
include EventMachine::Deferrable
|
182
|
+
|
183
|
+
LATEST_CHANNEL_VERSION = 8
|
184
|
+
NOOP = ['noop'.freeze].freeze
|
185
|
+
|
186
|
+
def initialize options, env
|
187
|
+
@options = options
|
188
|
+
request = Rack::Request.new env
|
189
|
+
request_GET = request.GET
|
190
|
+
request_GET_SID = request_GET['SID']
|
191
|
+
@session = Session.new @options, request_GET_SID, request_GET['AID']
|
192
|
+
unless @session
|
193
|
+
request.env['async.callback'].call [400, {}, self]
|
194
|
+
succeed
|
195
|
+
return
|
196
|
+
end
|
197
|
+
if @session.array_id == -1
|
198
|
+
@session << ['c', @session.id, @options[:host_prefix], LATEST_CHANNEL_VERSION]
|
199
|
+
end
|
200
|
+
@chunked = request_GET['CI'] == '0'
|
201
|
+
@html_data_type = request_GET['TYPE'] == 'html'
|
202
|
+
headers = {'Cache-Control' => 'no-cache'}
|
203
|
+
headers['Content-Type'] = @html_data_type ? 'text/html' : 'application/javascript'
|
204
|
+
env['async.callback'].call [200, headers, self]
|
205
|
+
if @html_data_type
|
206
|
+
@body_callback.call "<html><body>\n"
|
207
|
+
if domain = request_GET['DOMAIN']
|
208
|
+
@body_callback.call "<script>try{document.domain=#{domain.dump};}catch(e){}</script>\n"
|
209
|
+
end
|
210
|
+
end
|
211
|
+
if request_GET['TYPE'] == 'terminate'
|
212
|
+
@session.terminate
|
213
|
+
succeed
|
214
|
+
return
|
215
|
+
end
|
216
|
+
if request.post? and request_GET_SID
|
217
|
+
send_data @session.call request.POST
|
218
|
+
return
|
219
|
+
elsif request.get?
|
220
|
+
# Thin calls errback when connection closes, even after success
|
221
|
+
if @chunked
|
222
|
+
@last_message = Time.now - ( @options[:keep_alive_interval] - @options[:keep_alive_first] )
|
223
|
+
keep_alive
|
224
|
+
errback { @timer.cancel }
|
225
|
+
end
|
226
|
+
@session.bind self
|
227
|
+
errback { @session.unbind self }
|
228
|
+
end
|
229
|
+
send_data @session.messages unless @session.messages.empty?
|
230
|
+
end
|
231
|
+
|
232
|
+
def keep_alive
|
233
|
+
idle = Time.now - @last_message
|
234
|
+
if idle > @options[:keep_alive_interval]
|
235
|
+
@session << NOOP
|
236
|
+
idle = 0
|
237
|
+
end
|
238
|
+
@timer = EventMachine::Timer.new @options[:keep_alive_interval] - idle, &method(:keep_alive)
|
239
|
+
end
|
240
|
+
|
241
|
+
def each &block
|
242
|
+
@body_callback = block
|
243
|
+
end
|
244
|
+
|
245
|
+
def send_data messages
|
246
|
+
json = messages.to_json
|
247
|
+
if @html_data_type
|
248
|
+
@body_callback.call "<script>try{parent.m(#{json.dump});}catch(e){}</script>\n"
|
249
|
+
else
|
250
|
+
@body_callback.call "#{json.bytesize+1}\n#{json}\n"
|
251
|
+
end
|
252
|
+
@last_message = Time.now
|
253
|
+
unless @chunked
|
254
|
+
if @html_data_type
|
255
|
+
@body_callback.call "<script>try{parent.d();}catch(e){}</script>\n</body></html>\n"
|
256
|
+
end
|
257
|
+
succeed
|
258
|
+
end
|
259
|
+
end
|
260
|
+
|
261
|
+
end
|
@@ -0,0 +1,80 @@
|
|
1
|
+
# Copyright 2011 David Turnbull
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'json'
|
16
|
+
require 'thin'
|
17
|
+
|
18
|
+
class BrowserTestChannel
|
19
|
+
|
20
|
+
class Server
|
21
|
+
def initialize options={}
|
22
|
+
@options = {
|
23
|
+
# alternate host prefix for clients with connection pool limits
|
24
|
+
:host_prefix => nil,
|
25
|
+
# network admins can block this host to disable streaming
|
26
|
+
# '/mail/images/cleardot.gif' must be found on this host
|
27
|
+
:blocked_prefix => nil,
|
28
|
+
}.merge! options
|
29
|
+
end
|
30
|
+
def call env
|
31
|
+
request = Rack::Request.new env
|
32
|
+
if request.GET['MODE'] == 'init'
|
33
|
+
[
|
34
|
+
200,
|
35
|
+
{'Content-Type' => 'application/javascript'},
|
36
|
+
[[@options[:host_prefix], @options[:blocked_prefix]].to_json]
|
37
|
+
]
|
38
|
+
else
|
39
|
+
BrowserTestChannel.new request
|
40
|
+
Thin::Connection::AsyncResponse
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
include EventMachine::Deferrable
|
46
|
+
|
47
|
+
def initialize request
|
48
|
+
@html_data_type = request.GET['TYPE'] == 'html'
|
49
|
+
headers = {'Cache-Control' => 'no-cache'}
|
50
|
+
headers['Content-Type'] = @html_data_type ? 'text/html' : 'application/javascript'
|
51
|
+
request.env['async.callback'].call [200, headers, self]
|
52
|
+
if @html_data_type
|
53
|
+
@body_callback.call "<html><body>\n"
|
54
|
+
if domain = request.GET['DOMAIN']
|
55
|
+
@body_callback.call "<script>try{document.domain=#{domain.dump};}catch(e){}</script>\n"
|
56
|
+
end
|
57
|
+
end
|
58
|
+
call '11111'
|
59
|
+
EventMachine.add_timer(2) do
|
60
|
+
call '2'
|
61
|
+
if @html_data_type
|
62
|
+
@body_callback.call "<script>try{parent.d();}catch(e){}</script>\n</body></html>\n"
|
63
|
+
end
|
64
|
+
succeed
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
def each &blk
|
69
|
+
@body_callback = blk
|
70
|
+
end
|
71
|
+
|
72
|
+
def call chunk
|
73
|
+
if @html_data_type
|
74
|
+
@body_callback.call "<script>try{parent.m(#{chunk.dump});}catch(e){}</script>\n"
|
75
|
+
else
|
76
|
+
@body_callback.call chunk
|
77
|
+
end
|
78
|
+
end
|
79
|
+
|
80
|
+
end
|
metadata
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: browserchannel
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- David Turnbull
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2011-08-05 00:00:00.000000000 -07:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: thin
|
17
|
+
requirement: &2152966860 !ruby/object:Gem::Requirement
|
18
|
+
none: false
|
19
|
+
requirements:
|
20
|
+
- - ! '>='
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: '0'
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: *2152966860
|
26
|
+
description:
|
27
|
+
email:
|
28
|
+
- dturnbull@gmail.com
|
29
|
+
executables: []
|
30
|
+
extensions: []
|
31
|
+
extra_rdoc_files: []
|
32
|
+
files:
|
33
|
+
- lib/browser_channel.rb
|
34
|
+
- lib/browser_test_channel.rb
|
35
|
+
- LICENSE
|
36
|
+
- README.md
|
37
|
+
has_rdoc: true
|
38
|
+
homepage: https://github.com/dturnbull/browserchannel
|
39
|
+
licenses: []
|
40
|
+
post_install_message:
|
41
|
+
rdoc_options: []
|
42
|
+
require_paths:
|
43
|
+
- lib
|
44
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
45
|
+
none: false
|
46
|
+
requirements:
|
47
|
+
- - ! '>='
|
48
|
+
- !ruby/object:Gem::Version
|
49
|
+
version: '0'
|
50
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
51
|
+
none: false
|
52
|
+
requirements:
|
53
|
+
- - ! '>='
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
requirements: []
|
57
|
+
rubyforge_project:
|
58
|
+
rubygems_version: 1.6.2
|
59
|
+
signing_key:
|
60
|
+
specification_version: 3
|
61
|
+
summary: An event-driven server for Google Closure Library's goog.BrowserChannel class
|
62
|
+
test_files: []
|