liblttd/liblttdutils.h

   1 /* liblttdutils header file
   2  *
   3  * Copyright 2010-
   4  *               Oumarou Dicko <oumarou.dicko@polymtl.ca>
   5  *               Michael Sills-Lavoie <michael.sills-lavoie@polymtl.ca>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  */
  18
  19 #ifndef _LIBLTTDUTILS_H
  20 #define _LIBLTTDUTILS_H
  21
  22 #include "liblttd.h"
  23
  24 /**
  25  * liblttdutils_new_callbacks - Is a utility function called to create a new
  26  * callbacks struct used by liblttd to write trace data to the disk.
  27  *
  28  * @trace_name: Directory name of the trace to write to. It will be created.
  29  * @append_mode: Append to a possibly existing trace.
  30  * @verbose_mode: Verbose mode.
  31  *
  32  * Returns the callbacks if the function succeeds else NULL.
  33  */
  34 struct liblttd_callbacks* liblttdutils_local_new_callbacks(char* trace_name,
  35         int append_mode, int verbose_mode);
  36
  37 #endif /*_LIBLTTDUTILS_H */
  38