1 /**
2 * collectd - bindings/java/org/collectd/api/CollectdReadInterface.java
3 * Copyright (C) 2009 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 */
27 package org.collectd.api;
29 /**
30 * Interface for objects implementing a read method.
31 *
32 * Objects implementing this interface can be registered with the daemon. Their
33 * read method is then called periodically to acquire and submit values.
34 *
35 * @author Florian Forster <octo at collectd.org>
36 * @see Collectd#registerRead
37 */
38 public interface CollectdReadInterface
39 {
40 /**
41 * Callback method for read plugins.
42 *
43 * This method is called once every few seconds (depends on the
44 * configuration of the daemon). It is supposed to gather values in
45 * some way and submit them to the daemon using
46 * {@link Collectd#dispatchValues}.
47 *
48 * @return zero when successful, non-zero when an error occurred.
49 * @see Collectd#dispatchValues
50 */
51 public int read ();
52 }