projects
/
collectd.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
2bbdd96
)
bindings/java/: Add some javadoc markup to the interfaces.
author
Florian Forster
<octo@leeloo.lan.home.verplant.org>
Sun, 22 Feb 2009 23:05:35 +0000
(
00:05
+0100)
committer
Florian Forster
<octo@leeloo.lan.home.verplant.org>
Sun, 22 Feb 2009 23:05:35 +0000
(
00:05
+0100)
bindings/java/org/collectd/api/CollectdConfigInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdFlushInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdInitInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdLogInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdReadInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdShutdownInterface.java
patch
|
blob
|
history
bindings/java/org/collectd/api/CollectdWriteInterface.java
patch
|
blob
|
history
diff --git
a/bindings/java/org/collectd/api/CollectdConfigInterface.java
b/bindings/java/org/collectd/api/CollectdConfigInterface.java
index
fc6d9bd
..
7090507
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdConfigInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdConfigInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a config function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerConfig(String, CollectdConfigInterface)
+ */
public interface CollectdConfigInterface
{
public int config (OConfigItem ci);
public interface CollectdConfigInterface
{
public int config (OConfigItem ci);
diff --git
a/bindings/java/org/collectd/api/CollectdFlushInterface.java
b/bindings/java/org/collectd/api/CollectdFlushInterface.java
index
03fa532
..
abad042
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdFlushInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdFlushInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a flush function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerFlush
+ */
public interface CollectdFlushInterface
{
public int flush (int timeout, String identifier);
public interface CollectdFlushInterface
{
public int flush (int timeout, String identifier);
diff --git
a/bindings/java/org/collectd/api/CollectdInitInterface.java
b/bindings/java/org/collectd/api/CollectdInitInterface.java
index
6997a2f
..
c198036
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdInitInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdInitInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing an init function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerInit
+ */
public interface CollectdInitInterface
{
public int init ();
public interface CollectdInitInterface
{
public int init ();
diff --git
a/bindings/java/org/collectd/api/CollectdLogInterface.java
b/bindings/java/org/collectd/api/CollectdLogInterface.java
index
ab874c5
..
1ab9ae1
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdLogInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdLogInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a log function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerLog
+ */
public interface CollectdLogInterface
{
public void log (int severity, String message);
public interface CollectdLogInterface
{
public void log (int severity, String message);
diff --git
a/bindings/java/org/collectd/api/CollectdReadInterface.java
b/bindings/java/org/collectd/api/CollectdReadInterface.java
index
ac6060b
..
2ff25b2
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdReadInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdReadInterface.java
@@
-21,7
+21,27
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a read function.
+ *
+ * Objects implementing this interface can be registered with the daemon. Their
+ * read method is then called periodically to acquire and submit values.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerRead
+ */
public interface CollectdReadInterface
{
public interface CollectdReadInterface
{
+ /**
+ * Callback method for read plugins.
+ *
+ * This method is called once every few seconds (depends on the
+ * configuration of the daemon). It is supposed to gather values in
+ * some way and submit them to the daemon using
+ * {@link Collectd#dispatchValues}.
+ *
+ * @return zero when successful, non-zero when an error occurred.
+ * @see Collectd#dispatchValues
+ */
public int read ();
}
public int read ();
}
diff --git
a/bindings/java/org/collectd/api/CollectdShutdownInterface.java
b/bindings/java/org/collectd/api/CollectdShutdownInterface.java
index
4181a10
..
55e2740
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdShutdownInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdShutdownInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a shutdown function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerShutdown
+ */
public interface CollectdShutdownInterface
{
public int shutdown ();
public interface CollectdShutdownInterface
{
public int shutdown ();
diff --git
a/bindings/java/org/collectd/api/CollectdWriteInterface.java
b/bindings/java/org/collectd/api/CollectdWriteInterface.java
index
13315a6
..
a1220f5
100644
(file)
--- a/
bindings/java/org/collectd/api/CollectdWriteInterface.java
+++ b/
bindings/java/org/collectd/api/CollectdWriteInterface.java
@@
-21,6
+21,12
@@
package org.collectd.api;
package org.collectd.api;
+/**
+ * Interface for objects implementing a write function.
+ *
+ * @author Florian Forster <octo at verplant.org>
+ * @see Collectd#registerWrite
+ */
public interface CollectdWriteInterface
{
public int write (ValueList vl);
public interface CollectdWriteInterface
{
public int write (ValueList vl);