module ActionCable::Connection::Identification

Public Instance Methods

connection_identifier() Show source

# File actioncable/lib/action_cable/connection/identification.rb, line 26
def connection_identifier
  unless defined? @connection_identifier
    @connection_identifier = connection_gid identifiers.map { |id| instance_variable_get("@#{id}") }.compact
  end

  @connection_identifier
end

Return a single connection identifier that combines the value of all the registered identifiers into a single gid.

identified_by(*identifiers) Show source

# File actioncable/lib/action_cable/connection/identification.rb, line 19
def identified_by(*identifiers)
  Array(identifiers).each { |identifier| attr_accessor identifier }
  self.identifiers += identifiers
end

Mark a key as being a connection identifier index that can then be used to find the specific connection again later. Common identifiers are current_user and current_account, but could be anything, really.

Note that anything marked as an identifier will automatically create a delegate by the same name on any channel instances created off the connection.