pnx/archived
Archived
1
0
Fork 0
Code Activity

docs: output

Browse source
This commit is contained in:
H Hautakoski 2010-09-22 13:46:21 +02:00 • committed by Henrik Hautakoski
parent df67148db5
commit e8c73df6b5
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/output.txt
View file

@ -10,8 +10,10 @@ processing.
The output drivers have complete access to the configuration file to allow them The output drivers have complete access to the configuration file to allow them
a way to get user defined input. Eg. database access information. a way to get user defined input. Eg. database access information.
At this time we only provide two different output drivers. One for mysql and !NOTE! functions that returns and integer always has the following specification:
one for stdout.
zero if everything went well and a non zero value that indicates an error
that later can be identified by the output_error() function.
-- functions -- functions
@ -20,11 +22,13 @@ output_init():
This function is called on startup and allows the output driver to initialize This function is called on startup and allows the output driver to initialize
stuff that is needed later on. Eg. loading configuration options and/or connecting stuff that is needed later on. Eg. loading configuration options and/or connecting
to the database. to the database.
output_process(): output_process():
Is called every time a new event is triggered. The event is passed to the function Is called every time a new event is triggered. The event is passed to the function
and after that it is up to the driver to do some magic. and after that it is up to the driver to do some magic. NOTE that you are not supposed to free the memory
for the basic reason that you don't know now how it was allocated and even if you knew, it may change and
we are stuck with inconsistent modules.
output_error(): output_error():