/usr/include/samp.h is in liblognorm-dev 1.0.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | /**
* @file samples.h
* @brief Object to process log samples.
* @author Rainer Gerhards
*
* This object handles log samples, and in actual log sample files.
* It co-operates with the ptree object to build the actual parser tree.
*//*
*
* liblognorm - a fast samples-based log normalization library
* Copyright 2010 by Rainer Gerhards and Adiscon GmbH.
*
* This file is part of liblognorm.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* A copy of the LGPL v2.1 can be found in the file "COPYING" in this distribution.
*/
#ifndef LIBLOGNORM_SAMPLES_H_INCLUDED
#define LIBLOGNORM_SAMPLES_H_INCLUDED
#include <stdio.h> /* we need es_size_t */
#include <libestr.h>
/**
* Object that represents a sample repository (file).
*
* Doing this via an objects helps with abstraction and future
* changes inside the module (which are anticipated).
*/
struct ln_sampRepos {
FILE *fp;
};
/**
* A single log sample.
*/
struct ln_samp {
es_str_t *msg;
};
/**
* Open a Sample Repository.
*
* @param[in] ctx current library context
* @param[in] name file name
* @return repository object or NULL if failure
*/
struct ln_sampRepos *
ln_sampOpen(ln_ctx ctx, const char *name);
/**
* Close sample file.
*
* @param[in] ctx current library context
* @param[in] fd file descriptor of open sample file
*/
void
ln_sampClose(ln_ctx ctx, struct ln_sampRepos *repo);
/**
* Reads a sample stored in buffer buf and creates a new ln_samp object
* out of it.
*
* @note
* It is the caller's responsibility to delete the newly
* created ln_samp object if it is no longer needed.
*
* @param[ctx] ctx current library context
* @param[buf] cstr buffer containing the string contents of the sample
* @param[lenBuf] length of the sample contained within buf
* @return Newly create object or NULL if an error occured.
*/
struct ln_samp *
ln_processSamp(ln_ctx ctx, const char *buf, es_size_t lenBuf);
/**
* Read a sample from repository (sequentially).
*
* Reads a sample starting with the current file position and
* creates a new ln_samp object out of it.
*
* @note
* It is the caller's responsibility to delete the newly
* created ln_samp object if it is no longer needed.
*
* @param[in] ctx current library context
* @param[in] repo repository descriptor
* @param[out] isEof must be set to 0 on entry and is switched to 1 if EOF occured.
* @return Newly create object or NULL if an error or EOF occured.
*/
struct ln_samp *
ln_sampRead(ln_ctx ctx, struct ln_sampRepos *repo, int *isEof);
/**
* Free ln_samp object.
*/
void
ln_sampFree(ln_ctx ctx, struct ln_samp *samp);
#endif /* #ifndef LIBLOGNORM_SAMPLES_H_INCLUDED */
|