Module sidejob

Function Index

call/2 Same as call/3 with a default timeout of 5 seconds.
call/3 Perform a synchronous call to the specified resource, failing if the resource has reached its usage limit.
cast/2 Perform an asynchronous cast to the specified resource, failing if the resource has reached its usage limit.
new_resource/3 Same as new_resource/4 except that the number of workers defaults to the number of scheduler threads.
new_resource/4 Create a new sidejob resource that uses the provided worker module, enforces the requested usage limit, and is managed by the specified number of worker processes.
resource_exists/1 Check if the specified resource exists.
unbounded_cast/2 Perform an asynchronous cast to the specified resource, ignoring usage limits.

Function Details

call/2

call(Name, Msg) -> any()

Same as call/3 with a default timeout of 5 seconds.

call/3

call(Name, Msg, Timeout) -> any()

Perform a synchronous call to the specified resource, failing if the resource has reached its usage limit.

cast/2

cast(Name, Msg) -> any()

Perform an asynchronous cast to the specified resource, failing if the resource has reached its usage limit.

new_resource/3

new_resource(Name, Mod, Limit) -> any()

Same as new_resource/4 except that the number of workers defaults to the number of scheduler threads.

new_resource/4

new_resource(Name, Mod, Limit, Workers) -> any()

Create a new sidejob resource that uses the provided worker module, enforces the requested usage limit, and is managed by the specified number of worker processes.

This call will generate and load a new module, via sidejob_config, that provides information about the new resource. It will also start up the supervision hierarchy that manages this resource: ensuring that the workers and stats aggregation server for this resource remain running.

resource_exists/1

resource_exists(Mod::atom()) -> boolean()

Check if the specified resource exists. Erlang docs call out that using erlang:module_exists should not be used, so try to call a function on the module in question and, if it succeeds, return true. Otherwise, the module hasn't been created so return false.

unbounded_cast/2

unbounded_cast(Name, Msg) -> any()

Perform an asynchronous cast to the specified resource, ignoring usage limits


Generated by EDoc