Class: Faye::Server

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

Defined Under Namespace

Classes: Socket

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.



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

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.



11
12
13
 
# File 'lib/faye/protocol/server.rb', line 11

def engine
  @engine
end

Instance Method Details

#advize(response, connection_type) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/faye/protocol/server.rb', line 123

def advize(response, connection_type)
  return unless [Channel::HANDSHAKE, Channel::CONNECT].include?(response['channel'])

  if connection_type == 'eventsource'
    interval = (@engine.timeout * 1000).floor
    timeout  = 0
  else
    interval = (@engine.interval * 1000).floor
    timeout  = (@engine.timeout * 1000).floor
  end

  advice = response['advice'] ||= {}
  if response['error']
    advice['reconnect'] ||= 'handshake'
  else
    advice['reconnect'] ||= 'retry'
    advice['interval']  ||= interval
    advice['timeout']   ||= timeout
  end
end

#close_socket(client_id) ⇒ Object 



32
33
34
 
# File 'lib/faye/protocol/server.rb', line 32

def close_socket(client_id)
  @engine.flush(client_id)
end

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

MUST contain * clientId

* connectionType

MAY contain * ext

* id



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

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']
      response.delete('clientId')
      next callback.call(response)
    end

    if message['connectionType'] == 'eventsource'
      message['advice'] ||= {}
      message['advice']['timeout'] = 0
    end

    @engine.connect(response['clientId'], message['advice']) do |events|
      callback.call([response] + events)
    end
  end
end

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

MUST contain * clientId MAY contain * ext

* id



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/faye/protocol/server.rb', line 215

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 



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

def flush_connection(messages)
  client_id = Faye.client_id_from_messages(messages)
  info 'Flushing connection for ?', client_id
  @engine.flush(client_id) if client_id
end

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/faye/protocol/server.rb', line 84

def handle(message, local = false, &callback)
  return callback.call([]) if !message
  info 'Handling message: ? (local: ?)', message, local

  channel_name = message['channel']
  error        = message['error']

  return handle_meta(message, local, &callback) if Channel.meta?(channel_name)

  if Grammar::CHANNEL_NAME !~ channel_name
    error = Faye::Error.channel_invalid(channel_name)
  end

  @engine.publish(message) unless error

  response = make_response(message)
  response['error'] = error if error
  response['successful'] = !response['error']
  callback.call([response])
end

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/faye/protocol/server.rb', line 105

def handle_meta(message, local, &callback)
  method    = Channel.parse(message['channel'])[1]
  client_id = message['clientId']

  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 { |r| advize(r, message['connectionType']) }
    callback.call(responses)
  end
end

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

MUST contain * version

* supportedConnectionTypes

MAY contain * minimumVersion

* ext
* id



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

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 



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/faye/protocol/server.rb', line 72

def make_response(message)
  response = {}

  response['id']       = message['id']       if message['id']
  response['clientId'] = message['clientId'] if message['clientId']
  response['channel']  = message['channel']  if message['channel']
  response['error']    = message['error']    if message['error']

  response['successful'] = !response['error']
  response
end

#open_socket(client_id, socket) ⇒ Object 



28
29
30
 
# File 'lib/faye/protocol/server.rb', line 28

def open_socket(client_id, socket)
  @engine.open_socket(client_id, Socket.new(self, socket))
end

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



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

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



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

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



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

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