weston-log: 'new_subscriber' is actually 'new_subscription'

The callback is executed when the subscription is created, so it doesn't
really have a proper name.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
dev
Marius Vlad 5 years ago
parent 413cda58d6
commit 0c7beb0b67
  1. 2
      include/libweston/weston-log.h
  2. 2
      libweston/weston-log-internal.h
  3. 24
      libweston/weston-log.c

@ -66,7 +66,7 @@ struct weston_log_scope *
weston_compositor_add_log_scope(struct weston_log_context *compositor, weston_compositor_add_log_scope(struct weston_log_context *compositor,
const char *name, const char *name,
const char *description, const char *description,
weston_log_scope_cb new_subscriber, weston_log_scope_cb new_subscription,
void *user_data); void *user_data);
void void

@ -88,7 +88,7 @@ struct weston_log_scope *
weston_log_get_scope(struct weston_log_context *log_ctx, const char *name); weston_log_get_scope(struct weston_log_context *log_ctx, const char *name);
void void
weston_log_run_cb_new_subscriber(struct weston_log_subscription *sub); weston_log_run_cb_new_subscription(struct weston_log_subscription *sub);
void void
weston_debug_protocol_advertise_scopes(struct weston_log_context *log_ctx, weston_debug_protocol_advertise_scopes(struct weston_log_context *log_ctx,

@ -81,7 +81,7 @@ struct weston_log_context {
struct weston_log_scope { struct weston_log_scope {
char *name; char *name;
char *desc; char *desc;
weston_log_scope_cb new_subscriber; weston_log_scope_cb new_subscription;
void *user_data; void *user_data;
struct wl_list compositor_link; struct wl_list compositor_link;
struct wl_list subscription_list; /**< weston_log_subscription::source_link */ struct wl_list subscription_list; /**< weston_log_subscription::source_link */
@ -246,7 +246,7 @@ weston_log_subscription_create(struct weston_log_subscriber *owner,
wl_list_insert(&sub->owner->subscription_list, &sub->owner_link); wl_list_insert(&sub->owner->subscription_list, &sub->owner_link);
weston_log_subscription_add(scope, sub); weston_log_subscription_add(scope, sub);
weston_log_run_cb_new_subscriber(sub); weston_log_run_cb_new_subscription(sub);
} }
/** Destroys the subscription /** Destroys the subscription
@ -349,16 +349,16 @@ weston_log_get_scope(struct weston_log_context *log_ctx, const char *name)
return NULL; return NULL;
} }
/** Wrapper to invoke the weston_log_scope_cb. Allows to call the cb new_subscriber of /** Wrapper to invoke the weston_log_scope_cb. Allows to call the cb
* a log scope. * new_subscription of a log scope.
* *
* @ingroup internal-log * @ingroup internal-log
*/ */
void void
weston_log_run_cb_new_subscriber(struct weston_log_subscription *sub) weston_log_run_cb_new_subscription(struct weston_log_subscription *sub)
{ {
if (sub->source->new_subscriber) if (sub->source->new_subscription)
sub->source->new_subscriber(sub, sub->source->user_data); sub->source->new_subscription(sub, sub->source->user_data);
} }
/** Advertise the log scope name and the log scope description /** Advertise the log scope name and the log scope description
@ -516,7 +516,7 @@ weston_compositor_is_debug_protocol_enabled(struct weston_compositor *wc)
* @param log_ctx The weston_log_context where to add. * @param log_ctx The weston_log_context where to add.
* @param name The debug stream/scope name; must not be NULL. * @param name The debug stream/scope name; must not be NULL.
* @param description The log scope description for humans; must not be NULL. * @param description The log scope description for humans; must not be NULL.
* @param new_subscriber Optional callback when a client subscribes to this * @param new_subscription Optional callback when a client subscribes to this
* scope. * scope.
* @param user_data Optional user data pointer for the callback. * @param user_data Optional user data pointer for the callback.
* @returns A valid pointer on success, NULL on failure. * @returns A valid pointer on success, NULL on failure.
@ -533,13 +533,13 @@ weston_compositor_is_debug_protocol_enabled(struct weston_compositor *wc)
* protocol, the description is printed when a client asks for a list of * protocol, the description is printed when a client asks for a list of
* supported log scopes. * supported log scopes.
* *
* \p new_subscriber, if not NULL, is called when a client subscribes to the log * \p new_subscription, if not NULL, is called when a client subscribes to the log
* scope creating a debug stream. This is for log scopes that need to print * scope creating a debug stream. This is for log scopes that need to print
* messages as a response to a client appearing, e.g. printing a list of * messages as a response to a client appearing, e.g. printing a list of
* windows on demand or a static preamble. The argument \p user_data is * windows on demand or a static preamble. The argument \p user_data is
* passed in to the callback and is otherwise unused. * passed in to the callback and is otherwise unused.
* *
* For one-shot debug streams, \c new_subscriber should finally call * For one-shot debug streams, \c new_subscription should finally call
* weston_log_subscription_complete() to close the stream and tell the client * weston_log_subscription_complete() to close the stream and tell the client
* the printing is complete. Otherwise the client expects more data to be * the printing is complete. Otherwise the client expects more data to be
* written. The complete callback in weston_log_subscriber should be installed * written. The complete callback in weston_log_subscriber should be installed
@ -560,7 +560,7 @@ WL_EXPORT struct weston_log_scope *
weston_compositor_add_log_scope(struct weston_log_context *log_ctx, weston_compositor_add_log_scope(struct weston_log_context *log_ctx,
const char *name, const char *name,
const char *description, const char *description,
weston_log_scope_cb new_subscriber, weston_log_scope_cb new_subscription,
void *user_data) void *user_data)
{ {
struct weston_log_scope *scope; struct weston_log_scope *scope;
@ -592,7 +592,7 @@ weston_compositor_add_log_scope(struct weston_log_context *log_ctx,
scope->name = strdup(name); scope->name = strdup(name);
scope->desc = strdup(description); scope->desc = strdup(description);
scope->new_subscriber = new_subscriber; scope->new_subscription = new_subscription;
scope->user_data = user_data; scope->user_data = user_data;
wl_list_init(&scope->subscription_list); wl_list_init(&scope->subscription_list);

Loading…
Cancel
Save