2010-02-19 Pablo de la Concepción <pablo.concepcion@artica.es>

* lib/PandoraFMS/Core.pm: Updated docuemtation of the interface.

	* man/man3/PandoraFMS::Core.pm.3: Updated manpage with the new
	documentation of the interface



git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@2389 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f
This commit is contained in:
Pablo de la Concepción Sanz 2010-02-19 14:26:09 +00:00
parent 24d57bbcbf
commit 2f878ad76e
3 changed files with 33 additions and 6 deletions

View File

@ -1,3 +1,11 @@
2010-02-19 Pablo de la Concepción <pablo.concepcion@artica.es>
* lib/PandoraFMS/Core.pm: Updated docuemtation of the interface.
* man/man3/PandoraFMS::Core.pm.3: Updated manpage with the new
documentation of the interface
2010-02-19 Ramon Novoa <rnovoa@artica.es>
* lib/PandoraFMS/Core.pm: Enabled FF protection for module states
@ -13,9 +21,7 @@
* lib/PandoraFMS/Core.pm: Restored documentation lost in one of the
last commits.
* man/man3/PandoraFMS::Core.pm.3: Updated manpage with the restored
documentatrestored
documentation
2010-02-18 Pablo de la Concepción <pablo.concepcion@artica.es>

View File

@ -88,11 +88,16 @@ Exported Functions:
=item * C<pandora_update_server>
=item * C<pandora_group_statistics>
=item * C<pandora_server_statistics>
=item * C<pandora_self_monitoring>
=back
=head1 METHODS
=cut
use strict;
@ -1994,6 +1999,4 @@ L<DBI>, L<XML::Simple>, L<HTML::Entities>, L<Time::Local>, L<POSIX>, L<PandoraFM
Copyright (c) 2005-2010 Artica Soluciones Tecnologicas S.L
=cut

View File

@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "PandoraFMS::Core 3"
.TH PandoraFMS::Core 3 "2010-02-18" "perl v5.10.0" "User Contributed Perl Documentation"
.TH PandoraFMS::Core 3 "2010-02-19" "perl v5.10.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@ -194,6 +194,12 @@ This module contains all the base functions of \fBPandora \s-1FMS\s0\fR, the mos
\&\f(CW\*(C`pandora_update_module_on_error\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`pandora_update_server\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`pandora_group_statistics\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`pandora_server_statistics\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`pandora_self_monitoring\*(C'\fR
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """pandora_generate_alerts (\fI$pa_config\fP \fI$data\fP \fI$status\fP \fI$agent\fP \fI$module\fP \fI$utimestamp\fP \fI$dbh\fP)"""
@ -327,6 +333,18 @@ Updates agent \s-1GIS\s0 information in \fBtgis_data_status\fR table.
.el .SS "\f(CWarchive_agent_position (\fP\f(CI$pa_config\fP\f(CW, \fP\f(CI$start_timestamp\fP\f(CW, \fP\f(CI$end_timestamp\fP\f(CW, \fP\f(CI$longitude\fP\f(CW, \fP\f(CI$latitude\fP\f(CW, \fP\f(CI$altitude\fP\f(CW, \fP\f(CI$description\fP\f(CW, \fP\f(CI$number_packages\fP\f(CW, \fP\f(CI$agent_id\fP\f(CW, \fP\f(CI$dbh\fP\f(CW)\fP"
.IX Subsection "archive_agent_position ($pa_config, $start_timestamp, $end_timestamp, $longitude, $latitude, $altitude, $description, $number_packages, $agent_id, $dbh)"
Archives the last position of an agent in the \fBtgis_data_history\fR table
.ie n .SS """pandora_server_statistics (\fI$pa_config\fP, \fI$dbh\fP)"""
.el .SS "\f(CWpandora_server_statistics (\fP\f(CI$pa_config\fP\f(CW, \fP\f(CI$dbh\fP\f(CW)\fP"
.IX Subsection "pandora_server_statistics ($pa_config, $dbh)"
Process server statistics for statistics table
.ie n .SS """pandora_group_statistics (\fI$pa_config\fP, \fI$dbh\fP)"""
.el .SS "\f(CWpandora_group_statistics (\fP\f(CI$pa_config\fP\f(CW, \fP\f(CI$dbh\fP\f(CW)\fP"
.IX Subsection "pandora_group_statistics ($pa_config, $dbh)"
Process groups statistics for statistics table
.ie n .SS """pandora_self_monitoring (\fI$pa_config\fP, \fI$dbh\fP)"""
.el .SS "\f(CWpandora_self_monitoring (\fP\f(CI$pa_config\fP\f(CW, \fP\f(CI$dbh\fP\f(CW)\fP"
.IX Subsection "pandora_self_monitoring ($pa_config, $dbh)"
Pandora self monitoring process
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
\&\s-1DBI\s0, XML::Simple, HTML::Entities, Time::Local, \s-1POSIX\s0, PandoraFMS::DB, PandoraFMS::Config, PandoraFMS::Tools, PandoraFMS::GIS