Herbal::Plugin::WebSocket::Stream
Inherits IO / Reference / Object
Constructors
new(wrapped : Protocol, windowRemaining : Atomic(Int32) = Atomic(Int32).new(0), option : Herbal::Option | Nil = nil)
SourceInstance methods
buffer
Sourceclosed?
Returns true if this IO is closed.
IO defines returns false, but including types may override.
flush
Flushes buffered data, if any.
IO defines this is a no-op method, but including types may override.
ioMutex
Sourcekeep_alive=(value : Bool | Nil)
Sourcekeep_alive?
Sourcelocal_address
Sourcemutex
Sourceneed_disconnect_peer=(value : Bool | Nil)
Sourceneed_disconnect_peer?
Sourceoption
Sourceping(event : EnhancedPing | Nil = nil)
Sourcepong(event : EnhancedPong | Nil = nil)
Sourceread(slice : Bytes) : Int32
Reads at most slice.size bytes from this IO into slice.
Returns the number of bytes read, which is 0 if and only if there is no
more data to read (so checking for 0 is the way to detect end of file).
io = IO::Memory.new "hello"
slice = Bytes.new(4)
io.read(slice) # => 4
slice # => Bytes[104, 101, 108, 108]
io.read(slice) # => 1
slice # => Bytes[111, 101, 108, 108]
io.read(slice) # => 0
read_timeout
Sourceread_timeout=(value : Int | Float | Time::Span | Nil)
Sourcereceive_pong_event!
Sourceremote_address
SourcewindowRemaining
SourcewindowRemaining=(windowRemaining : Atomic(Int32))
Sourcewrapped
Sourcewrapped=(wrapped : Protocol)
Sourcewrite(slice : Bytes) : Nil
Writes the contents of slice into this IO.
io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"
write_timeout
Sourcewrite_timeout=(value : Int | Float | Time::Span | Nil)
Source