class

Herbal::Socket

Inherits IO / Reference / Object

Constructors

new(wrapped : IO, dnsResolver : Durian::Resolver, option : Herbal::Option | Nil = nil)

Instance methods

<<(value : String) : IO

active=(value : Bool)

active?

address_type

address_type=(value : Herbal::Address)

auth_challenge!

authentication

authentication=(value : Authentication)

authentication_methods

authentication_methods=(value : Array(Authentication))

bad_destination_address?

close

Closes this IO.

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

closed?

Returns true if this IO is closed.

IO defines returns false, but including types may override.

command

command=(value : Command)

destination_address

destination_address=(value : DestinationAddress)

destination_ip_address

destination_ip_address=(value : ::Socket::IPAddress)

dnsResolver

establish!(sync_resolution : Bool = false)

flush

Flushes buffered data, if any.

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

handshake!

keep_alive?

local_address

loopback_unspecified?

mutex

on_auth

on_auth=(value : Proc(String, String | Nil, Herbal::Verify))

option

process!(sync_resolution : Bool = false)

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

read_timeout

read_timeout=(value : Int | Float | Time::Span | Nil)

remote_address

reset_keep_alive

stats

version

version=(value : Version)

wrapped

wrapped=(wrapped : IO)

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"

write_timeout

write_timeout=(value : Int | Float | Time::Span | Nil)