Class: WebSocket::Driver

Inherits:
Object
  • Object
show all
Includes:
EventEmitter
Defined in:
lib/websocket/driver.rb,
lib/websocket/driver/hybi.rb,
lib/websocket/driver/proxy.rb,
lib/websocket/driver/client.rb,
lib/websocket/driver/server.rb,
lib/websocket/driver/draft75.rb,
lib/websocket/driver/draft76.rb,
lib/websocket/driver/headers.rb,
lib/websocket/driver/hybi/frame.rb,
lib/websocket/driver/hybi/message.rb,
lib/websocket/driver/event_emitter.rb,
lib/websocket/driver/stream_reader.rb

Direct Known Subclasses

Draft75, Hybi, Server

Defined Under Namespace

Modules: EventEmitter Classes: Client, CloseEvent, ConnectEvent, Draft75, Draft76, Headers, Hybi, MessageEvent, OpenEvent, PingEvent, PongEvent, Proxy, Server, StreamReader

Constant Summary collapse

MAX_LENGTH =
0x3ffffff
STATES =
[:connecting, :open, :closing, :closed]
BINARY =
'ASCII-8BIT'
UNICODE =
'UTF-8'
ProtocolError =
Class.new(StandardError)
URIError =
Class.new(ArgumentError)
ConfigurationError =
Class.new(ArgumentError)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from EventEmitter

#add_listener, #emit, #listener_count, #listeners, #on, #remove_all_listeners, #remove_listener

Constructor Details

#initialize(socket, options = {}) ⇒ Driver

Returns a new instance of Driver.


74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/websocket/driver.rb', line 74

def initialize(socket, options = {})
  super()
  Driver.validate_options(options, [:max_length, :masking, :require_masking, :protocols])

  @socket      = socket
  @reader      = StreamReader.new
  @options     = options
  @max_length  = options[:max_length] || MAX_LENGTH
  @headers     = Headers.new
  @queue       = []
  @ready_state = 0
end

Instance Attribute Details

#protocolObject (readonly)

Returns the value of attribute protocol


72
73
74
# File 'lib/websocket/driver.rb', line 72

def protocol
  @protocol
end

#ready_stateObject (readonly)

Returns the value of attribute ready_state


72
73
74
# File 'lib/websocket/driver.rb', line 72

def ready_state
  @ready_state
end

Instance Method Details

#add_extension(extension) ⇒ Object


92
93
94
# File 'lib/websocket/driver.rb', line 92

def add_extension(extension)
  false
end

#binary(message) ⇒ Object


125
126
127
# File 'lib/websocket/driver.rb', line 125

def binary(message)
  false
end

#close(reason = nil, code = nil) ⇒ Object


137
138
139
140
141
142
# File 'lib/websocket/driver.rb', line 137

def close(reason = nil, code = nil)
  return false unless @ready_state == 1
  @ready_state = 3
  emit(:close, CloseEvent.new(nil, nil))
  true
end

#ping(*args) ⇒ Object


129
130
131
# File 'lib/websocket/driver.rb', line 129

def ping(*args)
  false
end

#pong(*args) ⇒ Object


133
134
135
# File 'lib/websocket/driver.rb', line 133

def pong(*args)
  false
end

#set_header(name, value) ⇒ Object


96
97
98
99
100
# File 'lib/websocket/driver.rb', line 96

def set_header(name, value)
  return false unless @ready_state <= 0
  @headers[name] = value
  true
end

#startObject


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/websocket/driver.rb', line 102

def start
  return false unless @ready_state == 0

  unless Driver.websocket?(@socket.env)
    return fail_handshake(ProtocolError.new('Not a WebSocket request'))
  end

  begin
    response = handshake_response
  rescue => error
    return fail_handshake(error)
  end

  @socket.write(response)
  open unless @stage == -1
  true
end

#stateObject


87
88
89
90
# File 'lib/websocket/driver.rb', line 87

def state
  return nil unless @ready_state >= 0
  STATES[@ready_state]
end

#text(message) ⇒ Object


120
121
122
123
# File 'lib/websocket/driver.rb', line 120

def text(message)
  message = message.encode(UNICODE) unless message.encoding.name == UNICODE
  frame(message, :text)
end