| Overview |  |
load_file_response() = {module, Module::atom()} | {error, term()}
purge_response() = boolean()
| build_tree/3 | Convert a list of elements into an N-ary tree. |
| chash_bucketonly_keyfun/1 | Object/ring hashing fun that ignores Key, only uses Bucket. |
| chash_key/1 | Create a binary used for determining replica placement. |
| chash_key/2 | Create a binary used for determining replica placement. |
| chash_std_keyfun/1 | Default object/ring hashing fun, direct passthrough of bkey. |
| compare_dates/2 | Compare two RFC1123 date strings or two now() tuples (or one of each). |
| compose/1 | Function composition: returns a function that is the composition of all
functions in the Funs list. |
| compose/2 | Function composition: returns a function that is the composition of
F and G. |
| count/2 | Applies Pred to each element in List, and returns a count of how many
applications returned true. |
| disable_job_class/1 | Internal API to disable the specified job class. |
| disable_job_class/2 | Disables the specified Application/Operation job class. |
| enable_job_class/1 | Internal API to enable the specified job class. |
| enable_job_class/2 | Enables the specified Application/Operation job class. |
| format_ip_and_port/2 | |
| integer_to_list/2 | Convert an integer to its string representation in the given base. |
| is_arch/1 | |
| job_class_disabled_message/2 | The error message to be returned to a client for a disabled job class. |
| job_class_enabled/1 | Internal API to determine whether to accept/reject a job. |
| job_class_enabled/2 | Reports whether the specified Application/Operation job class is enabled. |
| keydelete/2 | Returns a copy of TupleList where the first occurrence of a tuple whose
first element compares equal to Key is deleted, if there is such a tuple. |
| make_fold_req/1 | Convert a #riak_core_fold_req_v? record to the cluster's maximum supported record version. |
| make_fold_req/2 | |
| make_fold_req/4 | |
| make_newest_fold_req/1 | Force a #riak_core_fold_req_v? record to the latest version, regardless of cluster support. |
| make_tmp_dir/0 | Create a unique directory in /tmp. |
| md5/1 | |
| mkclientid/1 | Create a unique-enough id for vclock clients. |
| moment/0 | Get the current "moment". |
| multi_keydelete/2 | Returns a copy of TupleList where the first occurrence of a tuple whose
first element compares equal to any key in KeysToDelete is deleted, if
there is such a tuple. |
| multi_keydelete/3 | Returns a copy of TupleList where the Nth occurrence of a tuple whose
first element compares equal to any key in KeysToDelete is deleted, if
there is such a tuple. |
| multi_rpc/4 | Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. |
| multi_rpc/5 | Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. |
| multi_rpc_ann/4 | Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. |
| multi_rpc_ann/5 | Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. |
| multicall_ann/4 | Similar to rpc:multicall/4. |
| multicall_ann/5 | Similar to rpc:multicall/6. |
| orddict_delta/2 | |
| peername/2 | |
| pmap/2 | Invoke function F over each element of list L in parallel,
returning the results in the same order as the input list. |
| pmap/3 | Parallel map with a cap on the number of concurrent worker processes. |
| proxy_spawn/1 | Spawn an intermediate proxy process to handle errors during gen_xxx calls. |
| reload_all/1 | Ask each member node of the riak ring to reload the given Module. |
| replace_file/2 | Atomically/safely (to some reasonable level of durablity)
replace file FN with Data. |
| report_job_request_disposition/6 | Report/record the disposition of an async job request. |
| rpc_every_member/4 | Make an RPC call to the given module and function on each member of the cluster. |
| rpc_every_member_ann/4 | Same as rpc_every_member/4, but annotate the result set with the name of the node returning the result. |
| safe_rpc/4 | Wraps an rpc:call/4 in a try/catch to handle the case where the 'rex' process is not running on the remote node. |
| safe_rpc/5 | Wraps an rpc:call/5 in a try/catch to handle the case where the 'rex' process is not running on the remote node. |
| sha/1 | |
| shuffle/1 | |
| sockname/2 | |
| start_app_deps/1 | Start depedent applications of App. |
| str_to_node/1 | |
| unique_id_62/0 | Create a random identifying integer, returning its string representation in base 62. |
build_tree(N::integer(), Nodes::[term()], Opts::[term()]) -> orddict:orddict()
Convert a list of elements into an N-ary tree. This conversion works by treating the list as an array-based tree where, for example in a binary 2-ary tree, a node at index i has children 2i and 2i+1. The conversion also supports a "cycles" mode where the array is logically wrapped around to ensure leaf nodes also have children by giving them backedges to other elements.
chash_bucketonly_keyfun(BKey::riak_object:bkey()) -> chash:index()
Object/ring hashing fun that ignores Key, only uses Bucket.
chash_key(BKey::riak_object:bkey()) -> chash:index()
Create a binary used for determining replica placement.
chash_key(BKey::riak_object:bkey(), BucketProps::[{atom(), any()}]) -> chash:index()
Create a binary used for determining replica placement.
chash_std_keyfun(BKey::riak_object:bkey()) -> chash:index()
Default object/ring hashing fun, direct passthrough of bkey.
compare_dates(A::string(), B::string()) -> boolean()
Compare two RFC1123 date strings or two now() tuples (or one of each). Return true if date A is later than date B.
compose(Funs::[fun((any()) -> any())]) -> fun((any()) -> any())
Function composition: returns a function that is the composition of all
functions in the Funs list. Note that functions are composed from right to
left, so the final function in the Funs will be the first one invoked when
invoking the composed function.
compose(F::fun((B) -> C), G::fun((A) -> B)) -> fun((A) -> C)
Function composition: returns a function that is the composition of
F and G.
count(Pred::fun((term()) -> boolean()), List::[term()]) -> non_neg_integer()
Applies Pred to each element in List, and returns a count of how many
applications returned true.
disable_job_class(Class::term()) -> ok | {error, term()}
Internal API to disable the specified job class. WARNING: * This function may not remain in this form once the Jobs API is live! * Parameter types ARE NOT validated by the same rules as the public API! You are STRONGLY advised to use disable_job_class/2.
disable_job_class(Application::atom(), Operation::atom()) -> ok | {error, term()}
Disables the specified Application/Operation job class. This is the public API for use via RPC. WARNING: This function is not suitable for parallel execution with itself or its complement enable_job_class/2.
enable_job_class(Class::term()) -> ok | {error, term()}
Internal API to enable the specified job class. WARNING: * This function may not remain in this form once the Jobs API is live! * Parameter types ARE NOT validated by the same rules as the public API! You are STRONGLY advised to use enable_job_class/2.
enable_job_class(Application::atom(), Operation::atom()) -> ok | {error, term()}
Enables the specified Application/Operation job class. This is the public API for use via RPC. WARNING: This function is not suitable for parallel execution with itself or its complement disable_job_class/2.
format_ip_and_port(Ip, Port) -> any()
integer_to_list(Integer::integer(), Base::integer()) -> string()
Convert an integer to its string representation in the given base. Bases 2-62 are supported.
is_arch(Arch::atom()) -> boolean()
job_class_disabled_message(ReturnType::atom(), Class::term()) -> binary() | string()
The error message to be returned to a client for a disabled job class. WARNING: * This function is likely to be extended to accept a Job as well as a Class when the Jobs API is live.
job_class_enabled(Class::term()) -> boolean()
Internal API to determine whether to accept/reject a job. WARNING: * This function may not remain in this form once the Jobs API is live! * Parameter types ARE NOT validated by the same rules as the public API! You are STRONGLY advised to use job_class_enabled/2.
job_class_enabled(Application::atom(), Operation::atom()) -> boolean() | {error, term()}
Reports whether the specified Application/Operation job class is enabled. This is the public API for use via RPC.
keydelete(Key::atom(), TupleList::[tuple()]) -> [tuple()]
Returns a copy of TupleList where the first occurrence of a tuple whose
first element compares equal to Key is deleted, if there is such a tuple.
Equivalent to lists:keydelete(Key, 1, TupleList).
make_fold_req(Riak_core_fold_req_v1) -> any()
Convert a #riak_core_fold_req_v? record to the cluster's maximum supported record version.
make_fold_req(FoldFun, Acc0) -> any()
make_fold_req(FoldFun, Acc0, Forwardable, Opts) -> any()
make_newest_fold_req(Riak_core_fold_req_v1) -> any()
Force a #riak_core_fold_req_v? record to the latest version, regardless of cluster support
make_tmp_dir() -> string()
Create a unique directory in /tmp. Returns the path to the new directory.
md5(Bin) -> any()
mkclientid(RemoteNode::term()) -> ClientID::list()
Create a unique-enough id for vclock clients.
moment() -> integer()
Get the current "moment". Current implementation is the number of seconds from year 0 to now, universal time, in the gregorian calendar.
multi_keydelete(KeysToDelete::[atom()], TupleList::[tuple()]) -> [tuple()]
Returns a copy of TupleList where the first occurrence of a tuple whose
first element compares equal to any key in KeysToDelete is deleted, if
there is such a tuple.
multi_keydelete(KeysToDelete::[atom()], N::non_neg_integer(), TupleList::[tuple()]) -> [tuple()]
Returns a copy of TupleList where the Nth occurrence of a tuple whose
first element compares equal to any key in KeysToDelete is deleted, if
there is such a tuple.
multi_rpc(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()]) -> [any()]
Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list.
multi_rpc(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()], Timeout::timeout()) -> [any()]
Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list.
multi_rpc_ann(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()]) -> [{node(), any()}]
Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. Each result is tagged with the corresponding node name.
multi_rpc_ann(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()], Timeout::timeout()) -> [{node(), any()}]
Perform an RPC call to a list of nodes in parallel, returning the results in the same order as the input list. Each result is tagged with the corresponding node name.
multicall_ann(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()]) -> {Results::[{node(), any()}], Down::[node()]}
Similar to rpc:multicall/4. Performs an RPC call to a list
of nodes in parallel, returning a list of results as well as a list
of nodes that are down/unreachable. The results will be returned in
the same order as the input list, and each result is tagged with the
corresponding node name.
multicall_ann(Nodes::[node()], Mod::module(), Fun::atom(), Args::[any()], Timeout::timeout()) -> {Results::[{node(), any()}], Down::[node()]}
Similar to rpc:multicall/6. Performs an RPC call to a list
of nodes in parallel, returning a list of results as well as a list
of nodes that are down/unreachable. The results will be returned in
the same order as the input list, and each result is tagged with the
corresponding node name.
orddict_delta(A, B) -> any()
peername(Socket, Transport) -> any()
pmap(F, L1) -> L2
F = fun((A) -> B)L1 = [A]L2 = [B]
Invoke function F over each element of list L in parallel,
returning the results in the same order as the input list.
pmap(Fun::function(), List::list(), MaxP::integer()) -> list()
Parallel map with a cap on the number of concurrent worker processes. Note: Worker processes are linked to the parent, so a crash propagates.
proxy_spawn(Fun) -> any()
Spawn an intermediate proxy process to handle errors during gen_xxx calls.
reload_all(Module::atom()) -> [{purge_response(), load_file_response()}]
Ask each member node of the riak ring to reload the given Module. Return is a list of the results of code:purge/1 and code:load_file/1 on each node.
replace_file(FN::string(), Data::iodata()) -> ok | {error, term()}
Atomically/safely (to some reasonable level of durablity)
replace file FN with Data. NOTE: since 2.0.3 semantic changed
slightly: If FN cannot be opened, will not error with a
badmatch, as before, but will instead return {error, Reason}
report_job_request_disposition(Accepted::boolean(), Class::term(), Mod::module(), Func::atom(), Line::pos_integer(), Client::term()) -> ok | {error, term()}
Report/record the disposition of an async job request.
Logs an appropriate message and reports to whoever needs to know. WARNING: * This function is likely to be extended to accept a Job as well as a Class when the Jobs API is live.
Parameters: * Accepted - Whether the specified job Class is enabled. * Class - The Class of the job, by convention {Application, Operation}. * Mod/Func/Line - The Module, function, and source line number, respectively, that will be reported as the source of the call. * Client - Any term indicating the originator of the request. By convention, when meaningful client identification information is not available, Client is an atom representing the protocol through which the request was received.rpc_every_member(Module::atom(), Function::atom(), Args::[term()], Timeout::integer() | infinity) -> {Results::[term()], BadNodes::[node()]}
Make an RPC call to the given module and function on each member of the cluster. See rpc:multicall/5 for a description of the return value.
rpc_every_member_ann(Module, Function, Args, Timeout) -> any()
Same as rpc_every_member/4, but annotate the result set with the name of the node returning the result.
safe_rpc(Node::node(), Module::atom(), Function::atom(), Args::[any()]) -> {badrpc, any()} | any()
Wraps an rpc:call/4 in a try/catch to handle the case where the 'rex' process is not running on the remote node. This is safe in the sense that it won't crash the calling process if the rex process is down.
safe_rpc(Node::node(), Module::atom(), Function::atom(), Args::[any()], Timeout::timeout()) -> {badrpc, any()} | any()
Wraps an rpc:call/5 in a try/catch to handle the case where the 'rex' process is not running on the remote node. This is safe in the sense that it won't crash the calling process if the rex process is down.
sha(Bin) -> any()
shuffle(L) -> any()
sockname(Socket, Transport) -> any()
start_app_deps(App::atom()) -> ok
Start depedent applications of App.
str_to_node(Node) -> any()
unique_id_62() -> string()
Create a random identifying integer, returning its string representation in base 62.
Generated by EDoc