Class: Browser::Socket

Inherits:
Object show all
Includes:
Event::Target, IO::Writable, Native
Defined in:
opal/browser/socket.rb

Overview

A Socket allows the browser and a server to have a bidirectional data connection.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Event::Target

#off, #on, #on!, #trigger, #trigger!

Constructor Details

#initialize(url, protocol = nil) { ... } ⇒ Socket

Create a connection to the given URL, optionally using the given protocol.

Parameters:

  • url (String) —

    the URL to connect to

  • protocol (String) (defaults to: nil) —

    the protocol to use

Yields:

  • if the block has no parameters it's instance_execd, otherwise it's called with self



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'opal/browser/socket.rb', line 27

def initialize(url, protocol = nil, &block)
  if native?(url)
    super(url)
  elsif protocol
    super(`new window.WebSocket(#{url.to_s}, #{protocol.to_n})`)
  else
    super(`new window.WebSocket(#{url.to_s})`)
  end

  if block.arity == 0
    instance_exec(&block)
  else
    block.call(self)
  end if block
end

Instance Attribute Details

#buffered ⇒ Integer (readonly)

Returns the amount of buffered data.

Returns:

  • (Integer) —

    the amount of buffered data.



53
 
# File 'opal/browser/socket.rb', line 53

alias_native :buffered, :bufferedAmount

#extensions ⇒ Array<String> (readonly)

Returns the extensions used by the socket.

Returns:

  • (Array<String>) —

    the extensions used by the socket



94
95
96
 
# File 'opal/browser/socket.rb', line 94

def extensions
  `#@native.extensions`.split(/\s*,\s*/)
end

#protocol ⇒ String (readonly)

Returns the protocol of the socket.

Returns:

  • (String) —

    the protocol of the socket



45
 
# File 'opal/browser/socket.rb', line 45

alias_native :protocol

#state ⇒ :connecting, ... (readonly)

Returns the state of the socket.

Returns:

  • (:connecting, :open, :closing, :closed) —

    the state of the socket



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'opal/browser/socket.rb', line 74

def state
  %x{
    switch (#@native.readyState) {
      case window.WebSocket.CONNECTING:
        return "connecting";

      case window.WebSocket.OPEN:
        return "open";

      case window.WebSocket.CLOSING:
        return "closing";

      case window.WebSocket.CLOSED:
        return "closed";
    }
  }
end

#type ⇒ :blob, ... (readonly)

Returns the type of the socket.

Returns:

  • (:blob, :buffer, :string) —

    the type of the socket



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'opal/browser/socket.rb', line 57

def type
  %x{
    switch (#@native.binaryType) {
      case "blob":
        return "blob";

      case "arraybuffer":
        return "buffer";

      default:
        return "string";
    }
  }
end

#url ⇒ String (readonly)

Returns the URL the socket is connected to.

Returns:

  • (String) —

    the URL the socket is connected to



49
 
# File 'opal/browser/socket.rb', line 49

alias_native :url

Class Method Details

.supported? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'opal/browser/socket.rb', line 8

def self.supported?
  Browser.supports? :WebSocket
end

Instance Method Details

#alive? ⇒ Boolean

Check if the socket is alive.

Returns:

  • (Boolean) 


99
100
101
 
# File 'opal/browser/socket.rb', line 99

def alive?
  state == :open
end

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

Close the socket.

Parameters:

  • code (Integer, nil) (defaults to: nil) —

    the error code

  • reason (String, nil) (defaults to: nil) —

    the reason for closing



118
119
120
 
# File 'opal/browser/socket.rb', line 118

def close(code = nil, reason = nil)
  `#@native.close(#{code.to_n}, #{reason.to_n})`
end

#write(data) ⇒ Object Also known as: <<, send

Send data to the socket.

Parameters:

  • data (#to_n) —

    the data to send



106
107
108
 
# File 'opal/browser/socket.rb', line 106

def write(data)
  `#@native.send(#{data.to_n})`
end