class Ably::Realtime::Channels
Class that maintains a map of Channels
ensuring Channels
are reused
Public Class Methods
Source
# File lib/ably/realtime/channels.rb, line 9 def initialize(client) super client, Ably::Realtime::Channel end
@return [Ably::Realtime::Channels]
Ably::Modules::ChannelsCollection::new
Public Instance Methods
Source
# File lib/ably/realtime/channels.rb, line 33 def fetch(*args) super end
Return a {Ably::Realtime::Channel} for the given name if it exists, else the block will be called. This method is intentionally similar to {ruby-doc.org/core-2.1.3/Hash.html#method-i-fetch Hash#fetch} providing a simple way to check if a channel exists or not without creating one
@param name [String] The name of the channel @yield [options] (optional) if a missing_block is passed to this method and no channel exists matching the name, this block is called @yieldparam [String] name of the missing channel
@return [Ably::Realtime::Channel]
Ably::Modules::ChannelsCollection#fetch
Source
# File lib/ably/realtime/channels.rb, line 20 def get(*args) super end
Return a {Ably::Realtime::Channel} for the given name
@param name [String] The name of the channel @param channel_options [Hash, Ably::Models::ChannelOptions
] A hash of options or a {Ably::Models::ChannelOptions}
@return [Ably::Realtime::Channel]
Ably::Modules::ChannelsCollection#get
Source
# File lib/ably/realtime/channels.rb, line 61 def get_channel_serials channel_serials = {} self.each do |channel| channel_serials[channel.name] = channel.properties.channel_serial if channel.state == :attached end channel_serials end
@return [Hash] serials - map of channel name to respective channel serial @api private
Source
# File lib/ably/realtime/channels.rb, line 44 def release(channel) get(channel).detach do @channels.delete(channel) end if @channels.has_key?(channel) end
Detaches the {Ably::Realtime::Channel Realtime
Channel} and releases all associated resources.
Releasing a Realtime
Channel
is not typically necessary as a channel, once detached, consumes no resources other than the memory footprint of the {Ably::Realtime::Channel Realtime
Channel
object}. Release channels to free up resources if required
@return [void]
Source
# File lib/ably/realtime/channels.rb, line 53 def set_channel_serials(serials) serials.each do |channel_name, channel_serial| get(channel_name).properties.channel_serial = channel_serial end end
Sets channel serial to each channel from given serials hashmap @param [Hash] serials - map of channel name to respective channel serial @api private