Contents

require_relative 'websocket'
require_relative 'config'

module Pakyow
  module Realtime
    # Deals with realtime connections in context of an app. Instances are
    # returned by the `socket` helper method during routing.
    #
    # @api public
    class Context
      # @api private
      def initialize(app)
        @app = app
      end

      # Subscribe the current session's connection to one or more channels.
      #
      # @api public
      def subscribe(*channels)
        channels = Array.ensure(channels).flatten
        fail ArgumentError if channels.empty?

        delegate.subscribe(
          @app.socket_digest(@app.socket_connection_id),
          channels
        )
      end

      # Unsubscribe the current session's connection to one or more channels.
      #
      # @api public
      def unsubscribe(*channels)
        channels = Array.ensure(channels).flatten
        fail ArgumentError if channels.empty?

        delegate.unsubscribe(
          @app.socket_digest(@app.socket_connection_id),
          channels
        )
      end

      # Push a message down one or more channels.
      #
      # @api public
      def push(msg, *channels)
        channels = Array.ensure(channels).flatten
        fail ArgumentError if channels.empty?

        delegate.push(msg, channels)
      end

      # Returns an instance of the connection delegate.
      #
      # @api private
      def delegate
        Delegate.instance
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
pakyow-realtime-0.10.2	pakyow-realtime/lib/pakyow-realtime/context.rb
pakyow-realtime-0.10.1	pakyow-realtime/lib/pakyow-realtime/context.rb
pakyow-realtime-0.10.0	pakyow-realtime/lib/pakyow-realtime/context.rb