| Overview |  |
| can_connect/0 | Attempts to connect to the local Riak node if it is not already, and returns whether connection was successful. |
| cluster_command/2 | Calls the given 0-arity module and function on all members of the Riak cluster. |
| cluster_command/3 | Calls the given module and function with the given arguments on all members of the Riak cluster. |
| cluster_command/4 | Calls the given module and function with the given arguments on all members for the Riak cluster, returning an error if the call doesn't complete within the given timeout. |
| local_command/2 | Calls the given 0-arity module and function on the local Riak node and returns the result of that call. |
| local_command/3 | Calls the given module and function with the given arguments on the local Riak node and returns the result of that call. |
| local_command/4 | Calls the given module and function with the given arguments on the local Riak node and returns the result of that call, returning an error if the call doesn't complete within the given timeout. |
| pid/0 | Retrieves the operating system's process ID of the local Riak node. |
| stats/0 | Fetches or returns previously fetched Riak statistics. |
can_connect() -> true | false
Attempts to connect to the local Riak node if it is not already, and returns whether connection was successful.
cluster_command(Module::atom(), Function::atom()) -> term()
Equivalent to cluster_command(Module, Function, []).
Calls the given 0-arity module and function on all members of the Riak cluster.
See also: can_connect/0.
cluster_command(Module::atom(), Function::atom(), Args::[term()]) -> term()
Equivalent to cluster_command(Module, Function, Args, 5000).
Calls the given module and function with the given arguments on all members of the Riak cluster.
See also: can_connect/0.
cluster_command(Module::atom(), Function::atom(), Args::[term()], Timeout::integer()) -> term()
Equivalent to rpc:multicall(RiakClusterMembers, Module, Function, Args, Timeout).
Calls the given module and function with the given arguments on all members for the Riak cluster, returning an error if the call doesn't complete within the given timeout.
See also: can_connect/0.
local_command(Module::atom(), Function::atom()) -> term()
Equivalent to local_command(Module, Function, []).
Calls the given 0-arity module and function on the local Riak node and returns the result of that call.
See also: can_connect/0.
local_command(Module::atom(), Function::atom(), Args::[term()]) -> term()
Equivalent to local_command(Module, Function, Args, 5000).
Calls the given module and function with the given arguments on the local Riak node and returns the result of that call.
See also: can_connect/0.
local_command(Module::atom(), Function::atom(), Args::[term()], Timeout::integer()) -> term()
Equivalent to rpc:call(RiakNodeName, Module, Function, Args, Timeout).
Calls the given module and function with the given arguments on the local Riak node and returns the result of that call, returning an error if the call doesn't complete within the given timeout.
See also: can_connect/0.
pid() -> string()
Equivalent to local_command(os, getpid).
Retrieves the operating system's process ID of the local Riak node.
See also: can_connect/0.
stats() -> [proplists:property()]
Fetches or returns previously fetched Riak statistics.
See also: can_connect/0.
Generated by EDoc, Feb 18 2012, 03:37:56.
