From: Florian Forster Date: Sun, 22 Feb 2009 18:00:23 +0000 (+0100) Subject: collectd-java(5): Update the documentation. X-Git-Tag: collectd-4.7.0~114^2~22 X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=4382a1ee772b0bc4b601cd0ba72d59463d0268eb;p=collectd.git collectd-java(5): Update the documentation. Especially add the new ``native'' methods. --- diff --git a/src/collectd-java.pod b/src/collectd-java.pod index 02feff6e..013bf893 100644 --- a/src/collectd-java.pod +++ b/src/collectd-java.pod @@ -193,7 +193,26 @@ All collectd API functions that are available to Java plugins are implemented as Istatic> functions of the B class. This makes calling these functions pretty straight forward. -The currently exported functions are: +The following are the currently exported functions. For information on the +interfaces used, please see L<"REGISTERING CALLBACKS"> above. + +=head2 registerConfig + +Signature: I B (I name, +I object); + +Registers the B function of I with the daemon. + +Returns zero upon success and non-zero when an error occurred. + +=head2 registerInit + +Signature: I B (I name, +I object); + +Registers the B function of I with the daemon. + +Returns zero upon success and non-zero when an error occurred. =head2 registerRead @@ -201,8 +220,6 @@ Signature: I B (I name, I object) Registers the B function of I with the daemon. -For a description of the B interface, see -L<"REGISTERING CALLBACKS"> above. Returns zero upon success and non-zero when an error occurred. @@ -212,8 +229,15 @@ Signature: I B (I name, I object) Registers the B function of I with the daemon. -For a description of the B interface, see -L<"REGISTERING CALLBACKS"> above. + +Returns zero upon success and non-zero when an error occurred. + +=head2 registerShutdown + +Signature: I B (I name, +I object); + +Registers the B function of I with the daemon. Returns zero upon success and non-zero when an error occurred. @@ -235,6 +259,36 @@ Signature: I B (I) Returns the approrpate I or B if the type is not defined. +=head2 logError + +Signature: I B (I) + +Sends a log message with severity B to the daemon. + +=head2 logWarning + +Signature: I B (I) + +Sends a log message with severity B to the daemon. + +=head2 logNotice + +Signature: I B (I) + +Sends a log message with severity B to the daemon. + +=head2 logInfo + +Signature: I B (I) + +Sends a log message with severity B to the daemon. + +=head2 logDebug + +Signature: I B (I) + +Sends a log message with severity B to the daemon. + =head1 SEE ALSO L,