Class: MqttRails::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/mqtt_rails/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client.



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
 
# File 'lib/mqtt_rails/client.rb', line 52

def initialize(*args)
  @last_packet_id         = 0
  @ssl_context            = nil
  @sender                 = nil
  @handler                = Handler.new
  @connection_helper      = nil
  @connection_state       = MQTT_CS_DISCONNECT
  @connection_state_mutex = Mutex.new
  @mqtt_thread            = nil
  @reconnect_thread       = nil
  @id_mutex               = Mutex.new
  @reconnect_limit        = 3
  @reconnect_delay        = 5

  if args.last.is_a?(Hash)
    attr = args.pop
  else
    attr = {}
  end

  CLIENT_ATTR_DEFAULTS.merge(attr).each_pair do |k,v|
    self.send("#{k}=", v)
  end

  if @ssl
    @ssl_context = OpenSSL::SSL::SSLContext.new
  end

  if @port.nil?
    if @ssl
      @port = DEFAULT_SSL_PORT
    else
      @port = DEFAULT_PORT
    end
  end

  if  @client_id.nil? || @client_id == ""
    @client_id = generate_client_id
  end
end

Instance Attribute Details

#ack_timeout ⇒ Object

Returns the value of attribute ack_timeout.



46
47
48
 
# File 'lib/mqtt_rails/client.rb', line 46

def ack_timeout
  @ack_timeout
end

#blocking ⇒ Object

Returns the value of attribute blocking.



32
33
34
 
# File 'lib/mqtt_rails/client.rb', line 32

def blocking
  @blocking
end

#clean_session ⇒ Object

Returns the value of attribute clean_session.



28
29
30
 
# File 'lib/mqtt_rails/client.rb', line 28

def clean_session
  @clean_session
end

#client_id ⇒ Object

Returns the value of attribute client_id.



33
34
35
 
# File 'lib/mqtt_rails/client.rb', line 33

def client_id
  @client_id
end

#connection_state ⇒ Object (readonly)

Read Only attribute



49
50
51
 
# File 'lib/mqtt_rails/client.rb', line 49

def connection_state
  @connection_state
end

#host ⇒ Object

Connection related attributes:



25
26
27
 
# File 'lib/mqtt_rails/client.rb', line 25

def host
  @host
end

#keep_alive ⇒ Object

Timeout attributes:



45
46
47
 
# File 'lib/mqtt_rails/client.rb', line 45

def keep_alive
  @keep_alive
end

#mqtt_version ⇒ Object

Returns the value of attribute mqtt_version.



27
28
29
 
# File 'lib/mqtt_rails/client.rb', line 27

def mqtt_version
  @mqtt_version
end

#password ⇒ Object

Returns the value of attribute password.



35
36
37
 
# File 'lib/mqtt_rails/client.rb', line 35

def password
  @password
end

#persistent ⇒ Object

Returns the value of attribute persistent.



29
30
31
 
# File 'lib/mqtt_rails/client.rb', line 29

def persistent
  @persistent
end

#port ⇒ Object

Returns the value of attribute port.



26
27
28
 
# File 'lib/mqtt_rails/client.rb', line 26

def port
  @port
end

#reconnect_delay ⇒ Object

Returns the value of attribute reconnect_delay.



31
32
33
 
# File 'lib/mqtt_rails/client.rb', line 31

def reconnect_delay
  @reconnect_delay
end

#reconnect_limit ⇒ Object

Returns the value of attribute reconnect_limit.



30
31
32
 
# File 'lib/mqtt_rails/client.rb', line 30

def reconnect_limit
  @reconnect_limit
end

#ssl ⇒ Object

Returns the value of attribute ssl.



36
37
38
 
# File 'lib/mqtt_rails/client.rb', line 36

def ssl
  @ssl
end

#ssl_context ⇒ Object (readonly)

Returns the value of attribute ssl_context.



50
51
52
 
# File 'lib/mqtt_rails/client.rb', line 50

def ssl_context
  @ssl_context
end

#username ⇒ Object

Returns the value of attribute username.



34
35
36
 
# File 'lib/mqtt_rails/client.rb', line 34

def username
  @username
end

#will_payload ⇒ Object

Returns the value of attribute will_payload.



40
41
42
 
# File 'lib/mqtt_rails/client.rb', line 40

def will_payload
  @will_payload
end

#will_qos ⇒ Object

Returns the value of attribute will_qos.



41
42
43
 
# File 'lib/mqtt_rails/client.rb', line 41

def will_qos
  @will_qos
end

#will_retain ⇒ Object

Returns the value of attribute will_retain.



42
43
44
 
# File 'lib/mqtt_rails/client.rb', line 42

def will_retain
  @will_retain
end

#will_topic ⇒ Object

Last will attributes:



39
40
41
 
# File 'lib/mqtt_rails/client.rb', line 39

def will_topic
  @will_topic
end

Instance Method Details

#add_topic_callback(topic, callback = nil, &block) ⇒ Object 



268
269
270
 
# File 'lib/mqtt_rails/client.rb', line 268

def add_topic_callback(topic, callback=nil, &block)
  @handler.register_topic_callback(topic, callback, &block)
end

#config_ssl_context(cert_path, key_path, ca_path = nil) ⇒ Object 



98
99
100
101
 
# File 'lib/mqtt_rails/client.rb', line 98

def config_ssl_context(cert_path, key_path, ca_path=nil)
  @ssl ||= true
  @ssl_context = SSLHelper.config_ssl_context(cert_path, key_path, ca_path)
end

#connect(host = @host, port = @port, keep_alive = @keep_alive, persistent = @persistent, blocking = @blocking) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/mqtt_rails/client.rb', line 103

def connect(host=@host, port=@port, keep_alive=@keep_alive, persistent=@persistent, blocking=@blocking)
  @persistent = persistent
  @blocking   = blocking
  @host       = host
  @port       = port.to_i
  @keep_alive = keep_alive
  @connection_state_mutex.synchronize do
    @connection_state = MQTT_CS_NEW
  end
  @mqtt_thread.kill unless @mqtt_thread.nil?

  init_connection unless reconnect?
  @connection_helper.send_connect(session_params)
  begin
    init_pubsub
    @connection_state = @connection_helper.do_connect(reconnect?)
    if connected?
      build_pubsub
      daemon_mode unless @blocking
    end
  rescue LowVersionException
    downgrade_version
  end
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/mqtt_rails/client.rb', line 145

def connected?
  @connection_state == MQTT_CS_CONNECTED
end

#daemon_mode ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/mqtt_rails/client.rb', line 128

def daemon_mode
  @mqtt_thread = Thread.new do
    @reconnect_thread.kill unless @reconnect_thread.nil? || !@reconnect_thread.alive?
    begin
      while connected? do
        mqtt_loop
      end
    rescue SystemCallError => e
      if @persistent
        reconnect
      else
        raise e
      end
    end
  end
end

#disconnect(explicit = true) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/mqtt_rails/client.rb', line 217

def disconnect(explicit=true)
  @connection_helper.do_disconnect(@publisher, explicit, @mqtt_thread)
  @connection_state_mutex.synchronize do
    @connection_state = MQTT_CS_DISCONNECT
  end
  if explicit && @clean_session
    @last_packet_id = 0
    @subscriber.clear_queue
  end
  MQTT_ERR_SUCCESS
end

#generate_client_id(prefix = 'paho_ruby', lenght = 16) ⇒ Object 



93
94
95
96
 
# File 'lib/mqtt_rails/client.rb', line 93

def generate_client_id(prefix='paho_ruby', lenght=16)
  charset = Array('A'..'Z') + Array('a'..'z') + Array('0'..'9')
  @client_id = prefix << Array.new(lenght) { charset.sample }.join
end

#loop_misc ⇒ Object 



188
189
190
191
192
193
194
195
 
# File 'lib/mqtt_rails/client.rb', line 188

def loop_misc
  if @connection_helper.check_keep_alive(@persistent, @keep_alive) == MQTT_CS_DISCONNECT
    reconnect if check_persistence
  end
  @publisher.check_waiting_publisher
  @subscriber.check_waiting_subscriber
  sleep SELECT_TIMEOUT
end

#loop_read ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/mqtt_rails/client.rb', line 165

def loop_read
  begin
    MAX_QUEUE.times do
      result = @handler.receive_packet
      break if result.nil?
    end
  rescue FullQueueException
    Rails.logger.warn("[MQTT RAILS][WARNING] Early exit in reading loop. The maximum packets have been reach for #{packet.type_name}")
  rescue ReadingException
    if check_persistence
      reconnect
    else
      raise ReadingException
    end
  end
end

#loop_write ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/mqtt_rails/client.rb', line 153

def loop_write
  begin
    @sender.writing_loop
  rescue WritingException
    if check_persistence
      reconnect
    else
      raise WritingException
    end
  end
end

#mqtt_loop ⇒ Object 



182
183
184
185
186
 
# File 'lib/mqtt_rails/client.rb', line 182

def mqtt_loop
  loop_read
  loop_write
  loop_misc
end

#on_connack(&block) ⇒ Object 



276
277
278
279
 
# File 'lib/mqtt_rails/client.rb', line 276

def on_connack(&block)
  @handler.on_connack = block if block_given?
  @handler.on_connack
end

#on_connack=(callback) ⇒ Object 



316
317
318
 
# File 'lib/mqtt_rails/client.rb', line 316

def on_connack=(callback)
  @handler.on_connack = callback if callback.is_a?(Proc)
end

#on_message(&block) ⇒ Object 



311
312
313
314
 
# File 'lib/mqtt_rails/client.rb', line 311

def on_message(&block)
  @handler.on_message = block if block_given?
  @handler.on_message
end

#on_message=(callback) ⇒ Object 



344
345
346
 
# File 'lib/mqtt_rails/client.rb', line 344

def on_message=(callback)
  @handler.on_message = callback if callback.is_a?(Proc)
end

#on_puback(&block) ⇒ Object 



291
292
293
294
 
# File 'lib/mqtt_rails/client.rb', line 291

def on_puback(&block)
  @handler.on_puback = block if block_given?
  @handler.on_puback
end

#on_puback=(callback) ⇒ Object 



328
329
330
 
# File 'lib/mqtt_rails/client.rb', line 328

def on_puback=(callback)
  @handler.on_puback = callback if callback.is_a?(Proc)
end

#on_pubcomp(&block) ⇒ Object 



306
307
308
309
 
# File 'lib/mqtt_rails/client.rb', line 306

def on_pubcomp(&block)
  @handler.on_pubcomp = block if block_given?
  @handler.on_pubcomp
end

#on_pubcomp=(callback) ⇒ Object 



340
341
342
 
# File 'lib/mqtt_rails/client.rb', line 340

def on_pubcomp=(callback)
  @handler.on_pubcomp = callback if callback.is_a?(Proc)
end

#on_pubrec(&block) ⇒ Object 



296
297
298
299
 
# File 'lib/mqtt_rails/client.rb', line 296

def on_pubrec(&block)
  @handler.on_pubrec = block if block_given?
  @handler.on_pubrec
end

#on_pubrec=(callback) ⇒ Object 



332
333
334
 
# File 'lib/mqtt_rails/client.rb', line 332

def on_pubrec=(callback)
  @handler.on_pubrec = callback if callback.is_a?(Proc)
end

#on_pubrel(&block) ⇒ Object 



301
302
303
304
 
# File 'lib/mqtt_rails/client.rb', line 301

def on_pubrel(&block)
  @handler.on_pubrel = block if block_given?
  @handler.on_pubrel
end

#on_pubrel=(callback) ⇒ Object 



336
337
338
 
# File 'lib/mqtt_rails/client.rb', line 336

def on_pubrel=(callback)
  @handler.on_pubrel = callback if callback.is_a?(Proc)
end

#on_suback(&block) ⇒ Object 



281
282
283
284
 
# File 'lib/mqtt_rails/client.rb', line 281

def on_suback(&block)
  @handler.on_suback = block if block_given?
  @handler.on_suback
end

#on_suback=(callback) ⇒ Object 



320
321
322
 
# File 'lib/mqtt_rails/client.rb', line 320

def on_suback=(callback)
  @handler.on_suback = callback if callback.is_a?(Proc)
end

#on_unsuback(&block) ⇒ Object 



286
287
288
289
 
# File 'lib/mqtt_rails/client.rb', line 286

def on_unsuback(&block)
  @handler.on_unsuback = block if block_given?
  @handler.on_unsuback
end

#on_unsuback=(callback) ⇒ Object 



324
325
326
 
# File 'lib/mqtt_rails/client.rb', line 324

def on_unsuback=(callback)
  @handler.on_unsuback = callback if callback.is_a?(Proc)
end

#ping_host ⇒ Object 



264
265
266
 
# File 'lib/mqtt_rails/client.rb', line 264

def ping_host
  @sender.send_pingreq
end

#publish(topic, payload = "", retain = false, qos = 0) ⇒ Object 



229
230
231
232
233
234
235
236
 
# File 'lib/mqtt_rails/client.rb', line 229

def publish(topic, payload="", retain=false, qos=0)
  if topic == "" || !topic.is_a?(String)
    Rails.logger.error("[MQTT RAILS][ERROR] Publish topics is invalid, not a string or empty.")
    raise ArgumentError
  end
  id = next_packet_id
  @publisher.send_publish(topic, payload, retain, qos, id)
end

#reconnect ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/mqtt_rails/client.rb', line 197

def reconnect
  @reconnect_thread = Thread.new do
    counter = 0
    while (@reconnect_limit >= counter || @reconnect_limit == -1) do
      counter += 1
      Rails.logger.info("[MQTT RAILS][INFO] New reconnect attempt...")
      connect
      if connected?
        break
      else
        sleep @reconnect_delay
      end
    end
    unless connected?
      Rails.logger.error("[MQTT RAILS][ERROR] Reconnection attempt counter is over. (#{@reconnect_limit} times)")
      disconnect(false)
    end
  end
end

#reconnect? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/mqtt_rails/client.rb', line 149

def reconnect?
  Thread.current == @reconnect_thread
end

#registered_callback ⇒ Object 



348
349
350
 
# File 'lib/mqtt_rails/client.rb', line 348

def registered_callback
  @handler.registered_callback
end

#remove_topic_callback(topic) ⇒ Object 



272
273
274
 
# File 'lib/mqtt_rails/client.rb', line 272

def remove_topic_callback(topic)
  @handler.clear_topic_callback(topic)
end

#subscribe(*topics) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/mqtt_rails/client.rb', line 238

def subscribe(*topics)
  begin
    id = next_packet_id
    unless @subscriber.send_subscribe(topics, id) == MqttRails::MQTT_ERR_SUCCESS
      reconnect if check_persistence
    end
    MQTT_ERR_SUCCESS
  rescue ProtocolViolation
    Rails.logger.error("[MQTT RAILS][ERROR] Subscribe topics need one topic or a list of topics.")
    raise ProtocolViolation
  end
end

#subscribed_topics ⇒ Object 



352
353
354
 
# File 'lib/mqtt_rails/client.rb', line 352

def subscribed_topics
  @subscriber.subscribed_topics
end

#unsubscribe(*topics) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/mqtt_rails/client.rb', line 251

def unsubscribe(*topics)
  begin
    id = next_packet_id
    unless @subscriber.send_unsubscribe(topics, id) == MQTT_ERR_SUCCESS
      reconnect if check_persistence
    end
    MQTT_ERR_SUCCESS
  rescue ProtocolViolation
    Rails.logger.error("[MQTT RAILS][ERROR] Unsubscribe need at least one topic.")
    raise ProtocolViolation
  end
end