class XMPP::WebSocketTransport

• XMPP::WebSocketTransport
• XMPP::Transport
• IO
• Reference
• Object

Overview

RFC 7395: XMPP over WebSocket. Presents a classic XMPP byte stream to Session while translating stream headers to / framing elements and sending whitespace keepalives as WebSocket PING frames.

Defined in:

Constructors

• .new(ws : HTTP::WebSocket, domain : String, encrypted : Bool)
• .open(config : Config, url : URI | Nil = nil) : WebSocketTransport

Class Method Summary

• .open_socket(url : URI, config : Config) : HTTP::WebSocket
• .resolve_url(config : Config, url : URI | Nil = nil) : URI

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.

• #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

Class Method 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"