Class: WebSocket::EventMachine::Client

Inherits:
Base
  • Object
show all
Defined in:
lib/websocket/eventmachine/client.rb,
lib/websocket/eventmachine/client/version.rb

Overview

WebSocket Client (using EventMachine)

Examples:

ws = WebSocket::EventMachine::Client.connect(:host => "0.0.0.0", :port => 8080)
ws.onmessage { |msg| ws.send "Pong: #{msg}" }
ws.send "data"

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Client

Initialize connection

Parameters:

  • args (Hash) —

    Arguments for connection

Options Hash (args):

  • :host (String) —

    The host IP/DNS name

  • :port (Integer) —

    The port to connect too(default = 80)

  • :version (Integer) —

    Version of protocol to use(default = 13)



43
44
45
 
# File 'lib/websocket/eventmachine/client.rb', line 43

def initialize(args)
  @args = args
end

Class Method Details

.connect(args = {}) ⇒ Object

Connect to websocket server

Parameters:

  • args (Hash) (defaults to: {}) —

    The request arguments

Options Hash (args):

  • :host (String) —

    The host IP/DNS name

  • :port (Integer) —

    The port to connect too(default = 80)

  • :version (Integer) —

    Version of protocol to use(default = 13)



23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/websocket/eventmachine/client.rb', line 23

def self.connect(args = {})
  host = nil
  port = nil
  if args[:uri]
    uri = URI.parse(args[:uri])
    host = uri.host
    port = uri.port
  end
  host = args[:host] if args[:host]
  port = args[:port] if args[:port]
  port ||= 80

  ::EventMachine.connect host, port, self, args
end

Instance Method Details

#close(code = 1000, data = nil) ⇒ Boolean

Close connection

Returns:

  • (Boolean) —

    true if connection is closed immediately, false if waiting for other side to close connection



122
 
# File 'lib/websocket/eventmachine/client.rb', line 122

def close(code = 1000, data = nil); super; end

#connection_completed ⇒ Object

Called by EventMachine after connecting. Sends handshake to server Eventmachine internal



63
64
65
 
# File 'lib/websocket/eventmachine/client.rb', line 63

def connection_completed
  send(@handshake.to_s, :type => :plain)
end

#onclose(&blk) ⇒ Object

Called when connection is closed. No parameters are passed to block



89
 
# File 'lib/websocket/eventmachine/client.rb', line 89

def onclose(&blk); super; end

#onerror(&blk) ⇒ Object

Called when error occurs. One parameter passed to block:

error - string with error message



94
 
# File 'lib/websocket/eventmachine/client.rb', line 94

def onerror(&blk); super; end

#onmessage(&blk) ⇒ Object

Called when message is received. Two parameters passed to block:

message - string with received message
type - type of message. Valid values are :text and :binary



100
 
# File 'lib/websocket/eventmachine/client.rb', line 100

def onmessage(&blk); super; end

#onopen(&blk) ⇒ Object

Called when connection is opened. No parameters are passed to block



85
 
# File 'lib/websocket/eventmachine/client.rb', line 85

def onopen(&blk); super; end

#onping(&blk) ⇒ Object

Called when ping message is received One parameter passed to block:

message - string with ping message



105
 
# File 'lib/websocket/eventmachine/client.rb', line 105

def onping(&blk); super; end

#onpong(&blk) ⇒ Object

Called when pond message is received One parameter passed to block:

message - string with pong message



110
 
# File 'lib/websocket/eventmachine/client.rb', line 110

def onpong(&blk); super; end

#ping(data = '') ⇒ Boolean

Send ping message

Returns:

  • (Boolean) —

    false if protocol version is not supporting ping requests



126
 
# File 'lib/websocket/eventmachine/client.rb', line 126

def ping(data = ''); super; end

#pong(data = '') ⇒ Boolean

Send pong message

Returns:

  • (Boolean) —

    false if protocol version is not supporting pong requests



130
 
# File 'lib/websocket/eventmachine/client.rb', line 130

def pong(data = ''); super; end

#post_init ⇒ Object

Called after initialize of connection, but before connecting to server Eventmachine internal



54
55
56
57
 
# File 'lib/websocket/eventmachine/client.rb', line 54

def post_init
  @state = :connecting
  @handshake = WebSocket::Handshake::Client.new(@args)
end

#send(data, args = {}) ⇒ Boolean

Send data

Parameters:

  • data (String) —

    Data to send

  • args (Hash) (defaults to: {}) —

    Arguments for send

Options Hash (args):

  • :type (String) —

    Type of frame to send - available types are “text”, “binary”, “ping”, “pong” and “close”

  • :code (Integer) —

    Code for close frame

Returns:

  • (Boolean) —

    true if data was send, otherwise call on_error if needed



118
 
# File 'lib/websocket/eventmachine/client.rb', line 118

def send(data, args = {}); super; end