class

Carton::Socket

Inherits IO / Reference / Object

Constructors

new(wrapped : IO)
Source

Class methods

extract(socket : IO)
Source
staple_socket(stream, socket : IO) : IO::Stapled | Nil
Source

Instance methods

<<(value : String) : IO
Source
auth_challenge(request : HTTP::Request) : Verify
Source
authentication
Source
authentication=(value : Authentication)
Source
client_authentication
Source
client_authentication=(value : Authentication)
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
destination_address
Source
destination_address=(value : DestinationAddress)
Source
establish!
Source
extract_size
Source
extract_size=(value : Int32)
Source
flush

Flushes buffered data, if any.

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

Source
handshake!
Source
local_address
Source
on_auth
Source
on_auth=(value : Proc(String, String | Nil, Carton::Verify))
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 | Float | Time::Span | Nil)
Source
reject_establish!
Source
remote_address
Source
request_payload
Source
request_payload=(value : HTTP::Request)
Source
set_connect_information!(request : HTTP::Request)
Source
staple_request(socket : IO) : IO
Source
stats
Source
traffic_type
Source
traffic_type=(value : Traffic)
Source
tunnel_mode
Source
tunnel_mode=(value : Bool)
Source
wrapped
Source
wrapped=(wrapped : IO)
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 | Float | Time::Span | Nil)
Source