From 50ad4244902f4a54207862e0fe289775b2ea22fd Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Thu, 28 Jul 2016 17:27:57 -0400 Subject: [PATCH] Change "handler" terminology to the more specific listener MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- formats/ctf/ir/trace.c | 30 ++++++++++++---------- include/babeltrace/ctf-ir/trace-internal.h | 2 +- include/babeltrace/ctf-ir/trace.h | 25 +++++++++--------- 3 files changed, 30 insertions(+), 27 deletions(-) diff --git a/formats/ctf/ir/trace.c b/formats/ctf/ir/trace.c index 2cbfdb4e..2b3fb0e6 100644 --- a/formats/ctf/ir/trace.c +++ b/formats/ctf/ir/trace.c @@ -48,8 +48,8 @@ #define DEFAULT_IDENTIFIER_SIZE 128 #define DEFAULT_METADATA_STRING_SIZE 4096 -struct notification_handler { - bt_ctf_notification_cb func; +struct listener_wrapper { + bt_ctf_listener_cb listener; void *data; }; @@ -1099,31 +1099,35 @@ end: return ret; } -int bt_ctf_trace_add_notification_handler_cb(struct bt_ctf_trace *trace, - bt_ctf_notification_cb handler, void *handler_data) +int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace, + bt_ctf_listener_cb listener, void *listener_data) { int ret = 0; - struct notification_handler *handler_wrapper = - g_new0(struct notification_handler, 1); + struct listener_wrapper *listener_wrapper = + g_new0(struct listener_wrapper, 1); - if (!trace || !handler || !handler_wrapper) { + if (!trace || !listener || !listener_wrapper) { ret = -1; goto error; } - handler_wrapper->func = handler; - handler_wrapper->data = handler_data; + listener_wrapper->listener = listener; + listener_wrapper->data = listener_data; - /* Emit notifications describing the current schema. */ - ret = bt_ctf_trace_visit(trace, ir_visitor, handler_wrapper); + /* Visit the current schema. */ + ret = bt_ctf_trace_visit(trace, ir_visitor, listener_wrapper); if (ret) { goto error; } - g_ptr_array_add(trace->notification_handlers, handler_wrapper); + /* + * Add listener to the array of callbacks which will be invoked on + * schema changes. + */ + g_ptr_array_add(trace->listeners, listener_wrapper); return ret; error: - g_free(handler_wrapper); + g_free(listener_wrapper); return ret; } diff --git a/include/babeltrace/ctf-ir/trace-internal.h b/include/babeltrace/ctf-ir/trace-internal.h index c631b97d..2ea71097 100644 --- a/include/babeltrace/ctf-ir/trace-internal.h +++ b/include/babeltrace/ctf-ir/trace-internal.h @@ -65,7 +65,7 @@ struct bt_ctf_trace { * trace is _always_ frozen. */ int valid; - GPtrArray *notification_handlers; /* Array of notification_handler */ + GPtrArray *listeners; /* Array of struct listener_wrapper */ }; struct metadata_context { diff --git a/include/babeltrace/ctf-ir/trace.h b/include/babeltrace/ctf-ir/trace.h index 39574f3a..fae7832b 100644 --- a/include/babeltrace/ctf-ir/trace.h +++ b/include/babeltrace/ctf-ir/trace.h @@ -46,16 +46,15 @@ struct bt_ctf_stream_class; struct bt_ctf_clock; /** - * Notification handling function type. + * Trace modification handling function type. * - * A reference must be taken on the notification if the handler has to - * keep ownership of the notification beyond the invocation of the callback. + * Callback invoked whenever an element is added to a trace's hierachy. * - * @param notification Notification to handle + * @param element New element * @param data Handler private data */ -typedef void (*bt_ctf_notification_cb)( - struct bt_notification *notification, void *data); +typedef void (*bt_ctf_listener_cb)( + struct bt_ctf_ir_element *element, void *data); /* * bt_ctf_trace_create: create a trace instance. @@ -368,23 +367,23 @@ extern int bt_ctf_trace_visit(struct bt_ctf_trace *trace, bt_ctf_ir_visitor visitor, void *data); /* - * bt_ctf_trace_add_notification_handler_cb: set a notification callback + * bt_ctf_trace_add_listener: add a trace modification listener * which will be invoked whenever a trace's schema is modified. * - * Register a notification handler to a trace. + * Register a modification listener to a trace. * * @param trace Trace instance. - * @param handler Notification handler to invoke on trace xmodification. - * @param handler_data Private data passed to the notification handler. + * @param listener Callback to invoke on trace modification. + * @param listener_data Private data passed to the listener. * * Returns 0 on success, a negative value on error. * - * Note: the notification handler will be used to serialize the trace's current + * Note: the listener will be used to serialize the trace's current * state on registration. It will then be invoked on any change occuring within * the trace's hierarchy. */ -extern int bt_ctf_trace_add_notification_handler_cb(struct bt_ctf_trace *trace, - bt_ctf_notification_cb handler, void *handler_data); +extern int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace, + bt_ctf_listener_cb listener, void *listener_data); #ifdef __cplusplus } -- 2.34.1