Class: Faye::Server

Inherits:
Object
  • Object
show all
Includes:
Extensible, Logging
Defined in:
lib/faye/protocol/server.rb

Constant Summary collapse

META_METHODS = 
%w[handshake connect disconnect subscribe unsubscribe]

Constants included from Logging

Logging::DEFAULT_LOG_LEVEL, Logging::LOG_LEVELS

Instance Attribute Summary collapse

Attributes included from Logging

#log_level

Instance Method Summary collapse

Methods included from Extensible

#add_extension, #pipe_through_extensions, #remove_extension

Methods included from Logging

#log

Constructor Details

#initialize(options = {}) ⇒ Server

Returns a new instance of Server.



11
12
13
14
15
16
17
18
 
# File 'lib/faye/protocol/server.rb', line 11

def initialize(options = {})
  @options    = options || {}
  engine_opts = @options[:engine] || {}
  engine_opts[:timeout] = @options[:timeout]
  @engine     = Faye::Engine.get(engine_opts)

  info 'Created new server: ?', @options
end

Instance Attribute Details

#engine ⇒ Object (readonly)

Returns the value of attribute engine.



9
10
11
 
# File 'lib/faye/protocol/server.rb', line 9

def engine
  @engine
end

Instance Method Details

#advize(response) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/faye/protocol/server.rb', line 111

def advize(response)
  return unless [Channel::HANDSHAKE, Channel::CONNECT].include?(response['channel'])
  
  advice = response['advice'] ||= {}
  if response['error']
    advice['reconnect'] ||= 'handshake'
  else
    advice['reconnect'] ||= 'retry'
    advice['interval']  ||= (@engine.interval * 1000).floor
    advice['timeout']   ||= (@engine.timeout * 1000).floor
  end
end

#connect(message, local = false, &callback) ⇒ Object

MUST contain * clientId

* connectionType

MAY contain * ext

* id



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
 
# File 'lib/faye/protocol/server.rb', line 159

def connect(message, local = false, &callback)
  response        = make_response(message)
  client_id       = message['clientId']
  connection_type = message['connectionType']
  
  @engine.client_exists(client_id) do |exists|
    response['error'] = Error.client_unknown(client_id) unless exists
    response['error'] = Error.parameter_missing('clientId') if client_id.nil?
    
    unless CONNECTION_TYPES.include?(connection_type)
      response['error'] = Error.conntype_mismatch(connection_type)
    end
    
    response['error'] = Error.parameter_missing('connectionType') if connection_type.nil?
    
    response['successful'] = response['error'].nil?
    
    if response['successful']
      @engine.connect(response['clientId'], message['advice']) do |events|
        callback.call([response] + events)
      end
    else
      response.delete('clientId')
      callback.call(response)
    end
  end
end

#disconnect(message, local = false, &callback) ⇒ Object

MUST contain * clientId MAY contain * ext

* id



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/faye/protocol/server.rb', line 190

def disconnect(message, local = false, &callback)
  response   = make_response(message)      
  client_id  = message['clientId']
  
  @engine.client_exists(client_id) do |exists|
    response['error'] = Error.client_unknown(client_id) unless exists
    response['error'] = Error.parameter_missing('clientId') if client_id.nil?
    
    response['successful'] = response['error'].nil?
    response.delete('clientId') unless response['successful']
    
    @engine.destroy_client(client_id) if response['successful']
    callback.call(response)
  end
end

#flush_connection(messages) ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/faye/protocol/server.rb', line 20

def flush_connection(messages)
  [messages].flatten.each do |message|
    client_id = message["clientId"]
    info 'Flushing connection for ?', client_id
    @engine.flush(client_id) if client_id
  end
end

#handle(message, local = false, &callback) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/faye/protocol/server.rb', line 75

def handle(message, local = false, &callback)
  return callback.call([]) if !message
  info 'Handling message: ? (local: ?)', message, local
  
  channel_name = message['channel']
  
  return handle_meta(message, local, &callback) if Channel.meta?(channel_name)
  
  @engine.publish(message) unless message['error'] or Grammar::CHANNEL_NAME !~ channel_name
  
  if message['clientId']
    response = make_response(message)
    response['successful'] = !response['error']
    callback.call([response])
  else
    callback.call([])
  end
end

#handle_meta(message, local, &callback) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/faye/protocol/server.rb', line 94

def handle_meta(message, local, &callback)
  method = Channel.parse(message['channel'])[1]
  
  unless META_METHODS.include?(method)
    response = make_response(message)
    response['error'] = Faye::Error.channel_forbidden(message['channel'])
    response['successful'] = false
    return callback.call([response])
  end

  __send__(method, message, local) do |responses|
    responses = [responses].flatten
    responses.each(&method(:advize))
    callback.call(responses)
  end
end

#handshake(message, local = false, &callback) ⇒ Object

MUST contain * version

* supportedConnectionTypes

MAY contain * minimumVersion

* ext
* id



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
 
# File 'lib/faye/protocol/server.rb', line 129

def handshake(message, local = false, &callback)
  response = make_response(message)
  response['version'] = BAYEUX_VERSION
  
  response['error'] = Error.parameter_missing('version') if message['version'].nil?
  
  client_conns = message['supportedConnectionTypes']
  
  response['supportedConnectionTypes'] = CONNECTION_TYPES
  
  if client_conns
    common_conns = client_conns.select { |c| CONNECTION_TYPES.include?(c) }
    response['error'] = Error.conntype_mismatch(*client_conns) if common_conns.empty?
  else
    response['error'] = Error.parameter_missing('supportedConnectionTypes')
  end
  
  response['successful'] = response['error'].nil?
  return callback.call(response) unless response['successful']
  
  @engine.create_client do |client_id|
    response['clientId'] = client_id
    callback.call(response)
  end
end

#make_response(message) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/faye/protocol/server.rb', line 64

def make_response(message)
  response = {}
  %w[id clientId channel error].each do |field|
    if message[field]
      response[field] = message[field]
    end
  end
  response['successful'] = !response['error']
  response
end

#process(messages, local = false, &callback) ⇒ Object 



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
 
# File 'lib/faye/protocol/server.rb', line 28

def process(messages, local = false, &callback)
  messages = [messages].flatten
  info 'Processing messages: ? (local: ?)', messages, local

  return callback.call([]) if messages.size == 0
  processed, responses = 0, []
  
  gather_replies = lambda do |replies|
    responses.concat(replies)
    processed += 1
    responses.compact!
    info 'Returning replies: ?', responses
    callback.call(responses) if processed == messages.size
  end
  
  handle_reply = lambda do |replies|
    extended, expected = 0, replies.size
    gather_replies.call(replies) if expected == 0
    
    replies.each_with_index do |reply, i|
      debug 'Processing reply: ?', reply
      pipe_through_extensions(:outgoing, reply) do |message|
        replies[i] = message
        extended  += 1
        gather_replies.call(replies) if extended == expected
      end
    end
  end
  
  messages.each do |message|
    pipe_through_extensions(:incoming, message) do |piped_message|
      handle(piped_message, local, &handle_reply)
    end
  end
end

#subscribe(message, local = false, &callback) ⇒ Object

MUST contain * clientId

* subscription

MAY contain * ext

* id



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
 
# File 'lib/faye/protocol/server.rb', line 210

def subscribe(message, local = false, &callback)
  response     = make_response(message)
  client_id    = message['clientId']
  subscription = [message['subscription']].flatten
  
  @engine.client_exists(client_id) do |exists|
    response['error'] = Error.client_unknown(client_id) unless exists
    response['error'] = Error.parameter_missing('clientId') if client_id.nil?
    response['error'] = Error.parameter_missing('subscription') if message['subscription'].nil?
    
    response['subscription'] = message['subscription'] || []
    
    subscription.each do |channel|
      next if response['error']
      response['error'] = Error.channel_forbidden(channel) unless local or Channel.subscribable?(channel)
      response['error'] = Error.channel_invalid(channel) unless Channel.valid?(channel)
      
      next if response['error']
      @engine.subscribe(client_id, channel)
    end
    
    response['successful'] = response['error'].nil?
    callback.call(response)
  end
end

#unsubscribe(message, local = false, &callback) ⇒ Object

MUST contain * clientId

* subscription

MAY contain * ext

* id



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
 
# File 'lib/faye/protocol/server.rb', line 240

def unsubscribe(message, local = false, &callback)
  response     = make_response(message)
  client_id    = message['clientId']
  subscription = [message['subscription']].flatten
  
  @engine.client_exists(client_id) do |exists|
    response['error'] = Error.client_unknown(client_id) unless exists
    response['error'] = Error.parameter_missing('clientId') if client_id.nil?
    response['error'] = Error.parameter_missing('subscription') if message['subscription'].nil?
    
    response['subscription'] = message['subscription'] || []
    
    subscription.each do |channel|
      next if response['error']
      response['error'] = Error.channel_forbidden(channel) unless local or Channel.subscribable?(channel)
      response['error'] = Error.channel_invalid(channel) unless Channel.valid?(channel)
      
      next if response['error']
      @engine.unsubscribe(client_id, channel)
    end
    
    response['successful'] = response['error'].nil?
    callback.call(response)
  end
end