123456789_123456789_123456789_123456789_123456789_

Class: ActionCable::SubscriptionAdapter::PostgreSQL

Do not use. This class is for internal use only.
Relationships & Source Files
Namespace Children
Classes:
Listener
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Base
Instance Chain:
self, ChannelPrefix, Base
Inherits: ActionCable::SubscriptionAdapter::Base
Defined in: actioncable/lib/action_cable/subscription_adapter/postgresql.rb

Class Method Summary

Base - Inherited

.new

Instance Attribute Summary

Base - Inherited

#logger, #server

Instance Method Summary

ChannelPrefix - Included

#broadcast, #subscribe, #unsubscribe,
#channel_with_prefix

Returns the channel name, including channel_prefix specified in cable.yml.

Base - Inherited

#broadcast, #identifier, #shutdown, #subscribe, #unsubscribe

Constructor Details

.new ⇒ PostgreSQL

[ GitHub ] 

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 12



def initialize(*)
  super
  @listener = nil
end


  







Instance Method Details



  

    #broadcast(channel, payload)  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 17



def broadcast(channel, payload)
  with_broadcast_connection do |pg_conn|
    pg_conn.exec("NOTIFY #{pg_conn.escape_identifier(channel_identifier(channel))}, '#{pg_conn.escape_string(payload)}'")
  end
end


  








  

    #channel_identifier(channel)   (private)
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 59



def channel_identifier(channel)
  channel.size > 63 ? OpenSSL::Digest::SHA1.hexdigest(channel) : channel
end


  








  

    #listener   (private)
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 63



def listener
  @listener || @server.mutex.synchronize { @listener ||= Listener.new(self, @server.event_loop) }
end


  








  

    #shutdown  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 31



def shutdown
  listener.shutdown
end


  








  

    #subscribe(channel, callback, success_callback = nil)  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 23



def subscribe(channel, callback, success_callback = nil)
  listener.add_subscriber(channel_identifier(channel), callback, success_callback)
end


  








  

    #unsubscribe(channel, callback)  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 27



def unsubscribe(channel, callback)
  listener.remove_subscriber(channel_identifier(channel), callback)
end


  








  

    #verify!(pg_conn)   (private)
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 67



def verify!(pg_conn)
  unless pg_conn.is_a?(PG::Connection)
    raise "The Active Record database must be PostgreSQL in order to use the PostgreSQL Action Cable storage adapter"
  end
end


  








  

    #with_broadcast_connection(&block)  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 50



def with_broadcast_connection(&block) # :nodoc:
  ActiveRecord::Base.connection_pool.with_connection do |ar_conn|
    pg_conn = ar_conn.raw_connection
    verify!(pg_conn)
    yield pg_conn
  end
end


  








  

    #with_subscriptions_connection(&block)  
  

  [ GitHub ]


  

  


# File 'actioncable/lib/action_cable/subscription_adapter/postgresql.rb', line 35



def with_subscriptions_connection(&block) # :nodoc:
  ar_conn = ActiveRecord::Base.connection_pool.checkout.tap do |conn|
    # Action Cable is taking ownership over this database connection, and
    # will perform the necessary cleanup tasks
    ActiveRecord::Base.connection_pool.remove(conn)
  end
  pg_conn = ar_conn.raw_connection

  verify!(pg_conn)
  pg_conn.exec("SET application_name = #{pg_conn.escape_identifier(identifier)}")
  yield pg_conn
ensure
  ar_conn.disconnect!
end