class XMPP::TcpTransport

• XMPP::TcpTransport
• XMPP::Transport
• IO
• Reference
• Object

Overview

Classic RFC 6120 client transport over TCP. STARTTLS is negotiated by Session on top of this transport; XEP-0368 direct TLS is pre-wrapped here (mirroring the previous Client#open_socket behavior).

Defined in:

Constructors

• .new(socket : TCPSocket, tls_socket : OpenSSL::SSL::Socket::Client | Nil = nil)
• .open(config : Config) : TcpTransport

Instance Method Summary

• #close

  Closes this IO.

• #closed? : Bool

  Returns true if this IO is closed.

• #encrypted? : Bool

  True when TLS is already handled at or below this transport, so the session must not attempt a STARTTLS upgrade.

• #read(slice : Bytes) : Int32

  Reads at most slice.size bytes from this IO into slice.

• #socket : TCPSocket
• #supports_starttls? : Bool

  Whether the session must negotiate a STARTTLS upgrade on this transport before authentication.

• #tls_socket : OpenSSL::SSL::Socket::Client | Nil

  The underlying TLS socket when the transport opened one directly (XEP-0368 direct TLS).

• #write(slice : Bytes) : Nil

  Writes the contents of slice into this IO.

Constructor Detail

Instance Method Detail

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

io = IO::Memory.new
slice = Bytes.new(4) { |i| ('a'.ord + i).to_u8 }
io.write(slice)
io.to_s # => "abcd"