Skip to Content Skip to Search

This class encapsulates all the low-level logic of working with the underlying WebSocket connections and delegate all the business-logic to the user-level connection object (e.g., ApplicationCable::Connection). This connection object is also responsible for handling encoding and decoding of messages, so the user-level connection object shouldn’t know about such details.

Methods
C
N
P
R
S
T

Attributes

[R] connection
[R] env
[R] logger
[R] protocol
[R] server

Class Public methods

new(server, env, coder: ActiveSupport::JSON)

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 19
def initialize(server, env, coder: ActiveSupport::JSON)
  @server, @env, @coder = server, env, coder

  @worker_pool = server.worker_pool
  # Runs this socket's work on the worker pool's threads, one job at a time,
  # in the order it was posted.
  @serial_executor = Concurrent::SerializedExecutionDelegator.new(worker_pool.executor)
  @logger = server.new_tagged_logger { request }

  @websocket      = WebSocket.new(env, self, event_loop)
  @message_buffer = MessageBuffer.new(self)

  @protocol = nil
  @connection = config.connection_class.call.new(server, self)
end

Instance Public methods

close(...)

Close the WebSocket connection.

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 56
def close(...)
  websocket.close(...) if websocket.alive?
end

perform_work(receiver, method, *args)

Invoke a method on the connection asynchronously through the pool of thread workers. Like the connection’s commands, these calls run one at a time, in the order they were made.

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 63
def perform_work(receiver, method, *args)
  worker_pool.async_invoke(receiver, method, *args, connection: self, executor: @serial_executor)
end

request()

The request that initiated the WebSocket connection is available here. This gives access to the environment, cookies, etc.

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 75
def request
  @request ||= begin
    environment = Rails.application.env_config.merge(env) if defined?(Rails.application) && Rails.application
    ActionDispatch::Request.new(environment || env)
  end
end

send_async(method, *arguments)

Invoke a method on this socket through the pool of thread workers. These calls run one at a time, in the order they were made, so a client’s commands are handled in the order it sent them.

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 70
def send_async(method, *arguments)
  worker_pool.async_invoke(self, method, *arguments, executor: @serial_executor)
end

transmit(cable_message)

Send a non-serialized message over the WebSocket connection.

Source: show | on GitHub 

# File actioncable/lib/action_cable/server/socket.rb, line 49
def transmit(cable_message)
  return unless websocket.alive?

  websocket.transmit encode(cable_message)
end