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/hybi/stream_reader.rb

Direct Known Subclasses

Draft75, Hybi, Server

Defined Under Namespace

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

Constant Summary collapse

MAX_LENGTH =
0x3ffffff
STATES =
[:connecting, :open, :closing, :closed]
ProtocolError =
Class.new(StandardError)
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


63
64
65
66
67
68
69
70
71
72
73
# File 'lib/websocket/driver.rb', line 63

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

  @socket      = socket
  @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


61
62
63
# File 'lib/websocket/driver.rb', line 61

def protocol
  @protocol
end

#ready_stateObject (readonly)

Returns the value of attribute ready_state


61
62
63
# File 'lib/websocket/driver.rb', line 61

def ready_state
  @ready_state
end

Instance Method Details

#add_extension(extension) ⇒ Object


80
81
82
# File 'lib/websocket/driver.rb', line 80

def add_extension(extension)
  false
end

#binary(message) ⇒ Object


101
102
103
# File 'lib/websocket/driver.rb', line 101

def binary(message)
  false
end

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


109
110
111
112
113
114
# File 'lib/websocket/driver.rb', line 109

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


105
106
107
# File 'lib/websocket/driver.rb', line 105

def ping(*args)
  false
end

#set_header(name, value) ⇒ Object


84
85
86
87
88
# File 'lib/websocket/driver.rb', line 84

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

#startObject


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

def start
  return false unless @ready_state == 0
  @socket.write(Driver.encode(handshake_response, :binary))
  open unless @stage == -1
  true
end

#stateObject


75
76
77
78
# File 'lib/websocket/driver.rb', line 75

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

#text(message) ⇒ Object


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

def text(message)
  frame(message)
end