module WebSocket

WebSocket protocol implementation in Ruby This module does not provide a WebSocket server or client, but is made for using in http servers or clients to provide WebSocket support. @author Bernard “Imanel” Potocki @see github.com/imanel/websocket-ruby main repository

Constants

DEFAULT_VERSION: Default WebSocket version to use
ROOT
VERSION

Public Class Methods

max_frame_size ()

Source

# File lib/websocket.rb, line 20
def self.max_frame_size
  @max_frame_size ||= 20 * 1024 * 1024 # 20MB
end

Limit of frame size payload in bytes

max_frame_size= (val)

Source

# File lib/websocket.rb, line 25
def self.max_frame_size=(val)
  @max_frame_size = val
end

Set limit of frame size payload in bytes

should_raise ()

Source

# File lib/websocket.rb, line 31
def self.should_raise
  @should_raise ||= false
end

If set to true error will be raised instead of setting ‘error` method. All errors inherit from WebSocket::Error.

should_raise= (val)

Source

# File lib/websocket.rb, line 36
def self.should_raise=(val)
  @should_raise = val
end

Should protocol errors raise ruby errors? If false then ‘error` flag is set instead.