instance method `close`

Ruby on Rails 7.2.3

Since v5.2.8.1

Available in: v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

close(reason: nil, reconnect: true)

Close the WebSocket connection.

Parameters

reason key = nil
reconnect key = true

Source

# File actioncable/lib/action_cable/connection/base.rb, line 120
      def close(reason: nil, reconnect: true)
        transmit(
          type: ActionCable::INTERNAL[:message_types][:disconnect],
          reason: reason,
          reconnect: reconnect
        )
        websocket.close
      end

Defined in actioncable/lib/action_cable/connection/base.rb line 120 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionCable::Connection::Base

Signature

Parameters