src/common/spawn-viewer.hpp

   1 #ifndef LTTNG_SPAWN_VIEWER_H
   2 #define LTTNG_SPAWN_VIEWER_H
   3
   4 /*
   5  * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
   6  *
   7  * SPDX-License-Identifier: LGPL-2.1-only
   8  *
   9  */
  10
  11 #include <lttng/lttng-export.h>
  12
  13 #include <stdbool.h>
  14
  15 /*
  16  * Read the trace by `exec()ing` the provided viewer program if any. If
  17  * `opt_viewer` is NULL, try to read the trace with the default trace reader.
  18  * On success, this function doesn't return.
  19  * Returns -1 if the `opt_viewer` string or the default trace viewer can't be
  20  * `exec()`.
  21  *
  22  * This symbol was mistakenly made public before the 2.12 release. It can't
  23  * be removed (but it can be stubbed-out if necessary).
  24  */
  25 extern "C" LTTNG_EXPORT int
  26 spawn_viewer(const char *trace_path, char *opt_viewer, bool opt_live_mode);
  27
  28 #endif /* ifndef LTTNG_SPAWN_VIEWER_H */