67f1898ba2411a08892fe84734a5f3ad35980d46
1 /*
2 * collectd/java - org/collectd/api/CollectdReadInterface.java
3 * Copyright (C) 2009 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at verplant.org>
20 */
22 package org.collectd.api;
24 /**
25 * Interface for objects implementing a read method.
26 *
27 * Objects implementing this interface can be registered with the daemon. Their
28 * read method is then called periodically to acquire and submit values.
29 *
30 * @author Florian Forster <octo at verplant.org>
31 * @see Collectd#registerRead
32 */
33 public interface CollectdReadInterface
34 {
35 /**
36 * Callback method for read plugins.
37 *
38 * This method is called once every few seconds (depends on the
39 * configuration of the daemon). It is supposed to gather values in
40 * some way and submit them to the daemon using
41 * {@link Collectd#dispatchValues}.
42 *
43 * @return zero when successful, non-zero when an error occurred.
44 * @see Collectd#dispatchValues
45 */
46 public int read ();
47 }