class Vagrant::Plugin::V1::Communicator

Base class for a communicator in Vagrant. A communicator is responsible for communicating with a machine in some way. There are various stages of Vagrant that require things such as uploading files to the machine, executing shell commands, etc. Implementors of this class are expected to provide this functionality in some way.

Note that a communicator must provide all of the methods in this base class. There is currently no way for one communicator to provide say a more efficient way of uploading a file, but not provide shell execution. This sort of thing will come in a future version.

Public Class Methods

match?(machine) click to toggle source

This returns true/false depending on if the given machine can be communicated with using this communicator. If this returns ‘true`, then this class will be used as the primary communication method for the machine.

@return [Boolean]

# File lib/vagrant/plugin/v1/communicator.rb, line 23
def self.match?(machine)
  false
end
new(machine) click to toggle source

Initializes the communicator with the machine that we will be communicating with. This base method does nothing (it doesn’t even store the machine in an instance variable for you), so you’re expected to override this and do something with the machine if you care about it.

@param [Machine] machine The machine this instance is expected to

communicate with.
# File lib/vagrant/plugin/v1/communicator.rb, line 35
def initialize(machine)
end

Public Instance Methods

download(from, to) click to toggle source

Download a file from the remote machine to the local machine.

@param [String] from Path of the file on the remote machine. @param [String] to Path of where to save the file locally.

# File lib/vagrant/plugin/v1/communicator.rb, line 51
def download(from, to)
end
execute(command, opts=nil) click to toggle source

Execute a command on the remote machine. The exact semantics of this method are up to the implementor, but in general the users of this class will expect this to be a shell.

This method gives you no way to write data back to the remote machine, so only execute commands that don’t expect input.

@param [String] command Command to execute. @yield [type, data] Realtime output of the command being executed. @yieldparam [String] type Type of the output. This can be

`:stdout`, `:stderr`, etc. The exact types are up to the
implementor.

@yieldparam [String] data Data for the given output. @return [Integer] Exit code of the command.

# File lib/vagrant/plugin/v1/communicator.rb, line 76
def execute(command, opts=nil)
end
ready?() click to toggle source

Checks if the target machine is ready for communication. If this returns true, then all the other methods for communicating with the machine are expected to be functional.

@return [Boolean]

# File lib/vagrant/plugin/v1/communicator.rb, line 43
def ready?
  false
end
sudo(command, opts=nil) click to toggle source

Executes a command on the remote machine with administrative privileges. See {#execute} for documentation, as the API is the same.

@see execute

# File lib/vagrant/plugin/v1/communicator.rb, line 84
def sudo(command, opts=nil)
end
test(command, opts=nil) click to toggle source

Executes a command and returns true if the command succeeded, and false otherwise. By default, this executes as a normal user, and it is up to the communicator implementation if they expose an option for running tests as an administrator.

@see execute

# File lib/vagrant/plugin/v1/communicator.rb, line 93
def test(command, opts=nil)
end
upload(from, to) click to toggle source

Upload a file to the remote machine.

@param [String] from Path of the file locally to upload. @param [String] to Path of where to save the file on the remote

machine.
# File lib/vagrant/plugin/v1/communicator.rb, line 59
def upload(from, to)
end