Class: Faye::Engine::Redis

Inherits:
Base
  • Object
show all
Defined in:
lib/faye/engines/redis.rb

Constant Summary collapse

DEFAULT_HOST = 
'localhost'
DEFAULT_PORT = 
6379
DEFAULT_DATABASE = 
0
DEFAULT_GC = 
60
LOCK_TIMEOUT = 
120

Constants included from Logging

Logging::DEFAULT_LOG_LEVEL, Logging::LOG_LEVELS

Instance Attribute Summary

Attributes inherited from Base

#interval, #timeout

Attributes included from Logging

#log_level

Instance Method Summary collapse

Methods inherited from Base

#close_connection, #connect, #connection, #flush, #initialize

Methods included from Logging

#log

Methods included from Publisher

#bind, #count_listeners, #trigger, #unbind

Constructor Details

This class inherits a constructor from Faye::Engine::Base

Instance Method Details

#client_exists(client_id, &callback) ⇒ Object 



92
93
94
95
96
97
 
# File 'lib/faye/engines/redis.rb', line 92

def client_exists(client_id, &callback)
  init
  @redis.zscore(@ns + '/clients', client_id) do |score|
    callback.call(score != nil)
  end
end

#create_client(&callback) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/faye/engines/redis.rb', line 51

def create_client(&callback)
  init
  client_id = Faye.random
  @redis.zadd(@ns + '/clients', 0, client_id) do |added|
    if added == 0
      create_client(&callback)
    else
      debug 'Created new client ?', client_id
      ping(client_id)
      callback.call(client_id)
      trigger(:handshake, client_id)
    end
  end
end

#destroy_client(client_id, &callback) ⇒ Object 



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
 
# File 'lib/faye/engines/redis.rb', line 66

def destroy_client(client_id, &callback)
  init
  @redis.zrem(@ns + '/clients', client_id)
  @redis.del(@ns + "/clients/#{client_id}/messages")
  
  @redis.smembers(@ns + "/clients/#{client_id}/channels") do |channels|
    n, i = channels.size, 0
    if n == 0
      debug 'Destroyed client ?', client_id
      callback.call if callback
      trigger(:disconnect, client_id)
    else
      channels.each do |channel|
        unsubscribe(client_id, channel) do
          i += 1
          if i == n
            debug 'Destroyed client ?', client_id
            callback.call if callback
            trigger(:disconnect, client_id)
          end
        end
      end
    end
  end
end

#disconnect ⇒ Object 



46
47
48
49
 
# File 'lib/faye/engines/redis.rb', line 46

def disconnect
  @subscriber.unsubscribe(@ns + '/notifications')
  EventMachine.cancel_timer(@gc)
end

#init ⇒ Object 



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
 
# File 'lib/faye/engines/redis.rb', line 11

def init
  return if @redis
  require 'em-hiredis'
  
  host   = @options[:host]      || DEFAULT_HOST
  port   = @options[:port]      || DEFAULT_PORT
  db     = @options[:database]  || 0
  auth   = @options[:password]
  gc     = @options[:gc]        || DEFAULT_GC
  @ns    = @options[:namespace] || ''
  socket = @options[:socket]
  
  if socket
    @redis      = EventMachine::Hiredis::Client.connect(socket, nil)
    @subscriber = EventMachine::Hiredis::Client.connect(socket, nil)
  else
    @redis      = EventMachine::Hiredis::Client.connect(host, port)
    @subscriber = EventMachine::Hiredis::Client.connect(host, port)
  end
  
  if auth
    @redis.auth(auth)
    @subscriber.auth(auth)
  end
  @redis.select(db)
  @subscriber.select(db)
  
  @subscriber.subscribe(@ns + '/notifications')
  @subscriber.on(:message) do |topic, message|
    empty_queue(message) if topic == @ns + '/notifications'
  end
  
  @gc = EventMachine.add_periodic_timer(gc, &method(:gc))
end

#ping(client_id) ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/faye/engines/redis.rb', line 99

def ping(client_id)
  init
  return unless Numeric === @timeout
  
  time = get_current_time
  debug 'Ping ?, ?', client_id, time
  @redis.zadd(@ns + '/clients', time, client_id)
end

#publish(message) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/faye/engines/redis.rb', line 130

def publish(message)
  init
  debug 'Publishing message ?', message
  
  json_message = JSON.dump(message)
  channels     = Channel.expand(message['channel'])
  keys         = channels.map { |c| @ns + "/channels#{c}" }
  
  @redis.sunion(*keys) do |clients|
    clients.each do |client_id|
      debug 'Queueing for client ?: ?', client_id, message
      @redis.rpush(@ns + "/clients/#{client_id}/messages", json_message)
      @redis.publish(@ns + '/notifications', client_id)
    end
  end
  
  trigger(:publish, message['clientId'], message['channel'], message['data'])
end

#subscribe(client_id, channel, &callback) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/faye/engines/redis.rb', line 108

def subscribe(client_id, channel, &callback)
  init
  @redis.sadd(@ns + "/clients/#{client_id}/channels", channel) do |added|
    trigger(:subscribe, client_id, channel) if added == 1
  end
  @redis.sadd(@ns + "/channels#{channel}", client_id) do
    debug 'Subscribed client ? to channel ?', client_id, channel
    callback.call if callback
  end
end

#unsubscribe(client_id, channel, &callback) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/faye/engines/redis.rb', line 119

def unsubscribe(client_id, channel, &callback)
  init
  @redis.srem(@ns + "/clients/#{client_id}/channels", channel) do |removed|
    trigger(:unsubscribe, client_id, channel) if removed == 1
  end
  @redis.srem(@ns + "/channels#{channel}", client_id) do
    debug 'Unsubscribed client ? from channel ?', client_id, channel
    callback.call if callback
  end
end