lib: rename "self comp. input port message iter." -> "message iterator"
[babeltrace.git] / src / plugins / ctf / fs-sink / fs-sink.h
1 #ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
2 #define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H
3
4 /*
5 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #include "common/macros.h"
27 #include <babeltrace2/babeltrace.h>
28 #include <stdbool.h>
29 #include <glib.h>
30
31 struct fs_sink_comp {
32 bt_logging_level log_level;
33 bt_self_component *self_comp;
34
35 /* Owned by this */
36 bt_message_iterator *upstream_iter;
37
38 /* Base output directory path */
39 GString *output_dir_path;
40
41 /*
42 * True if the component assumes that it will only write a
43 * single CTF trace (which can contain one or more data
44 * streams). This makes the component write the stream files
45 * directly in the output directory (`output_dir_path` above).
46 */
47 bool assume_single_trace;
48
49 /* True to completely ignore discarded events messages */
50 bool ignore_discarded_events;
51
52 /* True to completely ignore discarded packets messages */
53 bool ignore_discarded_packets;
54
55 /*
56 * True to make the component quiet (nothing printed to the
57 * standard output).
58 */
59 bool quiet;
60
61 /*
62 * Hash table of `const bt_trace *` (weak) to
63 * `struct fs_sink_trace *` (owned by hash table).
64 */
65 GHashTable *traces;
66 };
67
68 BT_HIDDEN
69 bt_component_class_initialize_method_status ctf_fs_sink_init(
70 bt_self_component_sink *component,
71 bt_self_component_sink_configuration *config,
72 const bt_value *params,
73 void *init_method_data);
74
75 BT_HIDDEN
76 bt_component_class_sink_consume_method_status ctf_fs_sink_consume(
77 bt_self_component_sink *component);
78
79 BT_HIDDEN
80 bt_component_class_sink_graph_is_configured_method_status ctf_fs_sink_graph_is_configured(
81 bt_self_component_sink *component);
82
83 BT_HIDDEN
84 void ctf_fs_sink_finalize(bt_self_component_sink *component);
85
86 #endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_H */
This page took 0.030629 seconds and 4 git commands to generate.