kinetic_sdk 5.0.18 → 5.0.20

data/gems/kontena-websocket-client-0.1.1/lib/kontena/websocket/client.rb

@@ -1,848 +0,0 @@
-# Threadsafe: while the #run method is reading/parsing incoming websocket frames, the #send/#ping/#close methods
-# can be called by other threads.
-# The #run (on_open), #on_message and #on_pong blocks will be called from the #run thread.
-#
-#
-=begin example
-   def websocket_connect
-      Kontena::Websocket::Client.connect(url, ...) do |client|
-        on_open(client)
-
-        client.read do |message|
-          on_message(message)
-        end
-
-        on_close(client.close_code, client.close_reason) # client closed connection
-      end
-    rescue Kontena::Websocket::CloseError => exc
-      on_close(exc.code, exc.reason) # server closed connection
-    rescue Kontena::Websocket::Error => exc
-      on_error(exc)
-    ensure
-      # disconnected
-    end
-  end
-=end
-class Kontena::Websocket::Client
-  require_relative './client/connection'
-
-  include Kontena::Websocket::Logging
-
-  attr_reader :uri
-
-  FRAME_SIZE = 4 * 1024
-  CONNECT_TIMEOUT = 60.0
-  OPEN_TIMEOUT = 60.0
-  PING_INTERVAL = 60.0
-  PING_TIMEOUT = 10.0
-  PING_STRFTIME = '%FT%T.%NZ' # high-percision RFC 3339
-  CLOSE_TIMEOUT = 60.0
-  WRITE_TIMEOUT = 60.0
-
-  # Connect, send websocket handshake, and loop reading responses.
-  #
-  # Passed block is called once websocket is open.
-  # Raises on errors.
-  # Returns once websocket is closed by server.
-  #
-  # Intended to be called using a dedicated per-websocket thread.
-  # Other threads can then call the other threadsafe methods:
-  #  * send
-  #  * close
-  #
-  # @yield [client] websocket open
-  # @raise [Kontena::Websocket::ConnectError]
-  # @raise [Kontena::Websocket::ProtocolError]
-  # @raise [Kontena::Websocket::TimeoutError]
-  # @return websocket closed by server, @see #close_code #close_reason
-  def self.connect(url, **options, &block)
-    client = new(url, **options)
-
-    client.connect
-
-    begin
-      yield client
-    ensure
-      # ensure socket is closed and client disconnected on any of:
-      #   * connect error
-      #   * open error
-      #   * read error
-      #   * close
-      client.disconnect
-    end
-  end
-
-  # @param [String] url
-  # @param headers [Hash{String => String}]
-  # @param ssl_params [Hash] @see OpenSSL::SSL::SSLContext
-  #   The DEFAULT_PARAMS includes verify_mode: OpenSSL::SSL::VERIFY_PEER.
-  #   Use { verify_mode: OpenSSL::SSL::VERIFY_NONE } to disable Kontena::Websocket::SSLVerifyError on connect.
-  # @param ssl_hostname [String] override hostname for SSL SNI, certificate identity matching
-  # @param connect_timeout [Float] timeout for TCP handshake; XXX: each phase of the SSL handshake
-  # @param open_timeout [Float] expect open frame after #start
-  # @param ping_interval [Float] send pings every interval seconds after previous ping
-  # @param ping_timeout [Float] expect pong frame after #ping
-  # @param close_timeout [Float] expect close frame after #close
-  # @param write_timeout [Float] block #send when sending faster than the server is able to receive, fail if no progress is made
-  # @raise [ArgumentError] Invalid websocket URI
-  def initialize(url,
-      headers: {},
-      ssl_params: {},
-      ssl_hostname: nil,
-      connect_timeout: CONNECT_TIMEOUT,
-      open_timeout: OPEN_TIMEOUT,
-      ping_interval: PING_INTERVAL,
-      ping_timeout: PING_TIMEOUT,
-      close_timeout: CLOSE_TIMEOUT,
-      write_timeout: WRITE_TIMEOUT
-  )
-    @uri = URI.parse(url)
-    @headers = headers
-    @ssl_params = ssl_params
-    @ssl_hostname = ssl_hostname
-
-    @connect_timeout = connect_timeout
-    @open_timeout = open_timeout
-    @ping_interval = ping_interval
-    @ping_timeout = ping_timeout
-    @close_timeout = close_timeout
-    @write_timeout = write_timeout
-
-    unless @uri.scheme == 'ws' || @uri.scheme == 'wss'
-      raise ArgumentError, "Invalid websocket URL: #{@uri}"
-    end
-
-    @mutex = Mutex.new # for @driver
-
-    # written by #enqueue from @driver callbacks with the @mutex held
-    # drained by #read without the @mutex held
-    @message_queue = []
-
-    # sequential ping-pongs
-    @ping_at = Time.now # fake for first ping_interval
-  end
-
-  # @return [String]
-  def url
-    @uri.to_s
-  end
-
-  # @return [String] ws or wss
-  def scheme
-    @uri.scheme
-  end
-
-  # @return [Boolean]
-  def ssl?
-    @uri.scheme == 'wss'
-  end
-
-  # Connecting with SSL cert/host verification?
-  #
-  # @return [Boolean]
-  def ssl_verify?
-    ssl? && ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
-  end
-
-  # @return [String]
-  def ssl_hostname
-    @ssl_hostname || @uri.host
-  end
-
-  # @return [String]
-  def host
-    @uri.host
-  end
-
-  # @return [Integer]
-  def port
-    @uri.port || (@uri.scheme == "ws" ? 80 : 443)
-  end
-
-  # Connected to server. Not necessarily open yet.
-  #
-  # @return [Boolean]
-  def connected?
-    !!@socket && !!@connection && !!@driver
-  end
-
-  # Client has started websocket handshake, but is not yet open.
-  #
-  # @return [Boolean]
-  def opening?
-    # XXX: also true after disconnect
-    !!@opening_at && !@opened
-  end
-
-  # Server has accepted websocket connection.
-  #
-  # @return [Boolean]
-  def open?
-    !!@open
-  end
-
-  # Client has sent close frame, but socket is not yet closed.
-  #
-  # @return [Boolean]
-  def closing?
-    !!@closing && !@closed
-  end
-
-  # Server has closed websocket connection.
-  #
-  # @return [Boolean]
-  def closed?
-    !!@closed
-  end
-
-  # Valid once #run returns, when closed? or closing?
-  #
-  # @return [Integer]
-  def close_code
-    @closed_code || @closing_code
-  end
-
-  # Valid once #run returns, when closed?
-  #
-  # @return [String]
-  def close_reason
-    @closed_reason
-  end
-
-  # Create @socket, @connection and open @driver.
-  #
-  # Blocks until open. Disconnects if fails.
-  #
-  # @raise [Kontena::Websocket::ConnectError]
-  # @raise [Kontena::Websocket::TimeoutError]
-  # @return once websocket is open
-  def connect
-    @connection = self.socket_connect
-
-    @driver = self.websocket_open(@connection)
-
-    # blocks
-    self.websocket_read until @opened
-
-  rescue
-    disconnect
-    raise
-  end
-
-  # @raise [RuntimeError] not connected
-  # @return [nil] not an ssl connection, or no peer cert
-  # @return [OpenSSL::X509::Certificate]
-  def ssl_cert
-    fail "not connected" unless @socket
-    return nil unless ssl?
-
-    return @socket.peer_cert
-  end
-
-  # Verify and return SSL cert. Validates even if not ssl_verify.
-  #
-  # @raise [RuntimeError] not connected
-  # @raise [Kontena::Websocket::SSLVerifyError]
-  # @return [nil] not an ssl connection
-  # @return [OpenSSL::X509::Certificate]
-  def ssl_cert!
-    fail "not connected" unless @socket
-    return nil unless ssl?
-
-    # raises Kontena::Websocket::SSLVerifyError
-    self.ssl_verify_cert! @socket.peer_cert, @socket.peer_cert_chain
-
-    return @socket.peer_cert
-  end
-
-  # Valid once open
-  #
-  # @raise [RuntimeError] not connected
-  # @return [Integer]
-  def http_status
-    with_driver do |driver|
-      driver.status
-    end
-  end
-
-  # Valid once open
-  #
-  # @raise [RuntimeError] not connected
-  # @return [Websocket::Driver::Headers]
-  def http_headers
-    with_driver do |driver|
-      driver.headers
-    end
-  end
-
-  # Read messages from websocket.
-  #
-  # If a block is given, then this loops and yields messages until closed.
-  # Otherwise, returns the next message, or nil if closed.
-  #
-  # @raise [Kontena::Websocket::CloseError]
-  def read(&block)
-    if block
-      read_yield(&block)
-    else
-      read_return
-    end
-  end
-
-  # Send message frame, either text or binary.
-  #
-  # @param message [String, Array<Integer>]
-  # @raise [ArgumentError] invalid type
-  # @raise [RuntimeError] unable to send (socket closed?)
-  def send(message)
-    case message
-    when String
-      with_driver do |driver|
-        fail unless driver.text(message)
-      end
-    when Array
-      with_driver do |driver|
-        fail unless driver.binary(message)
-      end
-    else
-      raise ArgumentError, "Invalid type: #{message.class}"
-    end
-  end
-
-  # Register pong handler.
-  # Called from the #read thread every ping_interval after received pong.
-  # XXX: called with driver @mutex locked
-  #
-  # The ping interval should be longer than the ping timeout.
-  # If new pings are sent before old pings get any response, then the older pings do not yield on pong.
-  #
-  # @yield [delay] received pong
-  # @yieldparam delay [Float] ping-pong delay in seconds
-  def on_pong(&block)
-    @on_pong = block
-  end
-
-  # Send ping message.
-  #
-  # This is intended to be automatically called from #run per @ping_interval.
-  # Calling it from the #run callbacks also works, but calling it from a different thread
-  # while #run is blocked on read() will ignore the @ping_timeout, unless the server happens
-  # to send something else.
-  #
-  # @raise [RuntimeError] not connected
-  def ping
-    with_driver do |driver|
-      # start ping timeout for next read
-      ping_at = pinging!
-
-      debug "pinging at #{ping_at}"
-
-      fail unless driver.ping(ping_at.utc.strftime(PING_STRFTIME)) do
-        # called from read -> @driver.parse with @mutex held!
-        debug "pong for #{ping_at}"
-
-        # resolve ping timeout, unless this pong is late and we already sent a new one
-        if ping_at == @ping_at
-          ping_delay = pinged!
-
-          debug "ping-pong at #{ping_at} in #{ping_delay}s"
-
-          # XXX: defer call without mutex?
-          @on_pong.call(ping_delay) if @on_pong # TODO: also pass ping_at
-        end
-      end
-    end
-  end
-
-  # Waiting for pong from ping
-  #
-  # @return [Boolean]
-  def pinging?
-    !!@pinging
-  end
-
-  # Measured ping-pong delay from previous ping
-  #
-  # nil if not pinged yet
-  #
-  # @return [Float, nil]
-  def ping_delay
-    @ping_delay
-  end
-
-  # Send close frame. Does not disconnect, but allows #read to return once server completes close handshake.
-  #
-  # Imposes a close timeout when called from #run blocks (run/on_message/on_pong do ...). If called from
-  # a different thread, then #run should eventually return, once either:
-  # * server sends close frame
-  # * server sends any other frame after the close timeout expires
-  # * the ping interval expires
-  #
-  # XXX: prevent #send after close?
-  #
-  # @param close [Integer]
-  # @param reason [String]
-  def close(code = 1000, reason = nil)
-    debug "close code=#{code}: #{reason}"
-
-    with_driver do |driver|
-      fail unless driver.close(reason, code) # swapped argument order
-
-      closing! code
-    end
-  end
-
-  # Clear connection state, close socket.
-  # Does not send websocket close frame, or wait for server to close.
-  def disconnect
-    debug "disconnect"
-
-    @open = false
-    @driver = nil
-    @connection = nil
-
-    # TODO: errors and timeout? SSLSocket.close in particular is bidirectional?
-    @socket.close if @socket
-    @socket = nil
-  end
-
-#protected XXX: called by specs TODO: refactor out to separate TCP/SSL client classes
-
-  # Call into driver with locked Mutex
-  #
-  # @raise [RuntimeError] not connected
-  # @yield [driver]
-  # @yieldparam driver [Websocket::Driver]
-  def with_driver
-    @mutex.synchronize {
-      fail "not connected" unless @driver
-
-      yield @driver
-    }
-  end
-
-  # Connect to TCP server.
-  #
-  # @raise [Kontena::Websocket::TimeoutError] Errno::ETIMEDOUT
-  # @raise [Kontena::Websocket::ConnectError] Errno::*
-  # @raise [Kontena::Websocket::ConnectError] SocketError
-  # @return [TCPSocket]
-  def connect_tcp
-    debug "connect_tcp: timeout=#{@connect_timeout}"
-
-    Socket.tcp(self.host, self.port, connect_timeout: @connect_timeout)
-  rescue Errno::ETIMEDOUT => exc
-    raise Kontena::Websocket::TimeoutError, "Connect timeout after #{@connect_timeout}s" # XXX: actual delay
-  rescue SocketError => exc
-    raise Kontena::Websocket::ConnectError, exc
-  rescue SystemCallError => exc
-    raise Kontena::Websocket::ConnectError, exc
-  end
-
-  # @raise [ArgumentError] Failed adding cert store file/path: ...
-  # @return [OpenSSL::X509::Store]
-  def ssl_cert_store
-    @ssl_cert_store ||= OpenSSL::X509::Store.new.tap do |ssl_cert_store|
-      ca_file = @ssl_params[:ca_file] || ENV['SSL_CERT_FILE']
-      ca_path = @ssl_params[:ca_path] || ENV['SSL_CERT_PATH']
-
-      if ca_file || ca_path
-        if ca_file
-          debug "add cert store file: #{ca_file}"
-
-          begin
-            ssl_cert_store.add_file ca_file
-          rescue OpenSSL::X509::StoreError
-            raise ArgumentError, "Failed adding cert store file: #{ca_file}"
-          end
-        end
-
-        if ca_path
-          debug "add cert store path: #{ca_path}"
-
-          begin
-            # XXX: does not actually raise
-            ssl_cert_store.add_path ca_path
-          rescue OpenSSL::X509::StoreError
-            raise ArgumentError, "Failed adding cert store path: #{ca_path}"
-          end
-        end
-      else
-        debug "use default cert store paths"
-
-        ssl_cert_store.set_default_paths
-      end
-    end
-  end
-
-  # @param ssl_cert [OpenSSL::X509::Certificate]
-  # @raise [Kontena::Websocket::SSLVerifyError]
-  def ssl_verify_cert!(ssl_cert, ssl_cert_chain)
-    unless ssl_cert
-      raise Kontena::Websocket::SSLVerifyError.new(OpenSSL::X509::V_OK, ssl_cert, ssl_cert_chain), "No certificate"
-    end
-
-    ssl_verify_context = OpenSSL::X509::StoreContext.new(ssl_cert_store, ssl_cert, ssl_cert_chain)
-
-    unless ssl_verify_context.verify
-      raise Kontena::Websocket::SSLVerifyError.new(ssl_verify_context.error, ssl_cert, ssl_cert_chain), ssl_verify_context.error_string
-    end
-
-    unless OpenSSL::SSL.verify_certificate_identity(ssl_cert, self.ssl_hostname)
-      raise Kontena::Websocket::SSLVerifyError.new(OpenSSL::X509::V_OK, ssl_cert, ssl_cert_chain), "Subject does not match hostname #{self.ssl_hostname}: #{ssl_cert.subject}"
-    end
-  end
-
-  # @param verify_result [Integer] OpenSSL::SSL::SSLSocket#verify_result
-  # @return [Kontena::Websocket::SSLVerifyError]
-  def ssl_verify_error(verify_result, ssl_cert = nil, ssl_cert_chain = nil)
-    ssl_verify_context = OpenSSL::X509::StoreContext.new(ssl_cert_store)
-    ssl_verify_context.error = verify_result
-
-    Kontena::Websocket::SSLVerifyError.new(ssl_verify_context.error, ssl_cert, ssl_cert_chain, ssl_verify_context.error_string)
-  end
-
-  # @return [OpenSSL::SSL::SSLContext]
-  def ssl_context
-    @ssl_context ||= OpenSSL::SSL::SSLContext.new().tap do |ssl_context|
-      params = {
-        cert_store: self.ssl_cert_store,
-        **@ssl_params
-      }
-
-      if Kontena::Websocket::Client.ruby_version? '2.4'
-        # prefer our own ssl_verify_cert! logic
-        params[:verify_hostname] = false
-      end
-
-      ssl_context.set_params(params)
-    end
-  end
-
-  # TODO: connect_deadline to impose a single deadline on the entire process
-  # XXX: specs
-  #
-  # @param ssl_socket [OpenSSL::SSL::SSLSocket]
-  # @raise [OpenSSL::SSL::SSLError]
-  # @raise [Kontena::Websocket::TimeoutError]
-  def ssl_connect(ssl_socket)
-    debug "ssl_connect..."
-    ret = ssl_socket.connect_nonblock
-  rescue IO::WaitReadable
-    debug "ssl_connect wait read: timeout=#{@connect_timeout}"
-    ssl_socket.wait_readable(@connect_timeout) or raise Kontena::Websocket::TimeoutError, "SSL connect read timeout after #{@connect_timeout}s"
-    retry
-  rescue IO::WaitWritable
-    debug "ssl_connect wait write: timeout=#{@connect_timeout}"
-    ssl_socket.wait_writable(@connect_timeout) or raise Kontena::Websocket::TimeoutError, "SSL connect write timeout after #{@connect_timeout}s"
-    retry
-  else
-    debug "ssl_connect: #{ret}"
-  end
-
-  # Connect to TCP server, perform SSL handshake, verify if required.
-  #
-  # @raise [Kontena::Websocket::ConnectError] from connect_tcp
-  # @raise [Kontena::Websocket::SSLConnectError]
-  # @raise [Kontena::Websocket::SSLVerifyError] errors that only happen with ssl_verify: true
-  # @return [OpenSSL::SSL::SSLSocket]
-  def connect_ssl
-    tcp_socket = self.connect_tcp
-    ssl_context = self.ssl_context
-
-    debug "connect_ssl: #{ssl_context.inspect} hostname=#{self.ssl_hostname}"
-
-    ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
-    ssl_socket.sync_close = true # close TCPSocket after SSL shutdown
-    ssl_socket.hostname = self.ssl_hostname # SNI
-
-    begin
-      self.ssl_connect(ssl_socket)
-    rescue OpenSSL::SSL::SSLError => exc
-      # SSL_connect returned=1 errno=0 state=error: certificate verify failed
-      if exc.message.end_with? 'certificate verify failed'
-        # ssl_socket.peer_cert is not set on errors :(
-        raise ssl_verify_error(ssl_socket.verify_result)
-      else
-        raise Kontena::Websocket::SSLConnectError, exc
-      end
-    end
-
-    # raises Kontena::Websocket::SSLVerifyError
-    self.ssl_verify_cert!(ssl_socket.peer_cert, ssl_socket.peer_cert_chain) if ssl_verify?
-
-    ssl_socket
-  end
-
-  # @return [Connection]
-  def socket_connect
-    if ssl?
-      @socket = self.connect_ssl
-    else
-      @socket = self.connect_tcp
-    end
-
-    return Connection.new(@uri, @socket,
-      write_timeout: @write_timeout,
-    )
-  end
-
-  # Create websocket driver using connection, and send websocket handshake.
-  # Registers driver handlers to set @open, @closed states, enqueue messages, or raise errors.
-  #
-  # @param connection [Kontena::Websocket::Client::Connection]
-  # @raise [RuntimeError] already started?
-  # @return [WebSocket::Driver::Client]
-  def websocket_open(connection)
-    debug "websocket open..."
-
-    driver = ::WebSocket::Driver.client(connection)
-
-    @headers.each do |k, v|
-      driver.set_header(k, v)
-    end
-
-    # these are called from read_loop -> with_driver { driver.parse } with the @mutex held
-    # do not recurse back into with_driver!
-    driver.on :error do |event|
-      self.on_driver_error(event)
-    end
-
-    driver.on :open do |event|
-      self.on_driver_open(event)
-    end
-
-    driver.on :message do |event|
-      self.on_driver_message(event)
-    end
-
-    driver.on :close do |event|
-      self.on_driver_close(event)
-    end
-
-    # not expected to emit anything, not even :error
-    fail unless driver.start
-
-    debug "opening"
-
-    opening!
-
-    return driver
-  end
-
-  # @param exc [WebSocket::Driver::ProtocolError]
-  def on_driver_error(exc)
-    # this will presumably propagate up out of #recv_loop, not this function
-    raise exc
-
-  rescue WebSocket::Driver::ProtocolError => exc
-    raise Kontena::Websocket::ProtocolError, exc
-  end
-
-  # Mark client as opened, calling the block passed to #run.
-  #
-  # @param event [WebSocket::Driver::OpenEvent] no attrs
-  def on_driver_open(event)
-    debug "opened"
-
-    opened!
-  end
-
-  # Queue up received messages
-  # Causes #read to return/yield once websocket_read returns with the driver mutex unlocked.
-  #
-  # @param event [WebSocket::Driver::MessageEvent] data
-  def on_driver_message(event)
-    @message_queue << event.data
-  end
-
-  # Mark client as closed, allowing #run to return (and disconnect from the server).
-  #
-  # @param event [WebSocket::Driver::CloseEvent] code, reason
-  def on_driver_close(event)
-    debug "closed code=#{event.code}: #{event.reason}"
-
-    closed! event.code, event.reason
-  end
-
-  # Start read deadline for @open_timeout
-  def opening!
-    @opening_at = Time.now
-  end
-
-  # Server completed open handshake.
-  def opened!
-    @opened = true
-    @open = true
-  end
-
-  # Start read deadline for @ping_timeout
-  #
-  # @return [Time] ping at
-  def pinging!
-    @pinging = true
-    @ping_at = Time.now
-    @pong_at = nil
-
-    @ping_at
-  end
-
-  # Stop read deadline for @ping_timeout
-  # @return [Float] ping delay
-  def pinged!
-    @pinging = false
-    @pong_at = Time.now
-    @ping_delay = @pong_at - @ping_at
-
-    @ping_delay
-  end
-
-  # Client closing connection with code.
-  #
-  # Start read deadline for @open_timeout
-  #
-  # @param code [Integer] expecting close frame from server with matching code
-  def closing!(code)
-    @open = false # fail any further sends after close
-    @closing = true
-    @closing_at = Time.now
-    @closing_code = code # cheked by #read_closed
-  end
-
-  # Server closed, completing close handshake if closing.
-  #
-  # @param code [Integer]
-  # @param reason [String]
-  def closed!(code, reason)
-    @open = false
-    @closed = true
-    @closed_code = code
-    @closed_reason = reason
-  end
-
-  # @raise [Kontena::Websocket::CloseError] server closed connection without client closing
-  # @return [Boolean] connection was closed
-  def read_closed
-    if !@closed
-      return false
-    elsif @closing && @closing_code == @closed_code
-      # client sent close, server responded with close
-      return true
-    else
-      raise Kontena::Websocket::CloseError.new(@closed_code, @closed_reason)
-    end
-  end
-
-  # @raise [Kontena::Websocket::CloseError]
-  # @return [String, Array<Integer>] nil when websocket closed
-  def read_return
-    # important to first drain message queue before failing on read_closed!
-    while @message_queue.empty? && !self.read_closed
-      self.websocket_read
-    end
-
-    # returns nil if @closed, once the message queue is empty
-    return @message_queue.shift
-  end
-
-  # @raise [Kontena::Websocket::CloseError]
-  # @yield [message] received websocket message payload
-  # @yieldparam message [String, Array<integer>] text or binary
-  # @return websocket closed
-  def read_yield
-    loop do
-      while msg = @message_queue.shift
-        yield msg
-      end
-
-      # drain queue before returning on close
-      return if self.read_closed
-
-      self.websocket_read
-    end
-  end
-
-  # Return read deadline for current read state
-  #
-  # @return [Symbol, Float, Float] state, at, timeout
-  def read_state_timeout
-    case
-    when opening? && @open_timeout
-      [:open, @opening_at, @open_timeout]
-    when pinging? && @ping_timeout
-      [:pong, @ping_at, @ping_timeout]
-    when closing? && @close_timeout
-      [:close, @closing_at, @close_timeout]
-    when @ping_interval
-      [:ping, @ping_at, @ping_interval]
-    else
-      [nil, nil, nil]
-    end
-  end
-
-  # Read socket with timeout, parse websocket frames via @driver, emitting on-driver_* to enqueue messages.
-  # Sends ping on interval timeout.
-  def websocket_read
-    read_state, state_start, state_timeout = self.read_state_timeout
-
-    if state_timeout
-      read_deadline = state_start + state_timeout
-      read_timeout = read_deadline - Time.now
-    else
-      read_timeout = nil
-    end
-
-    debug "read (#{read_state})"
-
-    begin
-      # read from socket
-      data = self.socket_read(read_timeout)
-    rescue Kontena::Websocket::TimeoutError => exc
-      if read_state == :ping
-        debug "ping on #{exc}"
-        self.ping
-      elsif read_state
-        raise exc.class.new("#{exc} while waiting #{state_timeout}s for #{read_state}")
-      else
-        raise
-      end
-    else
-      # parse data with @driver @mutex held
-      with_driver do |driver|
-        # call into the driver, causing it to emit the events registered in #start
-        driver.parse(data)
-      end
-    end
-  end
-
-  # Read from socket with timeout, parse websocket frames.
-  # Invokes on_driver_*, which enqueues messages.
-  # The websocket must be connected.
-  #
-  # @param timeout [Flaot] seconds
-  # @raise [Kontena::Websocket::TimeoutError] read deadline expired
-  # @raise [Kontena::Websocket::TimeoutError] read timeout after X.Ys
-  # @raise [Kontena::Websocket::SocketError]
-  def socket_read(timeout = nil)
-    if timeout && timeout <= 0.0
-      raise Kontena::Websocket::TimeoutError, "read deadline expired"
-    end
-
-    begin
-      data = @connection.read(FRAME_SIZE, timeout: timeout)
-
-    rescue EOFError => exc
-      debug "read EOF"
-
-      raise Kontena::Websocket::EOFError, 'Server closed connection without sending close frame'
-
-    rescue IOError => exc
-      # socket was closed => IOError: closed stream
-      debug "read IOError: #{exc}"
-
-      raise Kontena::Websocket::SocketError, exc
-
-    # TODO: Errno::ECONNRESET etc
-    end
-  end
-end