Merge branch 'rs/dedup-includes'
[git] / trace2 / tr2_dst.h
1 #ifndef TR2_DST_H
2 #define TR2_DST_H
3
4 struct strbuf;
5 #include "trace2/tr2_sysenv.h"
6
7 struct tr2_dst {
8         enum tr2_sysenv_variable sysenv_var;
9         int fd;
10         unsigned int initialized : 1;
11         unsigned int need_close : 1;
12 };
13
14 /*
15  * Disable TRACE2 on the destination.  In TRACE2 a destination (DST)
16  * wraps a file descriptor; it is associated with a TARGET which
17  * defines the formatting.
18  */
19 void tr2_dst_trace_disable(struct tr2_dst *dst);
20
21 /*
22  * Return the file descriptor for the DST.
23  * If 0, the dst is closed or disabled.
24  */
25 int tr2_dst_get_trace_fd(struct tr2_dst *dst);
26
27 /*
28  * Return true if the DST is opened for writing.
29  */
30 int tr2_dst_trace_want(struct tr2_dst *dst);
31
32 /*
33  * Write a single line/message to the trace file.
34  */
35 void tr2_dst_write_line(struct tr2_dst *dst, struct strbuf *buf_line);
36
37 #endif /* TR2_DST_H */