Specs

connect!(atom() | module(), keyword()) :: :ok

initiates a connection, bound to this process, using the specified module. You may also use a shorthand for the connection.

Examples

using explicit naming

Realbook.connect!(Realbook.Adapters.Local)

using shorthand names

Realbook.connect!(:ssh, host: host_ip, user: "admin")

Specs

eval(iodata(), Path.t(), keyword()) :: :ok

generates an Elixir module corresponding to a realbook script string or iodata; then evaluates the module, bound to this process.

If you provide only the script without a file, then the module will be an anonymous realbook module.

It is generally not recommended to use this function directly, but it may be useful for user debugging purposes or ad-hoc testing via the Elixir REPL.

Only use this function if you know what you are doing.

Specs

get(atom(), any()) :: term()

retrieves a value from the Realbook dictionary by its corresponding key.

See set/1 for details on how the key/values are stored.

Specs

run(Path.t()) :: :ok | no_return()

loads a script from the suppiled path, compiles it into a Realbook module and executes it.

If the module already exists, then the existing module will be run without recompilation.

Warning:

This does not currently check if the script has changed prior to deciding not to recompile, but that safety check may be revised in the future.

Specs

set(keyword()) :: :ok

puts keys into the Realbook dictionary.

This is a key-value store which stores "variables" for your Realbook scripts. Note that these key/values are stored in an ets table under the Realbook caller's process pid.

Typically, you will run set/1 prior to executing the Realbook script to satisfy all parameters that the it must have at runtime. The Realbook script performs a compile-time check to identify all necessary parameters and will refuse to run unless these parameters have been assigned.

Note that a spawned task will not have access to the Realbook key/value store of its parent. This may change in the future.

Compile and execute a realbook starting at this point in the code.

This form doesn't perform any interpolation.

This is the recommended entry point for realbooks, though you can also use run/1 to directly run a realbook file.

Example

defmodule MyRealbookEntryModule do

  # ...

  def run_realbooks do
    ~B"""
    requires ~w(realbook1 realbook2 realbook2)

    verify false

    play do
      # ...
      log "running realbooks"
    end
    """
  end

end

like sigil_B/2 but lets you interpolate values from the surrounding context.