Class: Discordrb::Session

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

Overview

This class stores the data of an active gateway session. Note that this is different from a websocket connection - there may be multiple sessions per connection or one session may persist over multiple connections.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session_id) ⇒ Session

Returns a new instance of Session.



95
96
97
98
99
100
# File 'lib/discordrb/gateway.rb', line 95

def initialize(session_id)
  @id = session_id
  @sequence = 0
  @suspended = false
  @invalid = false
end

Instance Attribute Details

#sequenceObject

Returns the value of attribute sequence.



93
94
95
# File 'lib/discordrb/gateway.rb', line 93

def sequence
  @sequence
end

#session_idObject (readonly)

Returns the value of attribute session_id.



92
93
94
# File 'lib/discordrb/gateway.rb', line 92

def session_id
  @session_id
end

Instance Method Details

#invalid?Boolean

Returns:

  • (Boolean)


114
115
116
# File 'lib/discordrb/gateway.rb', line 114

def invalid?
  @invalid
end

#invalidateObject



110
111
112
# File 'lib/discordrb/gateway.rb', line 110

def invalidate
  @invalid = true
end

#should_resume?Boolean

Returns:

  • (Boolean)


118
119
120
# File 'lib/discordrb/gateway.rb', line 118

def should_resume?
  suspended? && !invalid?
end

#suspendObject



102
103
104
# File 'lib/discordrb/gateway.rb', line 102

def suspend
  @suspended = true
end

#suspended?Boolean

Returns:

  • (Boolean)


106
107
108
# File 'lib/discordrb/gateway.rb', line 106

def suspended?
  @suspended
end