Class: Tina4::WebSocketConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/tina4/websocket.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, socket, ws_server: nil, path: "/") ⇒ WebSocketConnection

Returns a new instance of WebSocketConnection.



230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/tina4/websocket.rb', line 230

def initialize(id, socket, ws_server: nil, path: "/")
  @id = id
  @socket = socket
  @params = {}
  @ws_server = ws_server
  @path = path
  @rooms = Set.new
  @on_message_handler = nil
  @on_close_handler = nil
  @on_error_handler = nil
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



227
228
229
 
# File 'lib/tina4/websocket.rb', line 227

def id
  @id
end

#on_close_handler ⇒ Object

Returns the value of attribute on_close_handler.



228
229
230
 
# File 'lib/tina4/websocket.rb', line 228

def on_close_handler
  @on_close_handler
end

#on_error_handler ⇒ Object

Returns the value of attribute on_error_handler.



228
229
230
 
# File 'lib/tina4/websocket.rb', line 228

def on_error_handler
  @on_error_handler
end

#on_message_handler ⇒ Object

Returns the value of attribute on_message_handler.



228
229
230
 
# File 'lib/tina4/websocket.rb', line 228

def on_message_handler
  @on_message_handler
end

#params ⇒ Object

Returns the value of attribute params.



228
229
230
 
# File 'lib/tina4/websocket.rb', line 228

def params
  @params
end

#path ⇒ Object

Returns the value of attribute path.



228
229
230
 
# File 'lib/tina4/websocket.rb', line 228

def path
  @path
end

#rooms ⇒ Object (readonly)

Returns the value of attribute rooms.



227
228
229
 
# File 'lib/tina4/websocket.rb', line 227

def rooms
  @rooms
end

Instance Method Details

#broadcast(message, include_self: false) ⇒ Object

Broadcast a message to all other connections on the same path



270
271
272
273
274
275
276
277
278
 
# File 'lib/tina4/websocket.rb', line 270

def broadcast(message, include_self: false)
  return unless @ws_server

  @ws_server.connections.each do |cid, conn|
    next if !include_self && cid == @id
    next if conn.path != @path
    conn.send_text(message)
  end
end

#broadcast_to_room(room_name, message, exclude_self: false) ⇒ Object 



262
263
264
265
266
267
 
# File 'lib/tina4/websocket.rb', line 262

def broadcast_to_room(room_name, message, exclude_self: false)
  return unless @ws_server

  exclude = exclude_self ? @id : nil
  @ws_server.broadcast_to_room(room_name, message, exclude: exclude)
end

#build_frame(opcode, data) ⇒ Object 



339
340
341
 
# File 'lib/tina4/websocket.rb', line 339

def build_frame(opcode, data)
  Tina4.build_frame(opcode, data)
end

#close(code: 1000, reason: "") ⇒ Object 



303
304
305
306
307
308
 
# File 'lib/tina4/websocket.rb', line 303

def close(code: 1000, reason: "")
  payload = [code].pack("n") + reason
  frame = build_frame(0x8, payload)
  @socket.write(frame) rescue nil
  @socket.close rescue nil
end

#join_room(room_name) ⇒ Object 



252
253
254
255
 
# File 'lib/tina4/websocket.rb', line 252

def join_room(room_name)
  @rooms.add(room_name)
  @ws_server&.join_room_for(@id, room_name)
end

#leave_room(room_name) ⇒ Object 



257
258
259
260
 
# File 'lib/tina4/websocket.rb', line 257

def leave_room(room_name)
  @rooms.delete(room_name)
  @ws_server&.leave_room_for(@id, room_name)
end

#on_close(&block) ⇒ Object

Register a close handler (decorator style, matching Python).



248
249
250
 
# File 'lib/tina4/websocket.rb', line 248

def on_close(&block)
  @on_close_handler = block
end

#on_message(&block) ⇒ Object

Register a message handler (decorator style, matching Python).



243
244
245
 
# File 'lib/tina4/websocket.rb', line 243

def on_message(&block)
  @on_message_handler = block
end

#read_frame ⇒ Object 



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/tina4/websocket.rb', line 310

def read_frame
  first_byte = @socket.getbyte
  return nil unless first_byte

  opcode = first_byte & 0x0F
  second_byte = @socket.getbyte
  return nil unless second_byte

  masked = (second_byte & 0x80) != 0
  length = second_byte & 0x7F

  if length == 126
    length = @socket.read(2).unpack1("n")
  elsif length == 127
    length = @socket.read(8).unpack1("Q>")
  end

  mask_key = masked ? @socket.read(4).bytes : nil
  data = @socket.read(length) || ""

  if masked && mask_key
    data = data.bytes.each_with_index.map { |b, i| b ^ mask_key[i % 4] }.pack("C*")
  end

  { opcode: opcode, data: data }
rescue IOError, EOFError
  nil
end

#send(message) ⇒ Object Also known as: send_text 



280
281
282
283
284
285
286
 
# File 'lib/tina4/websocket.rb', line 280

def send(message)
  data = message.encode("UTF-8")
  frame = build_frame(0x1, data)
  @socket.write(frame)
rescue IOError
  # Connection closed
end

#send_json(data) ⇒ Object

Serialize a Hash/Array (or any JSON-coercible value) and send as a text frame. Matches Python/PHP send_json.



292
293
294
 
# File 'lib/tina4/websocket.rb', line 292

def send_json(data)
  send_text(JSON.generate(data))
end

#send_pong(data) ⇒ Object 



296
297
298
299
300
301
 
# File 'lib/tina4/websocket.rb', line 296

def send_pong(data)
  frame = build_frame(0xA, data || "")
  @socket.write(frame)
rescue IOError
  # Connection closed
end