diff options
Diffstat (limited to 'lib/net/ssh/multi/server.rb')
| -rw-r--r-- | lib/net/ssh/multi/server.rb | 116 |
1 files changed, 90 insertions, 26 deletions
diff --git a/lib/net/ssh/multi/server.rb b/lib/net/ssh/multi/server.rb index 338a870..65967ab 100644 --- a/lib/net/ssh/multi/server.rb +++ b/lib/net/ssh/multi/server.rb @@ -1,12 +1,31 @@ require 'net/ssh' module Net; module SSH; module Multi + # Encapsulates the connection information for a single remote server, as well + # as the Net::SSH session corresponding to that information. You'll rarely + # need to instantiate one of these directly: instead, you should use + # Net::SSH::Multi::Session#use. class Server + # The host name (or IP address) of the server to connect to. attr_reader :host + + # The user name to use when connecting to this server. attr_reader :user + + # The Hash of additional options to pass to Net::SSH when connecting + # (including things like :password, and so forth). attr_reader :options + + # The Net::SSH::Gateway instance to use to establish the connection. Will + # be +nil+ if the connection should be established without a gateway. attr_reader :gateway + # Creates a new Server instance with the given connection information. The + # +options+ hash must conform to the options described for Net::SSH::start, + # with one addition: + # + # * :via => a Net::SSH::Gateway instance to use when establishing a + # connection to this server. def initialize(host, user, options={}) @host = host @user = user @@ -14,14 +33,20 @@ module Net; module SSH; module Multi @gateway = @options.delete(:via) end + # Returns the value of the server property with the given +key+. Server + # properties are described via the +:properties+ key in the options hash + # when defining the Server. def [](key) - (@options[:properties] || {})[key] + (options[:properties] || {})[key] end + # Returns the port number to use for this connection. def port options[:port] || 22 end + # Compares the given +server+ to this instance, and returns true if they + # have the same host, user, and port. def eql?(server) host == server.host && user == server.user && @@ -30,10 +55,15 @@ module Net; module SSH; module Multi alias :== :eql? + # Generates a +Fixnum+ hash value for this object. This function has the + # property that +a.eql?(b)+ implies +a.hash == b.hash+. The + # hash value is used by class +Hash+. Any hash value that exceeds the + # capacity of a +Fixnum+ will be truncated before being used. def hash @hash ||= [host, user, port].hash end + # Returns a human-readable representation of this server instance. def to_s @to_s ||= begin s = "#{user}@#{host}" @@ -42,10 +72,28 @@ module Net; module SSH; module Multi end end + # Returns a human-readable representation of this server instance. def inspect @inspect ||= "#<%s:0x%x %s>" % [self.class.name, object_id, to_s] end + # Returns the Net::SSH session object for this server. If +ensure_open+ + # is false and the session has not previously been created, this will + # return +nil+. If +ensure_open+ is true, the session will be instantiated + # if it has not already been instantiated, via the +gateway+ if one is + # given, or directly (via Net::SSH::start) otherwise. + # + # if server.session.nil? + # puts "connecting..." + # server.session(true) + # end + # + # Note that the sessions returned by this are "enhanced" slightly, to make + # them easier to deal with in a multi-session environment: they have a + # :server property automatically set on them, that refers to this object + # (the Server instance that spawned them). + # + # assert_equal server, server.session[:server] def session(ensure_open=false) return @session if @session || !ensure_open @session ||= begin @@ -62,38 +110,54 @@ module Net; module SSH; module Multi raise Net::SSH::AuthenticationFailed.new("#{error.message}@#{host}") end - def close_channels - session.channels.each { |id, channel| channel.close } if session - end - - def close - session.transport.close if session - end - + # Returns +true+ if the session has been opened, and the session is currently + # busy (as defined by Net::SSH::Connection::Session#busy?). def busy?(include_invisible=false) session && session.busy?(include_invisible) end - def preprocess - session.preprocess if session - end + public # but not published, e.g., these are used internally only... + + # Closes all open channels on this server's session. If the session has + # not yet been opened, this does nothing. + def close_channels #:nodoc: + session.channels.each { |id, channel| channel.close } if session + end - def readers - return [] unless session - session.listeners.keys - end + # Closes this server's session's transport layer. If the session has not + # yet been opened, this does nothing. + def close #:nodoc: + session.transport.close if session + end - def writers - return [] unless session - session.listeners.keys.select do |io| - io.respond_to?(:pending_write?) && io.pending_write? + # Runs the session's preprocess action, if the session has been opened. + def preprocess #:nodoc: + session.preprocess if session end - end - def postprocess(readers, writers) - return true unless session - listeners = session.listeners.keys - session.postprocess(listeners & readers, listeners & writers) - end + # Returns all registered readers on the session, or an empty array if the + # session is not open. + def readers #:nodoc: + return [] unless session + session.listeners.keys + end + + # Returns all registered and pending writers on the session, or an empty + # array if the session is not open. + def writers #:nodoc: + return [] unless session + session.listeners.keys.select do |io| + io.respond_to?(:pending_write?) && io.pending_write? + end + end + + # Runs the post-process action on the session, if the session has been + # opened. Only the +readers+ and +writers+ that actually belong to this + # session will be postprocessed by this server. + def postprocess(readers, writers) #:nodoc: + return true unless session + listeners = session.listeners.keys + session.postprocess(listeners & readers, listeners & writers) + end end end; end; end
\ No newline at end of file |