Module: ActionCable

Relationships & Source Files
Namespace Children
Modules: `Channel`, `Connection`, `Helpers`, `Server`, `SubscriptionAdapter`, `TestHelper`, `VERSION`
Classes: `Engine`, `RemoteConnections`, `TestCase`
Defined in:	actioncable/lib/action_cable.rb, actioncable/lib/action_cable/deprecator.rb, actioncable/lib/action_cable/engine.rb, actioncable/lib/action_cable/gem_version.rb, actioncable/lib/action_cable/remote_connections.rb, actioncable/lib/action_cable/test_case.rb, actioncable/lib/action_cable/test_helper.rb, actioncable/lib/action_cable/version.rb, actioncable/lib/action_cable/channel/base.rb, actioncable/lib/action_cable/channel/broadcasting.rb, actioncable/lib/action_cable/channel/callbacks.rb, actioncable/lib/action_cable/channel/naming.rb, actioncable/lib/action_cable/channel/periodic_timers.rb, actioncable/lib/action_cable/channel/streams.rb, actioncable/lib/action_cable/channel/test_case.rb, actioncable/lib/action_cable/connection/authorization.rb, actioncable/lib/action_cable/connection/base.rb, actioncable/lib/action_cable/connection/callbacks.rb, actioncable/lib/action_cable/connection/client_socket.rb, actioncable/lib/action_cable/connection/identification.rb, actioncable/lib/action_cable/connection/internal_channel.rb, actioncable/lib/action_cable/connection/message_buffer.rb, actioncable/lib/action_cable/connection/stream.rb, actioncable/lib/action_cable/connection/stream_event_loop.rb, actioncable/lib/action_cable/connection/subscriptions.rb, actioncable/lib/action_cable/connection/tagged_logger_proxy.rb, actioncable/lib/action_cable/connection/test_case.rb, actioncable/lib/action_cable/connection/web_socket.rb, actioncable/lib/action_cable/helpers/action_cable_helper.rb, actioncable/lib/action_cable/server/base.rb, actioncable/lib/action_cable/server/broadcasting.rb, actioncable/lib/action_cable/server/configuration.rb, actioncable/lib/action_cable/server/connections.rb, actioncable/lib/action_cable/server/worker.rb, actioncable/lib/action_cable/server/worker/active_record_connection_management.rb, actioncable/lib/action_cable/subscription_adapter/async.rb, actioncable/lib/action_cable/subscription_adapter/base.rb, actioncable/lib/action_cable/subscription_adapter/channel_prefix.rb, actioncable/lib/action_cable/subscription_adapter/inline.rb, actioncable/lib/action_cable/subscription_adapter/postgresql.rb, actioncable/lib/action_cable/subscription_adapter/redis.rb, actioncable/lib/action_cable/subscription_adapter/subscriber_map.rb, actioncable/lib/action_cable/subscription_adapter/test.rb

Overview

:markup: markdown

Constant Summary

INTERNAL =
# File 'actioncable/lib/action_cable.rb', line 58

{
  message_types: {
    welcome: "welcome",
    disconnect: "disconnect",
    ping: "ping",
    confirmation: "confirm_subscription",
    rejection: "reject_subscription"
  },
  disconnect_reasons: {
    unauthorized: "unauthorized",
    invalid_request: "invalid_request",
    server_restart: "server_restart",
    remote: "remote"
  },
  default_mount_path: "/cable",
  protocols: ["actioncable-v1-json", "actioncable-unsupported"].freeze
}

Class Method Summary

.gem_version

Returns the currently loaded version of Action Cable as a Gem::Version.
.version

Returns the currently loaded version of Action Cable as a Gem::Version.
.deprecator Internal use only

Class Method Details

.deprecator

This method is for internal use only.

[ GitHub ]

# File 'actioncable/lib/action_cable/deprecator.rb', line 6


def self.deprecator # :nodoc:
  @deprecator ||= ActiveSupport::Deprecation.new
end

.gem_version

Returns the currently loaded version of Action Cable as a Gem::Version.

[ GitHub ]

# File 'actioncable/lib/action_cable/gem_version.rb', line 7


def self.gem_version
  Gem::Version.new VERSION::STRING
end

.version

Returns the currently loaded version of Action Cable as a Gem::Version.

[ GitHub ]

# File 'actioncable/lib/action_cable/version.rb', line 9


def self.version
  gem_version
end