Module: WebSocket

Module

WebSocket

In:

lib/websocket/handshake.rb
lib/websocket/error.rb
lib/websocket/exception_handler.rb
lib/websocket/frame.rb
lib/websocket/frame/outgoing.rb
lib/websocket/frame/handler.rb
lib/websocket/frame/outgoing/client.rb
lib/websocket/frame/outgoing/server.rb
lib/websocket/frame/data.rb
lib/websocket/frame/incoming.rb
lib/websocket/frame/base.rb
lib/websocket/frame/handler/handler03.rb
lib/websocket/frame/handler/handler04.rb
lib/websocket/frame/handler/handler05.rb
lib/websocket/frame/handler/base.rb
lib/websocket/frame/handler/handler75.rb
lib/websocket/frame/handler/handler07.rb
lib/websocket/frame/incoming/client.rb
lib/websocket/frame/incoming/server.rb
lib/websocket/handshake/handler.rb
lib/websocket/handshake/client.rb
lib/websocket/handshake/base.rb
lib/websocket/handshake/handler/client75.rb
lib/websocket/handshake/handler/client01.rb
lib/websocket/handshake/handler/server75.rb
lib/websocket/handshake/handler/server76.rb
lib/websocket/handshake/handler/client04.rb
lib/websocket/handshake/handler/server04.rb
lib/websocket/handshake/handler/client.rb
lib/websocket/handshake/handler/client11.rb
lib/websocket/handshake/handler/base.rb
lib/websocket/handshake/handler/client76.rb
lib/websocket/handshake/handler/server.rb
lib/websocket/handshake/server.rb
lib/websocket/version.rb
lib/websocket.rb

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

Methods

max_frame_size max_frame_size= should_raise should_raise=

Classes and Modules

Module WebSocket::ExceptionHandler
Module WebSocket::Frame
Module WebSocket::Handshake
Class WebSocket::Error

Constants

VERSION	=	'1.2.4'.freeze
DEFAULT_VERSION	=	13		Default WebSocket version to use
ROOT	=	File.expand_path(File.dirname(__FILE__))

Public Class methods

max_frame_size()

Limit of frame size payload in bytes

max_frame_size=(val)

Set limit of frame size payload in bytes

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

should_raise=(val)

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