class Net::SSH::Multi::DynamicServer

  1. lib/net/ssh/multi/dynamic_server.rb
Parent: Multi

Represents a lazily evaluated collection of servers. This will usually be created via Net::SSH::Multi::Session#use(&block), and is useful for creating server definitions where the name or address of the servers are not known until run-time.

session.use { lookup_ip_address_of_server }

This prevents lookup_ip_address_of_server from being invoked unless the server is actually needed, at which point it is invoked and the result cached.

The callback should return either nil (in which case no new servers are instantiated), a String (representing a connection specification), an array of Strings, or an array of Net::SSH::Multi::Server instances.

Methods

Public Class

  1. new

Public Instance

  1. []
  2. []=
  3. callback
  4. each
  5. evaluate!
  6. master
  7. options

Public Instance Aliases

to_ary -> evaluate!

Attributes

callback [R]

The Proc object to call to evaluate the server(s)
master [R]

The Net::SSH::Multi::Session instance that owns this dynamic server record.
options [R]

The hash of options that will be used to initialize the server records.

Public Class methods

new (master, options, callback)

Create a new DynamicServer record, owned by the given Net::SSH::Multi::Session master, with the given hash of options, and using the given Proc callback to lazily evaluate the actual server instances.

[show source] 
# File lib/net/ssh/multi/dynamic_server.rb, line 32
def initialize(master, options, callback)
  @master, @options, @callback = master, options, callback
  @servers = nil
end

Public Instance methods

[] (key)

Returns the value for the given key in the :properties hash of the options. If no :properties hash exists in options, this returns nil.

[show source] 
# File lib/net/ssh/multi/dynamic_server.rb, line 39
def [](key)
  (options[:properties] ||= {})[key]
end
[]= (key, value)

Sets the given key/value pair in the :properties key in the options hash. If the options hash has no :properties key, it will be created.

[show source] 
# File lib/net/ssh/multi/dynamic_server.rb, line 45
def []=(key, value)
  (options[:properties] ||= {})[key] = value
end
each ()

Iterates over every instantiated server record in this dynamic server. If the servers have not yet been instantiated, this does nothing (e.g., it does not automatically invoke evaluate!).

[show source] 
# File lib/net/ssh/multi/dynamic_server.rb, line 52
def each
  (@servers || []).each { |server| yield server }
end
evaluate! ()

Evaluates the callback and instantiates the servers, memoizing the result. Subsequent calls to evaluate! will simply return the cached list of servers.

[show source] 
# File lib/net/ssh/multi/dynamic_server.rb, line 59
def evaluate!
  @servers ||= Array(callback[options]).map do |server|
      case server
      when String then Net::SSH::Multi::Server.new(master, server, options)
      else server
      end
    end
end