class

Herbal::Client

Inherits IO / Reference / Object

Constructors

new(host : String, port : Int32, dnsResolver : Durian::Resolver, connectTimeout : Int | Float | Nil = nil)
Source
new(host : String, port : Int32, dnsResolver : Durian::Resolver, timeout : TimeOut = TimeOut.new)
Source
new(wrapped : IO, dnsResolver : Durian::Resolver)
Source
new(ip_address : ::Socket::IPAddress, dnsResolver : Durian::Resolver, connectTimeout : Int | Float | Nil = nil)
Source
new(ip_address : ::Socket::IPAddress, dnsResolver : Durian::Resolver, timeout : TimeOut = TimeOut.new)
Source

Instance methods

<<(value : String) : IO
Source
authentication_methods
Source
authentication_methods=(value : Array(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
connect!(ip_address : ::Socket::IPAddress, command : Command | Nil = nil, remote_resolution : Bool = false)
Source
connect!(host : String, port : Int32, command : Command | Nil = nil, remote_resolution : Bool = false)
Source
connect!(socket : IO, host : String, port : Int32, command : Command | Nil = nil, remote_resolution : Bool = false)
Source
dnsResolver
Source
flush

Flushes buffered data, if any.

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

Source
local_address
Source
on_auth
Source
on_auth=(value : AuthenticationEntry)
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
remote_address
Source
version
Source
version=(value : Version)
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