module Faye::WebSocket::API

Constants

CLOSED
CLOSING
CONNECTING
OPEN
TYPES

Attributes

buffered_amount[R]
ready_state[R]
url[R]

Public Class Methods

new(options = {}) { || ... } click to toggle source
Calls superclass method
# File lib/faye/websocket/api.rb, line 20
def initialize(options = {})
  @ready_state = CONNECTING
  super()
  ::WebSocket::Driver.validate_options(options, [:headers, :extensions, :max_length, :ping, :proxy, :tls])

  @driver = yield

  if headers = options[:headers]
    headers.each { |name, value| @driver.set_header(name, value) }
  end

  [*options[:extensions]].each do |extension|
    @driver.add_extension(extension)
  end

  @ping            = options[:ping]
  @ping_id         = 0
  @buffered_amount = 0

  @close_params = @ping_timer = @proxy = @stream = nil
  @onopen = @onmessage = @onclose = @onerror = nil

  @driver.on(:open)    { |e| open }
  @driver.on(:message) { |e| receive_message(e.data) }
  @driver.on(:close)   { |e| begin_close(e.reason, e.code) }

  @driver.on(:error) do |error|
    emit_error(error.message)
  end

  if @ping
    @ping_timer = EventMachine.add_periodic_timer(@ping) do
      @ping_id += 1
      ping(@ping_id.to_s)
    end
  end
end

Public Instance Methods

close(code = nil, reason = nil) click to toggle source
# File lib/faye/websocket/api.rb, line 77
def close(code = nil, reason = nil)
  code   ||= 1000
  reason ||= ''

  unless code == 1000 or (code >= 3000 and code <= 4999)
    raise ArgumentError, "Failed to execute 'close' on WebSocket: " +
                         "The code must be either 1000, or between 3000 and 4999. " +
                         "#{code} is neither."
  end

  @ready_state = CLOSING unless @ready_state == CLOSED
  @driver.close(reason, code)
end
ping(message = '', &callback) click to toggle source
# File lib/faye/websocket/api.rb, line 72
def ping(message = '', &callback)
  return false if @ready_state > OPEN
  @driver.ping(message, &callback)
end
protocol() click to toggle source
# File lib/faye/websocket/api.rb, line 91
def protocol
  @driver.protocol || ''
end
send(message) click to toggle source
# File lib/faye/websocket/api.rb, line 62
def send(message)
  return false if @ready_state > OPEN
  case message
    when Numeric then @driver.text(message.to_s)
    when String  then @driver.text(message)
    when Array   then @driver.binary(message)
    else false
  end
end
write(data) click to toggle source
# File lib/faye/websocket/api.rb, line 58
def write(data)
  @stream.write(data)
end

Private Instance Methods

begin_close(reason, code) click to toggle source
# File lib/faye/websocket/api.rb, line 120
def begin_close(reason, code)
  return if @ready_state == CLOSED
  @ready_state = CLOSING
  @close_params = [reason, code]

  if @stream
    @stream.close_connection_after_writing
  else
    finalize_close
  end
end
emit_error(message) click to toggle source
# File lib/faye/websocket/api.rb, line 112
def emit_error(message)
  return if @ready_state >= CLOSING

  event = Event.create('error', :message => message)
  event.init_event('error', false, false)
  dispatch_event(event)
end
finalize_close() click to toggle source
# File lib/faye/websocket/api.rb, line 132
def finalize_close
  return if @ready_state == CLOSED
  @ready_state = CLOSED

  EventMachine.cancel_timer(@ping_timer) if @ping_timer

  reason = @close_params ? @close_params[0] : ''
  code   = @close_params ? @close_params[1] : 1006

  event = Event.create('close', :code => code, :reason => reason)
  event.init_event('close', false, false)
  dispatch_event(event)
end
open() click to toggle source
# File lib/faye/websocket/api.rb, line 97
def open
  return unless @ready_state == CONNECTING
  @ready_state = OPEN
  event = Event.create('open')
  event.init_event('open', false, false)
  dispatch_event(event)
end
parse(data) click to toggle source
# File lib/faye/websocket/api.rb, line 146
def parse(data)
  worker = @proxy || @driver
  worker.parse(data)
end
receive_message(data) click to toggle source
# File lib/faye/websocket/api.rb, line 105
def receive_message(data)
  return unless @ready_state == OPEN
  event = Event.create('message', :data => data)
  event.init_event('message', false, false)
  dispatch_event(event)
end