summaryrefslogtreecommitdiff
path: root/docs/design/draft-tracing.txt
diff options
context:
space:
mode:
authorStefan Sauer <ensonic@users.sf.net>2013-10-27 12:45:54 +0100
committerStefan Sauer <ensonic@users.sf.net>2015-10-05 20:59:39 +0200
commit68b1473846f34830c7bdb025afe397da9ea6de8f (patch)
treedf46f8e7c0913d0428db3fb090f702b9dffe187d /docs/design/draft-tracing.txt
parent6e9f018dc47def5954c1e3e712c38900671aa121 (diff)
tracer: add the hook-id to the invoke signature
Tracers that subscribe to multiple hooks can know what hook was used.
Diffstat (limited to 'docs/design/draft-tracing.txt')
-rw-r--r--docs/design/draft-tracing.txt6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/design/draft-tracing.txt b/docs/design/draft-tracing.txt
index 605ef346a3..ac4ef20a09 100644
--- a/docs/design/draft-tracing.txt
+++ b/docs/design/draft-tracing.txt
@@ -95,18 +95,18 @@ Plugin api
TracerPlugins are plugin features. They have a simple api:
-GstTracerHookMask init(gchar *params);
+'instance creation'
Plugins can attach handlers to one or more hooks. They use a HookMask to tell
which events they are interested in. The params are the extra detail from the
environment var.
-void invoke(GstStructure *s);
+void invoke(GstTracerHookId id, GstStructure *s);
Hooks marshall the parameters given to a trace hook into a GstStructure and also
add some extra into such as a timestamp. The hooks will receive this structure.
Hooks will be called from misc threads. The trace plugins should only consume
(=read) the provided data. Most trace plugins will log data to a trace channel.
-void done(void);
+'instance destruction'
Plugins can output results and release data. This would ideally be done at the
end of the applications, but gst_deinit() is not mandatory. gst_tracelib was
using a gcc_destructor