@abstract Subclass and override to implement custom frames
Initialize frame @param args [Hash] Arguments for frame @option args [String] :data default data for frame @option args [String] :type Type of frame - available types are “text”, “binary”, “ping”, “pong” and “close”(support depends on draft version) @option args [Integer] :code Code for close frame. Supported by drafts > 05. @option args [Integer] :version Version of draft. Currently supported version are 75, 76 and 00-13.
# File lib/websocket/frame/base.rb, line 16 def initialize(args = {}) @type = args[:type].to_sym if args[:type] @code = args[:code] @data = Data.new(args[:data].to_s) @version = args[:version] || DEFAULT_VERSION @handler = nil include_version end
Check if some errors occured @return [Boolean] True if error is set
# File lib/websocket/frame/base.rb, line 28 def error? !!@error end
Recreate inspect as to_s was overwritten
# File lib/websocket/frame/base.rb, line 43 def inspect vars = self.instance_variables.map{|v| "#{v}=#{instance_variable_get(v).inspect}"}.join(", ") insp = "#{self.class}:0x%08x" % (self.__id__ * 2) "<#{insp} #{vars}>" end
Is selected type supported for selected handler?
# File lib/websocket/frame/base.rb, line 33 def support_type? @handler.supported_frames.include?(@type) end
Implement in submodules
# File lib/websocket/frame/base.rb, line 38 def supported_frames raise NotImplementedError end
Include set of methods for selected protocol version @return [Boolean] false if protocol number is unknown, otherwise true
# File lib/websocket/frame/base.rb, line 53 def include_version @handler = case @version when 75..76 then Handler::Handler75.new(self) when 0..2 then Handler::Handler75.new(self) when 3 then Handler::Handler03.new(self) when 4 then Handler::Handler04.new(self) when 5..6 then Handler::Handler05.new(self) when 7..13 then Handler::Handler07.new(self) else raise WebSocket::Error::Frame::UnknownVersion end end