Module valeo

command/2	Syntactic sugar for port_command/2 call.
command/3	Syntactic sugar for port_command/3 call.
exec_find/1	Equivalent to exec_find(ProgName, ?MODULE).
exec_find/2	Returns the executable pathname by: first, checking the "priv" directory associated with module Mod second, using the %PATH% environment variable .
exec_line/2	Returns a formatted command line.
proc_id/1	Returns the OS process ID for the program under control.
revision/0	Returns the current VALEO revision number.
start_link/3	Start a named VALEO server and link it the calling process.
state/1	Returns the internal state of the program under control.
stop/1	Stop the Valeo port program.
version/0	Returns the current VALEO version number.

Function Details

command(Pid::pid() | atom, IoData::iodata()) -> ok

Syntactic sugar for port_command/2 call.

command(Pid::pid() | atom, IoData::iodata(), Opts::port_cmd_opts()) -> ok

Syntactic sugar for port_command/3 call.

exec_find(ProgName::string()) -> string() | false

Equivalent to exec_find(ProgName, ?MODULE).

exec_find(ProgName::string(), Mod::atom()) -> string() | false

Returns the executable pathname by:

Returns the full pathname, or 'false' otherwise.

Eg.: valeo:exec_find("ssh").

exec_line(Cmd::string(), CmdParams::cmd_params()) -> string() | false

Returns a formatted command line. Eg.: valeo:exec_line("ssh", [{"-p", 22}, "foo@10.11.81.3"]).

proc_id(Pid::pid() | atom) -> non_neg_integer() | undefined

Returns the OS process ID for the program under control.

revision() -> string()

Returns the current VALEO revision number.

start_link(Module::atom(), ProgArgs::proplist(), PortArgs::proplist()) -> {ok, pid()}

Start a named VALEO server and link it the calling process.

port_pidfile: a file path which will contain the OS process ID of the external program. This is a mandatory field.
port_mode: defines how Valeo is supposed to interact with the external program. The 'passsive' atom means no interaction should take place (no input/output is involved). The 'active' atom means data should be sent or received.
port_opts: equivalent to the 2nd argument (PortSettings) of open_port/2 call.
port_stop_after: force the external program to stop (by sending a kill signal) if it hangs more than N seconds (default 20sec.) after calling valeo:stop/1.

state(Pid::pid() | atom) -> term() | undefined

Returns the internal state of the program under control.

stop(Pid::pid() | atom) -> ok

Stop the Valeo port program.

version() -> string()

Returns the current VALEO version number.

Generated by EDoc, May 6 2013, 23:03:07.