X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Futils_tail_match.h;fp=src%2Futils_tail_match.h;h=0000000000000000000000000000000000000000;hb=216c6246b73645ac093de15b87aedc9abc6ebc80;hp=0404de2f2b6cfb14fbef5b34357366843d99ebff;hpb=2578c91335381de7cf1da589f8993e775483319e;p=collectd.git diff --git a/src/utils_tail_match.h b/src/utils_tail_match.h deleted file mode 100644 index 0404de2f..00000000 --- a/src/utils_tail_match.h +++ /dev/null @@ -1,132 +0,0 @@ -/* - * collectd - src/utils_tail_match.h - * Copyright (C) 2007-2008 C-Ware, Inc. - * Copyright (C) 2008 Florian Forster - * - * Permission is hereby granted, free of charge, to any person obtaining a - * copy of this software and associated documentation files (the "Software"), - * to deal in the Software without restriction, including without limitation - * the rights to use, copy, modify, merge, publish, distribute, sublicense, - * and/or sell copies of the Software, and to permit persons to whom the - * Software is furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER - * DEALINGS IN THE SOFTWARE. - * - * Authors: - * Luke Heberling - * Florian Forster - * - * Description: - * `tail_match' uses `utils_tail' and `utils_match' to tail a file and try to - * match it using several regular expressions. Matches are then passed to - * user-provided callback functions or default handlers. This should keep all - * of the parsing logic out of the actual plugin, which only operate with - * regular expressions. - */ - -#include "utils_match.h" - -struct cu_tail_match_s; -typedef struct cu_tail_match_s cu_tail_match_t; - -/* - * NAME - * tail_match_create - * - * DESCRIPTION - * Allocates, initializes and returns a new `cu_tail_match_t' object. - * - * PARAMETERS - * `filename' The name to read data from. - * - * RETURN VALUE - * Returns NULL upon failure, non-NULL otherwise. - */ -cu_tail_match_t *tail_match_create (const char *filename); - -/* - * NAME - * tail_match_destroy - * - * DESCRIPTION - * Releases resources used by the `cu_tail_match_t' object. - * - * PARAMETERS - * The object to destroy. - */ -void tail_match_destroy (cu_tail_match_t *obj); - -/* - * NAME - * tail_match_add_match - * - * DESCRIPTION - * Adds a match, in form of a `cu_match_t' object, to the object. - * After data has been read from the logfile (using utils_tail) the callback - * function `submit_match' is called with the match object and the user - * supplied data. - * Please note that his function is called regardless whether this match - * matched any lines recently or not. - * When `tail_match_destroy' is called the `user_data' pointer is freed using - * the `free_user_data' callback - if it is not NULL. - * When using this interface the `tail_match' module doesn't dispatch any values - * itself - all that has to happen in either the match-callbacks or the - * submit_match callback. - * - * RETURN VALUE - * Zero upon success, non-zero otherwise. - */ -int tail_match_add_match (cu_tail_match_t *obj, cu_match_t *match, - int (*submit_match) (cu_match_t *match, void *user_data), - void *user_data, - void (*free_user_data) (void *user_data)); - -/* - * NAME - * tail_match_add_match_simple - * - * DESCRIPTION - * A simplified version of `tail_match_add_match'. The regular expressen `regex' - * must match a number, which is then dispatched according to `ds_type'. See - * the `match_create_simple' function in utils_match.h for a description how - * this flag effects calculation of a new value. - * The values gathered are dispatched by the tail_match module in this case. The - * passed `plugin', `plugin_instance', `type', and `type_instance' are - * directly used when submitting these values. - * With excluderegex it is possible to exlude lines from the match. - * - * RETURN VALUE - * Zero upon success, non-zero otherwise. - */ -int tail_match_add_match_simple (cu_tail_match_t *obj, - const char *regex, const char *excluderegex, int ds_type, - const char *plugin, const char *plugin_instance, - const char *type, const char *type_instance, const cdtime_t interval); - -/* - * NAME - * tail_match_read - * - * DESCRIPTION - * This function should be called periodically by plugins. It reads new lines - * from the logfile using `utils_tail' and tries to match them using all - * added `utils_match' objects. - * After all lines have been read and processed, the submit_match callback is - * called or, in case of tail_match_add_match_simple, the data is dispatched to - * the daemon directly. - * - * RETURN VALUE - * Zero on success, nonzero on failure. -*/ -int tail_match_read (cu_tail_match_t *obj); - -/* vim: set sw=2 sts=2 ts=8 : */