diff --git a/src/modules/call_out/doc/call_out b/src/modules/call_out/doc/call_out new file mode 100644 index 0000000000000000000000000000000000000000..6eccf4ad52d699ec35fa1bbded0fbf4a5fd4886a --- /dev/null +++ b/src/modules/call_out/doc/call_out @@ -0,0 +1,12 @@ +NAME + call_out - make a delayed call to a function + +SYNTAX + void call_out(function f, int delay, mixed ... args); + +DESCRIPTION + Call_out places a call to the function f with the argument args + in a queue to be called in about delay seconds. + +SEE ALSO + remove_call_out, find_call_out, call_out_info diff --git a/src/modules/call_out/doc/call_out_info b/src/modules/call_out/doc/call_out_info new file mode 100644 index 0000000000000000000000000000000000000000..1b20ed39627716e8aebe55bc65cbafca6458929e --- /dev/null +++ b/src/modules/call_out/doc/call_out_info @@ -0,0 +1,22 @@ +NAME + call_out_info - get info about all call outs + +SYNTAX + mixed **call_out_info(); + +DESCRIPTION + This function returns an array with one entry for each entry in the + call out queue. The first in the queue will be in index 0. Each index + contains an array that looks like this: + + ({ + time_left, /* an int */ + caller, /* the object that made the call out */ + function, /* the function to be called */ + arg1, /* the first argument, if any */ + arg2, /* the second argument, if any */ + ... /* and so on... */ + }) + +SEE ALSO + call_out, find_call_out, remove_call_out diff --git a/src/modules/call_out/doc/find_call_out b/src/modules/call_out/doc/find_call_out new file mode 100644 index 0000000000000000000000000000000000000000..39e39cc45623d174d909bfd9f8c2b597b20ab876 --- /dev/null +++ b/src/modules/call_out/doc/find_call_out @@ -0,0 +1,13 @@ +NAME + find_call_out - find a call out in the queue + +SYNTAX + int find_call_out(function f); + +DESCRIPTION + This function searches the call out queue, and returns the time left + to this call out will be done in seconds. If no call is found, + zero_type(find_call_out(f)) will return 1. + +SEE ALSO + call_out, remove_call_out, call_out_info diff --git a/src/modules/call_out/doc/remove_call_out b/src/modules/call_out/doc/remove_call_out new file mode 100644 index 0000000000000000000000000000000000000000..277cc9eb0a2bd30f93927a221591ca394f776116 --- /dev/null +++ b/src/modules/call_out/doc/remove_call_out @@ -0,0 +1,14 @@ +NAME + remove_call_out - remove a call out from the call out queue + +SYNTAX + int remove_call_out(function f); + +DESCRIPTION + This function finds the first call to the function f in the call + out queue and removes it. The time left to that call out will be + returned. If no call out was found, zero_type(remove_call_out(f)) + will return 1. + +SEE ALSO + call_out_info, call_out, find_call_out