Class: Discordrb::Gateway

Inherits:
Object
  • Object
show all
Defined in:
lib/discordrb/gateway.rb

Overview

Client for the Discord gateway protocol

Constant Summary collapse

LARGE_THRESHOLD =

How many members there need to be in a server for it to count as "large"

100
GATEWAY_VERSION =

The version of the gateway that's supposed to be used.

6

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bot, token, shard_key = nil) ⇒ Gateway


146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/discordrb/gateway.rb', line 146

def initialize(bot, token, shard_key = nil)
  @token = token
  @bot = bot

  @shard_key = shard_key

  @getc_mutex = Mutex.new

  # Whether the connection to the gateway has succeeded yet
  @ws_success = false

  @check_heartbeat_acks = true
end

Instance Attribute Details

#check_heartbeat_ackstrue, false

Heartbeat ACKs are Discord's way of verifying on the client side whether the connection is still alive. If this is set to true (default value) the gateway client will use that functionality to detect zombie connections and reconnect in such a case; however it may lead to instability if there's some problem with the ACKs. If this occurs it can simply be set to false.


144
145
146
# File 'lib/discordrb/gateway.rb', line 144

def check_heartbeat_acks
  @check_heartbeat_acks
end

Instance Method Details

#heartbeatObject

Sends a heartbeat with the last received packet's seq (to acknowledge that we have received it and all packets before it), or if none have been received yet, with 0.

See Also:


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/discordrb/gateway.rb', line 237

def heartbeat
  if check_heartbeat_acks
    unless @last_heartbeat_acked
      # We're in a bad situation - apparently the last heartbeat wasn't acked, which means the connection is likely
      # a zombie. Reconnect
      LOGGER.warn('Last heartbeat was not acked, so this is a zombie connection! Reconnecting')

      # We can't send anything on zombie connections
      @pipe_broken = true
      reconnect
      return
    end

    @last_heartbeat_acked = false
  end

  send_heartbeat(@session ? @session.sequence : 0)
end

#identifyObject

Identifies to Discord with the default parameters.

See Also:


265
266
267
268
269
270
271
272
273
# File 'lib/discordrb/gateway.rb', line 265

def identify
  send_identify(@token, {
                  '$os': RUBY_PLATFORM,
                  '$browser': 'discordrb',
                  '$device': 'discordrb',
                  '$referrer': '',
                  '$referring_domain': ''
                }, true, 100, @shard_key)
end

#inject_error(e) ⇒ Object

Injects a terminal gateway error into the handler. Useful for testing the reconnect logic.


230
231
232
# File 'lib/discordrb/gateway.rb', line 230

def inject_error(e)
  handle_internal_close(e)
end

#inject_reconnect(url = nil) ⇒ Object

Injects a reconnect event (op 7) into the event processor, causing Discord to reconnect to the given gateway URL. If the URL is set to nil, it will reconnect and get an entirely new gateway URL. This method has not much use outside of testing and implementing highly custom reconnect logic.


210
211
212
213
214
215
216
217
218
# File 'lib/discordrb/gateway.rb', line 210

def inject_reconnect(url = nil)
  # When no URL is specified, the data should be nil, as is the case with Discord-sent packets.
  data = url ? { url: url } : nil

  handle_message({
    op: Opcodes::RECONNECT,
    d: data
  }.to_json)
end

#inject_resume(seq) ⇒ Object

Injects a resume packet (op 6) into the gateway. If this is done with a running connection, it will cause an error. It has no use outside of testing stuff that I know of, but if you want to use it anyway for some reason, here it is.


224
225
226
# File 'lib/discordrb/gateway.rb', line 224

def inject_resume(seq)
  send_resume(raw_token, @session_id, seq || @sequence)
end

#killObject

Kills the websocket thread, stopping all connections to Discord.


196
197
198
# File 'lib/discordrb/gateway.rb', line 196

def kill
  @ws_thread.kill
end

#notify_readyObject

Notifies the #run_async method that everything is ready and the caller can now continue (i.e. with syncing, or with doing processing and then syncing)


202
203
204
# File 'lib/discordrb/gateway.rb', line 202

def notify_ready
  @ws_success = true
end

#open?Boolean

Whether the WebSocket connection to the gateway is currently open


179
180
181
# File 'lib/discordrb/gateway.rb', line 179

def open?
  @handshake && @handshake.finished? && !@closed
end

#reconnect(attempt_resume = true) ⇒ Object

Reconnects the gateway connection in a controlled manner.


352
353
354
355
356
357
358
359
# File 'lib/discordrb/gateway.rb', line 352

def reconnect(attempt_resume = true)
  @session.suspend if @session && attempt_resume

  @instant_reconnect = true
  @should_reconnect = true

  close
end

#resumeObject

Resumes the session from the last recorded point.

See Also:


346
347
348
# File 'lib/discordrb/gateway.rb', line 346

def resume
  send_resume(@token, @session.session_id, @session.sequence)
end

#run_asyncObject

Connect to the gateway server in a separate thread


161
162
163
164
165
166
167
168
169
170
171
# File 'lib/discordrb/gateway.rb', line 161

def run_async
  @ws_thread = Thread.new do
    Thread.current[:discordrb_name] = 'websocket'
    connect_loop
    LOGGER.warn('The WS loop exited! Not sure if this is a good thing')
  end

  LOGGER.debug('WS thread created! Now waiting for confirmation that everything worked')
  sleep(0.5) until @ws_success
  LOGGER.debug('Confirmation received! Exiting run.')
end

#send_heartbeat(sequence) ⇒ Object

Sends a heartbeat packet (op 1). This tells Discord that the current connection is still active and that the last packets until the given sequence have been processed (in case of a resume).


259
260
261
# File 'lib/discordrb/gateway.rb', line 259

def send_heartbeat(sequence)
  send_packet(Opcodes::HEARTBEAT, sequence)
end

#send_identify(token, properties, compress, large_threshold, shard_key = nil) ⇒ Object

Sends an identify packet (op 2). This starts a new session on the current connection and tells Discord who we are. This can only be done once a connection.


293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/discordrb/gateway.rb', line 293

def send_identify(token, properties, compress, large_threshold, shard_key = nil)
  data = {
    # Don't send a v anymore as it's entirely determined by the URL now
    token: token,
    properties: properties,
    compress: compress,
    large_threshold: large_threshold
  }

  # Don't include the shard key at all if it is nil as Discord checks for its mere existence
  data[:shard] = shard_key if shard_key

  send_packet(Opcodes::IDENTIFY, data)
end

#send_packet(op, packet) ⇒ Object

Sends a custom packet over the connection. This can be useful to implement future yet unimplemented functionality or for testing. You probably shouldn't use this unless you know what you're doing.


403
404
405
406
407
408
409
410
# File 'lib/discordrb/gateway.rb', line 403

def send_packet(op, packet)
  data = {
    op: op,
    d: packet
  }

  send(data.to_json)
end

#send_raw(data, type = :text) ⇒ Object

Sends custom raw data over the connection. Only useful for testing; even if you know what you're doing you probably want to use #send_packet instead.


417
418
419
# File 'lib/discordrb/gateway.rb', line 417

def send_raw(data, type = :text)
  send(data, type)
end

#send_request_members(server_id, query, limit) ⇒ Object

Sends a request members packet (op 8). This will order Discord to gradually sent all requested members as dispatch events with type GUILD_MEMBERS_CHUNK. It is necessary to use this method in order to get all members of a large server (see large_threshold in #send_identify), however it can also be used for other purposes.


388
389
390
391
392
393
394
395
396
# File 'lib/discordrb/gateway.rb', line 388

def send_request_members(server_id, query, limit)
  data = {
    guild_id: server_id,
    query: query,
    limit: limit
  }

  send_packet(Opcodes::REQUEST_MEMBERS, data)
end

#send_resume(token, session_id, seq) ⇒ Object

Sends a resume packet (op 6). This replays all events from a previous point specified by its packet sequence. This will not work if the packet to resume from has already been acknowledged using a heartbeat, or if the session ID belongs to a now invalid session.

If this packet is sent at the beginning of a connection, it will act similarly to an #identify in that it creates a session on the current connection. Unlike identify however, this packet can also be sent in an existing session and will just replay some of the events.


371
372
373
374
375
376
377
378
379
# File 'lib/discordrb/gateway.rb', line 371

def send_resume(token, session_id, seq)
  data = {
    token: token,
    session_id: session_id,
    seq: seq
  }

  send_packet(Opcodes::RESUME, data)
end

#send_status_update(status, since, game, afk) ⇒ Object

Sends a status update packet (op 3). This sets the bot user's status (online/idle/...) and game playing/streaming.


315
316
317
318
319
320
321
322
323
324
# File 'lib/discordrb/gateway.rb', line 315

def send_status_update(status, since, game, afk)
  data = {
    status: status,
    since: since,
    game: game,
    afk: afk
  }

  send_packet(Opcodes::PRESENCE, data)
end

#send_voice_state_update(server_id, channel_id, self_mute, self_deaf) ⇒ Object

Sends a voice state update packet (op 4). This packet can connect a user to a voice channel, update self mute/deaf status in an existing voice connection, move the user to a new voice channel on the same server or disconnect an existing voice connection.


333
334
335
336
337
338
339
340
341
342
# File 'lib/discordrb/gateway.rb', line 333

def send_voice_state_update(server_id, channel_id, self_mute, self_deaf)
  data = {
    guild_id: server_id,
    channel_id: channel_id,
    self_mute: self_mute,
    self_deaf: self_deaf
  }

  send_packet(Opcodes::VOICE_STATE, data)
end

#stop(no_sync = false) ⇒ Object

Stops the bot gracefully, disconnecting the websocket without immediately killing the thread. This means that Discord is immediately aware of the closed connection and makes the bot appear offline instantly.

If this method doesn't work or you're looking for something more drastic, use #kill instead.


187
188
189
190
191
192
193
# File 'lib/discordrb/gateway.rb', line 187

def stop(no_sync = false)
  @should_reconnect = false
  close(no_sync)

  # Return nil so command bots don't send a message
  nil
end

#syncObject

Prevents all further execution until the websocket thread stops (e.g. through a closed connection).


174
175
176
# File 'lib/discordrb/gateway.rb', line 174

def sync
  @ws_thread.join
end