From 7333febb23bfcf4239536fe4a35d307a931cd44f Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Tue, 7 Jul 2015 22:42:02 +0200 Subject: Documentation --- lib/action_cable/connection/internal_channel.rb | 1 + lib/action_cable/connection/message_buffer.rb | 2 ++ lib/action_cable/connection/subscriptions.rb | 2 ++ 3 files changed, 5 insertions(+) (limited to 'lib') diff --git a/lib/action_cable/connection/internal_channel.rb b/lib/action_cable/connection/internal_channel.rb index baf916dffa..b00e21824c 100644 --- a/lib/action_cable/connection/internal_channel.rb +++ b/lib/action_cable/connection/internal_channel.rb @@ -1,5 +1,6 @@ module ActionCable module Connection + # Makes it possible for the RemoteConnection to disconnect a specific connection. module InternalChannel extend ActiveSupport::Concern diff --git a/lib/action_cable/connection/message_buffer.rb b/lib/action_cable/connection/message_buffer.rb index 615266e0cb..d5a8e9eba9 100644 --- a/lib/action_cable/connection/message_buffer.rb +++ b/lib/action_cable/connection/message_buffer.rb @@ -1,5 +1,7 @@ module ActionCable module Connection + # Allows us to buffer messages received from the websocket before the Connection has been fully initialized and is ready to receive them. + # Entirely internal operation and should not be used directly by the user. class MessageBuffer def initialize(connection) @connection = connection diff --git a/lib/action_cable/connection/subscriptions.rb b/lib/action_cable/connection/subscriptions.rb index 29ca657d5a..803894c8f6 100644 --- a/lib/action_cable/connection/subscriptions.rb +++ b/lib/action_cable/connection/subscriptions.rb @@ -1,5 +1,7 @@ module ActionCable module Connection + # Collection class for all the channel subscriptions established on a given connection. Responsible for routing incoming commands that arrive on + # the connection to the proper channel. Should not be used directly by the user. class Subscriptions def initialize(connection) @connection = connection -- cgit v1.2.3