Module: WebSocket

### Home Classes Methods

### In Files

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

### Namespace

- MODULE WebSocket::ExceptionHandler
- MODULE WebSocket::Frame
- MODULE WebSocket::Handshake
- CLASS WebSocket::Error

### Methods

- ::max_frame_size
- ::max_frame_size=
- ::should_raise
- ::should_raise=

### Class/Module Index

Quicksearch

- WebSocket
- WebSocket::Error
- WebSocket::Error::Frame
- WebSocket::Error::Frame::ControlFramePayloadTooLong
- WebSocket::Error::Frame::DataFrameInsteadContinuation
- WebSocket::Error::Frame::FragmentedControlFrame
- WebSocket::Error::Frame::Invalid
- WebSocket::Error::Frame::InvalidPayloadEncoding
- WebSocket::Error::Frame::MaskTooShort
- WebSocket::Error::Frame::ReservedBitUsed
- WebSocket::Error::Frame::TooLong
- WebSocket::Error::Frame::UnexpectedContinuationFrame
- WebSocket::Error::Frame::UnknownCloseCode
- WebSocket::Error::Frame::UnknownFrameType
- WebSocket::Error::Frame::UnknownOpcode
- WebSocket::Error::Frame::UnknownVersion
- WebSocket::Error::Handshake
- WebSocket::Error::Handshake::GetRequestRequired
- WebSocket::Error::Handshake::InvalidAuthentication
- WebSocket::Error::Handshake::InvalidHeader
- WebSocket::Error::Handshake::InvalidStatusCode
- WebSocket::Error::Handshake::NoHostProvided
- WebSocket::Error::Handshake::UnknownVersion
- WebSocket::ExceptionHandler
- WebSocket::ExceptionHandler::ClassMethods
- WebSocket::Frame
- WebSocket::Frame::Base
- WebSocket::Frame::Data
- WebSocket::Frame::Handler
- WebSocket::Frame::Handler::Base
- WebSocket::Frame::Handler::Handler03
- WebSocket::Frame::Handler::Handler04
- WebSocket::Frame::Handler::Handler05
- WebSocket::Frame::Handler::Handler07
- WebSocket::Frame::Handler::Handler75
- WebSocket::Frame::Incoming
- WebSocket::Frame::Incoming::Client
- WebSocket::Frame::Incoming::Server
- WebSocket::Frame::Outgoing
- WebSocket::Frame::Outgoing::Client
- WebSocket::Frame::Outgoing::Server
- WebSocket::Handshake
- WebSocket::Handshake::Base
- WebSocket::Handshake::Client
- WebSocket::Handshake::Handler
- WebSocket::Handshake::Handler::Base
- WebSocket::Handshake::Handler::Client
- WebSocket::Handshake::Handler::Client01
- WebSocket::Handshake::Handler::Client04
- WebSocket::Handshake::Handler::Client75
- WebSocket::Handshake::Handler::Client76
- WebSocket::Handshake::Handler::Server
- WebSocket::Handshake::Handler::Server04
- WebSocket::Handshake::Handler::Server75
- WebSocket::Handshake::Handler::Server76
- WebSocket::Handshake::Server

No matching classes.

# 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() click to toggle source

Limit of frame size payload in bytes

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

max_frame_size=(val) click to toggle source

Set limit of frame size payload in bytes

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

should_raise() click to toggle source

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

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

should_raise=(val) click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.