class

SOCKS::Enhanced::WebSocket

Inherits IO < Reference < Object

Constructors

new(io : HTTP::WebSocket::Protocol, options : Options | Nil = nil, state : State::WebSocket = State::WebSocket.new)
Source

Instance methods

allow_connection_pause?
Source
allow_connection_reuse?
Source
close

Closes this IO.

IO defines this is a no-op method, but including types may override.

Source
closed?

Returns true if this IO is closed.

IO defines returns false, but including types may override.

Source
connection_identifier
Source
final_command_flag?
Source
flush

Flushes buffered data, if any.

IO defines this is a no-op method, but including types may override.

Source
io
Source
local_address
Source
notify_peer_incoming
Source
notify_peer_negotiate(command_flag : CommandFlag)
Source
options
Source
ping(slice : Bytes | Nil)
Source
pong(slice : Bytes | Nil)
Source
process_client_side_connection_pause_pending!
Source
process_negotiate(source : IO)
Source
process_response_pending_command_negotiate
Source
process_server_side_connection_pause_pending!(connection_identifier : UUID, pause_pool : PausePool) : PausePool::Entry | Nil
Source
read(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
Source
read_timeout
Source
read_timeout=(value : Int | Time::Span | Nil)
Source
received_command?
Source
received_command_flag?
Source
remote_address
Source
reset_settings(command_flag : CommandFlag | Nil) : Bool
Source
resynchronize
Source
send_command?
Source
send_command_flag?
Source
state
Source
state=(state : State::WebSocket)
Source
synchronize(synchronize_flag : State::SynchronizeFlag, ignore_incoming_alert : Bool = true)
Source
synchronizing=(value : Bool)
Source
synchronizing?
Source
transporting=(value : Bool)
Source
transporting?
Source
write(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"
Source
write_timeout
Source
write_timeout=(value : Int | Time::Span | Nil)
Source