Module buffalo

Description
Data Types
Function Index
Function Details

Buffalo main API.

Copyright © 2012-2019 Arjan Scherpenisse

Authors: Arjan Scherpenisse (arjan@scherpenisse.net).

Description

Buffalo main API

Data Types

key()

key() = term()

mfargs()

mfargs() = {atom(), atom(), list()}

options()

options() = #{timeout => pos_integer(), deadline => pos_integer(), is_drop_running => boolean()}

Function Index

cancel/1	Cancel the MFA running.
cancel/3	(Deprecated.)
queue/2	Call the MFA after specified in `Options` time.
queue/3	Call the MFA after specified in `Options` time using specified `Key`.
queue/4	(Deprecated.)
queue/5	(Deprecated.)
start/0	Start application `buffalo`.
status/1	Check if the task with the specified key is running or queued.

Function Details

cancel/1

cancel(Key) -> Result

Key = mfargs() | key()
Result = ok | {error, notfound}

Cancel the MFA running.

cancel/3

cancel(Module, Function, Arguments) -> Result

Module = atom()
Function = atom()
Arguments = list()
Result = ok | {error, notfound}

This function is deprecated: Deprecated API

queue/2

queue(MFA, Opts) -> Result

MFA = mfargs()
Opts = options()
Result = {ok, existing | new | running}

Call the MFA after specified in Options time.

queue/3

queue(Key, MFA, Opts) -> Result

Key = key()
MFA = mfargs()
Opts = options()
Result = {ok, existing | new | running}

Call the MFA after specified in Options time using specified Key.

queue/4

queue(Module, Function, Arguments, Timeout) -> Result

Module = atom()
Function = atom()
Arguments = list()
Timeout = pos_integer()
Result = {ok, existing | new}

This function is deprecated: Deprecated API

queue/5

queue(Key, Module, Function, Arguments, Timeout) -> Result

Key = key()
Module = atom()
Function = atom()
Arguments = list()
Timeout = pos_integer()
Result = {ok, existing | new}

This function is deprecated: Deprecated API

start/0

start() -> Result

Result = ok | {error, Reason}
Reason = term()

Start application buffalo.

status/1

status(Key) -> Result

Key = key()
Result = {ok, queued | running} | {error, notfound}

Check if the task with the specified key is running or queued.

Generated by EDoc