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.



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

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

Instance Attribute Details

#sequence ⇒ Object

Returns the value of attribute sequence.



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

def sequence
  @sequence
end

#session_id ⇒ Object (readonly)

Returns the value of attribute session_id.



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

def session_id
  @session_id
end

Instance Method Details

#invalid? ⇒ Boolean

Returns:

  • (Boolean) 


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

def invalid?
  @invalid
end

#invalidate ⇒ Object 



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

def invalidate
  @invalid = true
end

#resume ⇒ Object 



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

def resume
  @suspended = false
end

#should_resume? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/discordrb/gateway.rb', line 123

def should_resume?
  suspended? && !invalid?
end

#suspend ⇒ Object 



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

def suspend
  @suspended = true
end

#suspended? ⇒ Boolean

Returns:

  • (Boolean) 


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

def suspended?
  @suspended
end