Class: ActionCable::RemoteConnections::RemoteConnection

Inherits:
Object
  • Object
show all
Includes:
Connection::Identification, Connection::InternalChannel
Defined in:
lib/action_cable/remote_connections.rb

Overview

Represents a single remote connection found via ActionCable.server.remote_connections.where(*). Exists solely for the purpose of calling #disconnect on that connection.

Defined Under Namespace

Classes: InvalidIdentifiersError

Instance Method Summary collapse

Methods included from Connection::Identification

#connection_identifier

Constructor Details

#initialize(server, ids) ⇒ RemoteConnection

Returns a new instance of RemoteConnection.



37
38
39
40
 
# File 'lib/action_cable/remote_connections.rb', line 37

def initialize(server, ids)
  @server = server
  set_identifier_instance_vars(ids)
end

Instance Method Details

#disconnect ⇒ Object

Uses the internal channel to disconnect the connection.



43
44
45
 
# File 'lib/action_cable/remote_connections.rb', line 43

def disconnect
  server.broadcast internal_channel, type: "disconnect"
end

#identifiers ⇒ Object

Returns all the identifiers that were applied to this connection.



48
49
50
 
# File 'lib/action_cable/remote_connections.rb', line 48

def identifiers
  server.connection_identifiers
end